入门指南
要安装依赖项,请执行以下操作:
bun install要生成OpenAPI规范,以及客户端SDK和MCP应用程序:
bun client:gen然后取消评论 mcpApp 导入和路由 src/index.ts:
import mcpApp from '../sdk/mcp.gen';
// ...
app.route('/mcp', mcpApp);要运行:
bun dev打开http://localhost:3000
要启动MCP检查器:
bun mcp:inspector测试
- 将MCP检查器目标URL设置为
http://localhost:3000/mcp.
- 选择
Connect那么List Tools.
- 选择
Get User工具。
- 添加任意ID值作为路径参数。
- 选择
Run Tool.
- 返回的模拟用户应具有您输入的ID值!
备注
- 任何TypeScript错误都会导致客户端生成失败,因此必须将初始生成的MCP导入注释掉。
- 这
@modelcontextprotocol/sdk依赖关系仅与Zod 3兼容,因此openapi-ts配置已相应更新。 - 路径在
openapi-ts配置已更新为与此项目的结构兼容。 - 这
api-config.ts该文件依赖于生成的类型文件,这似乎有点脆弱,但不会导致任何编译时问题。 - 这
api-config.ts文件已修改为直接包含clientConfig,以及项目特定值,如appConfig和ApiError为了简单起见,被删除了。
路线图
- 这
registerTool建议采用以下方法tool以获得更强大的用例。 - 添加一个可能会有所帮助
List ToolsMCP端点,帮助客户发现可用的工具和资源。 - 目前不支持通过MCP传递身份验证凭据。
