-
Notifications
You must be signed in to change notification settings - Fork 222
docs: add TypeScript MCP elicitation examples #790
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
Open
gautamsirdeshmukh
wants to merge
1
commit into
strands-agents:main
Choose a base branch
from
gautamsirdeshmukh:docs/mcp-elicitation-typescript
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
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
75 changes: 75 additions & 0 deletions
75
src/content/docs/user-guide/concepts/tools/mcp-tools-elicitation.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,75 @@ | ||
| // @ts-nocheck | ||
|
|
||
| // --8<-- [start:elicitation_server] | ||
| // server.ts | ||
| import { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js' | ||
| import { StdioServerTransport } from '@modelcontextprotocol/sdk/server/stdio.js' | ||
| import { z } from 'zod' | ||
|
|
||
| const server = new McpServer({ | ||
| name: 'File Tools', | ||
| version: '1.0.0', | ||
| }) | ||
|
|
||
| server.tool( | ||
| 'delete_files', | ||
| 'Delete the given files after getting user approval.', | ||
| { | ||
| paths: z.array(z.string()), | ||
| }, | ||
| async ({ paths }) => { | ||
| const result = await server.server.elicitInput({ | ||
| message: `Do you want to delete ${paths.join(', ')}?`, | ||
| requestedSchema: { | ||
| type: 'object', | ||
| properties: { | ||
| username: { type: 'string', description: 'Who is approving?' }, | ||
| }, | ||
| required: ['username'], | ||
| }, | ||
| }) | ||
|
|
||
| if (result.action !== 'accept') { | ||
| return { content: [{ type: 'text', text: `User ${result.action}ed deletion` }] } | ||
| } | ||
|
|
||
| // Perform deletion... | ||
| const username = (result.content as { username: string }).username | ||
| return { content: [{ type: 'text', text: `User ${username} approved deletion` }] } | ||
| } | ||
| ) | ||
|
|
||
| await server.connect(new StdioServerTransport()) | ||
| // --8<-- [end:elicitation_server] | ||
|
|
||
| // --8<-- [start:elicitation_client] | ||
| // client.ts | ||
| import { Agent, McpClient } from '@strands-agents/sdk' | ||
| import type { ElicitationCallback } from '@strands-agents/sdk' | ||
| import { StdioClientTransport } from '@modelcontextprotocol/sdk/client/stdio.js' | ||
|
|
||
| const elicitationCallback: ElicitationCallback = async (_context, params) => { | ||
| console.log(`ELICITATION: ${params.message}`) | ||
| // Get user confirmation... | ||
| return { | ||
| action: 'accept', | ||
| content: { username: 'myname' }, | ||
| } | ||
| } | ||
|
|
||
| const elicitClient = new McpClient({ | ||
| transport: new StdioClientTransport({ | ||
| command: 'npx', | ||
| args: ['tsx', '/path/to/server.ts'], | ||
| }), | ||
| elicitationCallback, | ||
| }) | ||
|
|
||
| const agentElicit = new Agent({ | ||
| tools: [elicitClient], | ||
| }) | ||
|
|
||
| await agentElicit.invoke("Delete 'a/b/c.txt' and share the name of the approver") | ||
|
|
||
| await elicitClient.disconnect() | ||
| // --8<-- [end:elicitation_client] | ||
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Issue: The
elicitation_clientsnippet usesMcpClient,StdioClientTransport, andAgentwithout importing them. Unlikemcp-tools.tswhere these are imported at the file top and shared across all snippets, this is a separate file so the client snippet is missing its imports. The Python counterpart includes all necessary imports (from strands import Agent,from strands.tools.mcp import MCPClient, etc.), so readers copying the TypeScript client code won't have the full picture.Suggestion: Add the missing imports inside the
elicitation_clientsnippet:There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Confirmed resolved — all three imports (
Agent, McpClient,ElicitationCallback,StdioClientTransport) are present in theelicitation_clientsnippet.