docs(simulator): updated tool_simulator docs#752
docs(simulator): updated tool_simulator docs#752poshinchen merged 1 commit intostrands-agents:mainfrom
Conversation
Documentation Preview ReadyYour documentation preview has been successfully deployed! Preview URL: https://d3ehv1nix5p99z.cloudfront.net/pr-cms-752/docs/user-guide/quickstart/overview/ Updated at: 2026-04-22T18:36:04.490Z |
|
Assessment: Comment Good addition to the evals SDK documentation. The ToolSimulator docs are well-structured, follow the established patterns from the user_simulation.mdx page, and provide clear code examples with progressive complexity (basic → shared state → experiment integration → troubleshooting). Review Details
Nice comprehensive documentation with the shared state and troubleshooting sections — those will save users a lot of debugging time. |
91968b7 to
ffb1d0d
Compare
|
There are a couple of useful tips for tool simulator that we're about to share in an upcoming post:
Might worth adding them here as well? |
ffb1d0d to
f74400c
Compare
Documentation Preview FailedThe documentation deployment encountered an error. Please check the deployment logs for more details. |
Documentation Preview FailedThe documentation deployment encountered an error. Please check the deployment logs for more details. |
f74400c to
ff204ab
Compare
|
|
||
| ### Registering a Tool | ||
|
|
||
| Define a function with type hints and a docstring, then decorate it with `@tool_simulator.tool()`. Provide an `output_schema` to control the response structure, and the tool can be retrived and passed to a Strands agent. |
There was a problem hiding this comment.
Issue: Typo — "retrived" should be "retrieved".
Suggestion: ...and the tool can be retrieved and passed to a Strands agent.
| from enum import Enum | ||
| from pydantic import BaseModel, Field | ||
|
|
||
| tool_simulator = ToolSimulator() |
There was a problem hiding this comment.
Issue: This code block reads as a self-contained example (it starts with a fresh tool_simulator = ToolSimulator()), but is missing imports for ToolSimulator and Agent (used on lines 100 and 137 respectively). The other self-contained blocks on this page (e.g., "Registering a Tool" at line 51, "Integration with Experiments" at line 158) all include full imports.
Suggestion: Add the missing imports at the top of the block:
from strands import Agent
from strands_evals.simulation.tool_simulator import ToolSimulator
from enum import Enum
from pydantic import BaseModel, Field|
Assessment: Comment The docs look good — previous review feedback (the "deterministic" wording, the missing pydantic import, and ybdarrenwang's two suggestions) has all been addressed. Two small remaining items flagged inline. Review Details
|
Description
Added toolSimulator related docs
Related Issues
N/A
Type of Change
Checklist
npm run devBy submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.