docs: add TypeScript vended tools documentation#685
Conversation
This comment was marked as outdated.
This comment was marked as outdated.
Documentation Preview ReadyYour documentation preview has been successfully deployed! Preview URL: https://d3ehv1nix5p99z.cloudfront.net/pr-cms-685/docs/user-guide/quickstart/overview/ Updated at: 2026-03-20T19:51:34.869Z |
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
Add comprehensive documentation for TypeScript SDK vended tools: - bash: Shell command execution with persistent sessions - fileEditor: File viewing, creation, and editing - httpRequest: HTTP requests to external APIs - notebook: Persistent text notebooks Includes: - Security warnings and responsibility model documentation - Code examples with TypeScript snippets - Links to SDK READMEs for detailed API reference - References to Interrupts/Hooks for consent workflows - Navigation update to include page under Tools section
zastrowm
force-pushed
the
agent-tasks/671
branch
from
cd8cbef to
3768df8
Compare
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
| --8<-- "user-guide/concepts/tools/vended-tools.ts:combined_tools_example" | ||
| ``` | ||
|
|
||
| ## Differences from Community Tools |
There was a problem hiding this comment.
I probably wouldn't mention the difference here. I like calling out interrupts for handling permissions, but we don't need the comparison here.
| | Consent Workflow | Use Interrupts/Hooks | `BYPASS_TOOL_CONSENT` env var | | ||
| | Platform | Node.js (some browser support) | Python 3.10+ | | ||
|
|
||
| ## Versioning & Maintenance |
There was a problem hiding this comment.
For vended tools, what can we be expected to break in a patch or minor version bump? Tool name? Description? Spec?
Probably don't need to figure it out now, but adding a "version" to tools within the SDK might be nice so people who want a consistent tool spec can pin the tool version, or you can just choose latest for the most updated configuration.
2 participants
Description
Adds a new "Vended Tools" documentation page for the TypeScript SDK covering the four built-in tools shipped with
@strands-agents/sdk:bash,fileEditor,httpRequest, andnotebook.The page covers:
Related Issues
Closes #671
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.