typescript-sdk/examples/tools/client.ts
Felix Weinberger 1823aae891
Implement MCP 2026-07-28 (#2286)
Co-authored-by: Matt <77928207+mattzcarey@users.noreply.github.com>
Co-authored-by: Konstantin Konstantinov <KKonstantinov@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2026-06-26 14:01:10 +01:00

49 lines
2.2 KiB
TypeScript

/**
* Drives the tools example: list, inspect schemas + annotations, call,
* assert structured output, assert an unknown tool errors.
*/
import { check, parseExampleArgs, siblingPath } from '@mcp-examples/shared';
import { Client, StreamableHTTPClientTransport } from '@modelcontextprotocol/client';
import { StdioClientTransport } from '@modelcontextprotocol/client/stdio';
const { transport, url, era } = parseExampleArgs();
const client = new Client(
{ name: 'tools-example-client', version: '1.0.0' },
{ versionNegotiation: { mode: era === 'modern' ? 'auto' : 'legacy' } }
);
await (transport === 'stdio'
? client.connect(new StdioClientTransport({ command: 'npx', args: ['-y', 'tsx', siblingPath(import.meta.url, 'server.ts')] }))
: client.connect(new StreamableHTTPClientTransport(new URL(url))));
const list = await client.listTools();
const names = new Set(list.tools.map(t => t.name));
check.ok(names.has('calc') && names.has('echo'), 'tools/list should contain calc and echo');
const calc = list.tools.find(t => t.name === 'calc')!;
check.equal(calc.annotations?.readOnlyHint, true);
const required = (calc.inputSchema as { required?: string[] }).required ?? [];
check.ok(required.includes('op') && required.includes('a') && required.includes('b'));
check.ok(calc.outputSchema, 'calc should publish an outputSchema');
check.equal(calc.icons?.[0]?.src, 'https://example.test/calc.svg', 'calc should advertise its icons over the wire');
const result = await client.callTool({ name: 'calc', arguments: { op: 'add', a: 2, b: 3 } });
check.equal((result.structuredContent as { result?: number } | undefined)?.result, 5);
check.equal((result.structuredContent as { op?: string } | undefined)?.op, 'add');
const echo = await client.callTool({ name: 'echo', arguments: { text: 'hi' } });
check.equal(echo.content?.[0]?.type === 'text' ? echo.content[0].text : '', 'hi');
check.equal(echo.structuredContent, undefined);
// An unknown tool should be a tool error (isError) or a wire error — either is acceptable.
let unknownFailed = false;
try {
const r = await client.callTool({ name: 'nope', arguments: {} });
unknownFailed = !!r.isError;
} catch {
unknownFailed = true;
}
check.ok(unknownFailed, 'calling an unknown tool should fail');
await client.close();