generated from amazon-archives/__template_Apache-2.0
-
Notifications
You must be signed in to change notification settings - Fork 195
docs: add TypeScript vended tools documentation #685
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
+315
−0
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
37 changes: 37 additions & 0 deletions
37
src/content/docs/user-guide/concepts/tools/vended-tools-imports.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| // @ts-nocheck | ||
| // This file contains import snippets used in documentation examples. | ||
| // Each snippet is a standalone import block for a specific tool. | ||
| // @ts-nocheck is used because imports are intentionally repeated across snippets | ||
| // for documentation clarity — each snippet shows the complete imports needed. | ||
|
|
||
| // --8<-- [start:bash_import] | ||
| import { Agent } from '@strands-agents/sdk' | ||
| import { bash } from '@strands-agents/sdk/vended-tools/bash' | ||
| // --8<-- [end:bash_import] | ||
|
|
||
| // --8<-- [start:file_editor_import] | ||
| import { Agent } from '@strands-agents/sdk' | ||
| import { fileEditor } from '@strands-agents/sdk/vended-tools/file-editor' | ||
| // --8<-- [end:file_editor_import] | ||
|
|
||
| // --8<-- [start:http_request_import] | ||
| import { Agent } from '@strands-agents/sdk' | ||
| import { httpRequest } from '@strands-agents/sdk/vended-tools/http-request' | ||
| // --8<-- [end:http_request_import] | ||
|
|
||
| // --8<-- [start:notebook_import] | ||
| import { Agent } from '@strands-agents/sdk' | ||
| import { notebook } from '@strands-agents/sdk/vended-tools/notebook' | ||
| // --8<-- [end:notebook_import] | ||
|
|
||
| // --8<-- [start:notebook_persistence_import] | ||
| import { Agent, SessionManager, FileStorage } from '@strands-agents/sdk' | ||
| import { notebook } from '@strands-agents/sdk/vended-tools/notebook' | ||
| // --8<-- [end:notebook_persistence_import] | ||
|
|
||
| // --8<-- [start:combined_import] | ||
| import { Agent } from '@strands-agents/sdk' | ||
| import { bash } from '@strands-agents/sdk/vended-tools/bash' | ||
| import { fileEditor } from '@strands-agents/sdk/vended-tools/file-editor' | ||
| import { notebook } from '@strands-agents/sdk/vended-tools/notebook' | ||
| // --8<-- [end:combined_import] |
144 changes: 144 additions & 0 deletions
144
src/content/docs/user-guide/concepts/tools/vended-tools.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,144 @@ | ||
| --- | ||
| title: Vended Tools | ||
| description: "Pre-built tools included in the TypeScript SDK for common agent tasks like file operations, shell commands, HTTP requests, and persistent notes." | ||
| sidebar: | ||
| label: "Vended Tools" | ||
| languages: [typescript] | ||
| --- | ||
|
|
||
| Vended tools are pre-built tools included directly in the Strands SDK for common agent tasks like file operations, shell commands, HTTP requests, and persistent notes. | ||
|
|
||
| They ship as part of the SDK package and are updated alongside it — see [Versioning & Maintenance](#versioning--maintenance) for details on how changes are communicated and what level of backwards compatibility they maintain. | ||
|
|
||
| ## Quick Start | ||
|
|
||
| Each tool is imported from its own subpath under `@strands-agents/sdk/vended-tools` — no additional packages required: | ||
|
|
||
| ```typescript | ||
| --8<-- "user-guide/concepts/tools/vended-tools.ts:basic_import" | ||
|
|
||
| --8<-- "user-guide/concepts/tools/vended-tools.ts:agent_with_vended_tools" | ||
| ``` | ||
|
|
||
| ## Available Tools | ||
|
|
||
| | Tool | Description | Supported in | | ||
| |------|-------------|--------------| | ||
| | [File Editor](#file-editor) | View, create, and edit files | Node.js | | ||
| | [HTTP Request](#http-request) | Make HTTP requests to external APIs | Node.js 20+, browsers | | ||
| | [Notebook](#notebook) | Manage persistent text notebooks | Node.js, browsers | | ||
| | [Bash](#bash) | Execute shell commands with persistent sessions | Node.js (Unix/Linux/macOS) | | ||
|
|
||
| ### File Editor | ||
|
|
||
| Gives your agent the ability to read and modify files on disk — useful for coding agents, config management, or any workflow where the agent needs to inspect output and make targeted edits. | ||
|
|
||
| _Supported in: Node.js only._ | ||
|
|
||
| :::caution[Security Warning] | ||
| This tool reads and writes files with the full permissions of the Node.js process. Only use with trusted input and consider running in a sandboxed environment for production. | ||
| ::: | ||
|
|
||
| **Example:** | ||
| ```typescript | ||
| --8<-- "user-guide/concepts/tools/vended-tools-imports.ts:file_editor_import" | ||
|
|
||
| --8<-- "user-guide/concepts/tools/vended-tools.ts:file_editor_example" | ||
| ``` | ||
|
|
||
| 📖 [Full API Reference](https://github.com/strands-agents/sdk-typescript/blob/main/src/vended-tools/file-editor/README.md) | ||
|
|
||
| --- | ||
|
|
||
| ### HTTP Request | ||
|
|
||
| Lets your agent call external APIs and fetch web content. Supports all HTTP methods, custom headers, and request bodies. Default timeout is 30 seconds. | ||
|
|
||
| _Supported in: Node.js 20+, modern browsers._ | ||
|
|
||
| **Example:** | ||
| ```typescript | ||
| --8<-- "user-guide/concepts/tools/vended-tools-imports.ts:http_request_import" | ||
|
|
||
| --8<-- "user-guide/concepts/tools/vended-tools.ts:http_request_example" | ||
| ``` | ||
|
|
||
| 📖 [Full API Reference](https://github.com/strands-agents/sdk-typescript/blob/main/src/vended-tools/http-request/README.md) | ||
|
|
||
| --- | ||
|
|
||
| ### Notebook | ||
|
|
||
| A scratchpad the agent can read and write across invocations. The most effective use is giving the agent a notebook at the start of a task and instructing it to plan its work there — it can break the task into steps, check things off as it goes, and always have a clear picture of what's left. Notebook state is part of the agent's state, so it persists automatically with [Session Management](../agents/session-management.mdx). | ||
|
|
||
| _Supported in: Node.js, browsers._ | ||
|
|
||
| **Example - Task Management:** | ||
| ```typescript | ||
| --8<-- "user-guide/concepts/tools/vended-tools-imports.ts:notebook_import" | ||
|
|
||
| --8<-- "user-guide/concepts/tools/vended-tools.ts:notebook_example" | ||
| ``` | ||
|
|
||
| **Example - State Persistence:** | ||
| ```typescript | ||
| --8<-- "user-guide/concepts/tools/vended-tools-imports.ts:notebook_persistence_import" | ||
|
|
||
| --8<-- "user-guide/concepts/tools/vended-tools.ts:notebook_state_persistence" | ||
| ``` | ||
|
|
||
| 📖 [Full API Reference](https://github.com/strands-agents/sdk-typescript/blob/main/src/vended-tools/notebook/README.md) | ||
|
|
||
| --- | ||
|
|
||
| ### Bash | ||
|
|
||
| Lets your agent run shell commands and act on the output. Shell state — variables, working directory, exported functions — persists across invocations within the same session, so the agent can build up context incrementally. Sessions can be restarted to clear state. | ||
|
|
||
| _Supported in: Node.js on Unix/Linux/macOS. Not supported on Windows._ | ||
|
|
||
| :::caution[Security Warning] | ||
| This tool executes arbitrary bash commands without sandboxing. Commands run with the full permissions of the Node.js process. Only use with trusted input and consider running in sandboxed environments (containers, VMs) for production. | ||
| ::: | ||
|
|
||
| **Example - File Operations:** | ||
| ```typescript | ||
| --8<-- "user-guide/concepts/tools/vended-tools-imports.ts:bash_import" | ||
|
|
||
| --8<-- "user-guide/concepts/tools/vended-tools.ts:bash_example" | ||
| ``` | ||
|
|
||
| **Example - Session Persistence:** | ||
| ```typescript | ||
| --8<-- "user-guide/concepts/tools/vended-tools-imports.ts:bash_import" | ||
|
|
||
| --8<-- "user-guide/concepts/tools/vended-tools.ts:bash_session" | ||
| ``` | ||
|
|
||
| 📖 [Full API Reference](https://github.com/strands-agents/sdk-typescript/blob/main/src/vended-tools/bash/README.md) | ||
|
|
||
| --- | ||
|
|
||
| ## Using Multiple Tools Together | ||
|
|
||
| Combine vended tools to build powerful agent workflows: | ||
|
|
||
| ```typescript | ||
| --8<-- "user-guide/concepts/tools/vended-tools-imports.ts:combined_import" | ||
|
|
||
| --8<-- "user-guide/concepts/tools/vended-tools.ts:combined_tools_example" | ||
| ``` | ||
|
|
||
| ## Versioning & Maintenance | ||
zastrowm marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| Vended tools ship as part of the SDK and are updated alongside it. Report bugs and feature requests in the [TypeScript SDK GitHub repository](https://github.com/strands-agents/sdk-typescript/issues). | ||
|
|
||
| Tool names are stable and will not change. In minor versions, a tool's description, spec, or parameters may be updated to improve effectiveness — these changes are noted in SDK release notes. Pin your SDK version and test after upgrades if your workflows depend on specific tool behavior. | ||
|
|
||
| ## See also | ||
|
|
||
| - [Custom Tools](custom-tools.mdx) — Build your own tools | ||
| - [Community Tools Package](community-tools-package.mdx) — Python tools package with 30+ tools | ||
| - [Session Management](../agents/session-management.mdx) — Persist agent state including notebooks | ||
| - [Interrupts](../interrupts.mdx) — Implement approval workflows for sensitive operations | ||
| - [Hooks](../agents/hooks.mdx) — Intercept and customize tool execution | ||
133 changes: 133 additions & 0 deletions
133
src/content/docs/user-guide/concepts/tools/vended-tools.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,133 @@ | ||
| // --8<-- [start:basic_import] | ||
| import { Agent } from '@strands-agents/sdk' | ||
| import { bash } from '@strands-agents/sdk/vended-tools/bash' | ||
| import { fileEditor } from '@strands-agents/sdk/vended-tools/file-editor' | ||
| import { httpRequest } from '@strands-agents/sdk/vended-tools/http-request' | ||
| import { notebook } from '@strands-agents/sdk/vended-tools/notebook' | ||
| // --8<-- [end:basic_import] | ||
| import { SessionManager, FileStorage } from '@strands-agents/sdk' | ||
|
|
||
| // Agent with vended tools example | ||
| async function agentWithVendedToolsExample() { | ||
| // --8<-- [start:agent_with_vended_tools] | ||
| const agent = new Agent({ | ||
| tools: [bash, fileEditor, httpRequest, notebook], | ||
| }) | ||
| // --8<-- [end:agent_with_vended_tools] | ||
| } | ||
|
|
||
| // Bash tool example - file operations | ||
| async function bashFileOperationsExample() { | ||
| // --8<-- [start:bash_example] | ||
| const agent = new Agent({ | ||
| tools: [bash], | ||
| }) | ||
|
|
||
| // List files and create a new file | ||
| await agent.invoke('List all files in the current directory') | ||
| await agent.invoke('Create a new file called notes.txt with "Hello World"') | ||
| // --8<-- [end:bash_example] | ||
| } | ||
|
|
||
| // Bash tool example - session persistence | ||
| async function bashSessionPersistenceExample() { | ||
| // --8<-- [start:bash_session] | ||
| const agent = new Agent({ | ||
| tools: [bash], | ||
| }) | ||
|
|
||
| // Variables persist across invocations within the same session | ||
| await agent.invoke('Run: export MY_VAR="hello"') | ||
| await agent.invoke('Run: echo $MY_VAR') // Will show "hello" | ||
|
|
||
| // Restart session to clear state | ||
| await agent.invoke('Restart the bash session') | ||
| await agent.invoke('Run: echo $MY_VAR') // Variable will be empty | ||
| // --8<-- [end:bash_session] | ||
| } | ||
|
|
||
| // File editor example | ||
| async function fileEditorExample() { | ||
| // --8<-- [start:file_editor_example] | ||
| const agent = new Agent({ | ||
| tools: [fileEditor], | ||
| }) | ||
|
|
||
| // Create, view, and edit files | ||
| await agent.invoke('Create a file /tmp/config.json with {"debug": false}') | ||
| await agent.invoke('Replace "debug": false with "debug": true in /tmp/config.json') | ||
| await agent.invoke('View lines 1-10 of /tmp/config.json') | ||
| // --8<-- [end:file_editor_example] | ||
| } | ||
|
|
||
| // HTTP request example | ||
| async function httpRequestExample() { | ||
| // --8<-- [start:http_request_example] | ||
| const agent = new Agent({ | ||
| tools: [httpRequest], | ||
| }) | ||
|
|
||
| // Make API requests | ||
| await agent.invoke('Get data from https://api.example.com/users') | ||
| await agent.invoke('Post {"name": "John"} to https://api.example.com/users') | ||
| // --8<-- [end:http_request_example] | ||
| } | ||
|
|
||
| // Notebook example - task management | ||
| async function notebookTaskExample() { | ||
| // --8<-- [start:notebook_example] | ||
| const agent = new Agent({ | ||
| tools: [notebook], | ||
| systemPrompt: | ||
| 'Before starting any multi-step task, create a notebook with a checklist of steps. ' + | ||
| 'Check off each step as you complete it.', | ||
| }) | ||
|
|
||
| // The agent uses the notebook to plan and track its work | ||
| await agent.invoke('Write a project plan for building a personal budget tracker app') | ||
| // --8<-- [end:notebook_example] | ||
| } | ||
|
|
||
| // Notebook state persistence example | ||
| async function notebookStatePersistenceExample() { | ||
| // --8<-- [start:notebook_state_persistence] | ||
| const session = new SessionManager({ | ||
| sessionId: 'my-session', | ||
| storage: { snapshot: new FileStorage('./sessions') }, | ||
| }) | ||
|
|
||
| const agent = new Agent({ tools: [notebook], sessionManager: session }) | ||
|
|
||
| // Notebooks are automatically persisted as part of the session | ||
| await agent.invoke('Create a notebook called "ideas" with "# Project Ideas"') | ||
| await agent.invoke('Add "- Build a web scraper" to the ideas notebook') | ||
|
|
||
| // ... | ||
|
|
||
| // Later, a new agent with the same session restores notebooks automatically | ||
| const restoredAgent = new Agent({ tools: [notebook], sessionManager: session }) | ||
| await restoredAgent.invoke('Read the ideas notebook') | ||
| // --8<-- [end:notebook_state_persistence] | ||
| } | ||
|
|
||
| // Combined tools example - development workflow | ||
| async function combinedToolsExample() { | ||
| // --8<-- [start:combined_tools_example] | ||
| const agent = new Agent({ | ||
| tools: [bash, fileEditor, notebook], | ||
| systemPrompt: [ | ||
| 'You are a software development assistant.', | ||
| 'When given a feature to implement:', | ||
| '1. Use the notebook tool to create a plan with a checklist of steps', | ||
| '2. Work through each step, checking them off as you go', | ||
| '3. Use the bash tool to run tests and verify your changes', | ||
| ].join('\n'), | ||
| }) | ||
|
|
||
| // Agent plans the work, implements it, and tracks progress | ||
| await agent.invoke( | ||
| 'Add input validation to the createUser function in src/users.ts. ' + | ||
| 'It should reject empty names and invalid email formats.', | ||
| ) | ||
| // --8<-- [end:combined_tools_example] | ||
| } | ||
zastrowm marked this conversation as resolved.
Show resolved
Hide resolved
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.