一键导入
mcp-builder
用于创建高质量 MCP(模型上下文协议)服务器或工具(Tools)的指南,使大语言模型能够通过精心设计的工具与外部服务进行交互。在构建 MCP 服务器以集成外部 API 或服务时使用,支持 Python(FastMCP)或 Node/TypeScript(MCP SDK)。
菜单
用于创建高质量 MCP(模型上下文协议)服务器或工具(Tools)的指南,使大语言模型能够通过精心设计的工具与外部服务进行交互。在构建 MCP 服务器以集成外部 API 或服务时使用,支持 Python(FastMCP)或 Node/TypeScript(MCP SDK)。
| name | mcp-builder |
| description | 用于创建高质量 MCP(模型上下文协议)服务器或工具(Tools)的指南,使大语言模型能够通过精心设计的工具与外部服务进行交互。在构建 MCP 服务器以集成外部 API 或服务时使用,支持 Python(FastMCP)或 Node/TypeScript(MCP SDK)。 |
| license | 完整条款见 LICENSE.txt |
创建 MCP(模型上下文协议)服务器,使大语言模型能够通过精心设计的工具与外部服务进行交互。MCP 服务器的质量取决于它如何有效地帮助大语言模型完成实际任务。
创建高质量的 MCP 服务器涉及四个主要阶段:
API 覆盖 vs. 工作流工具: 平衡全面的 API 端点覆盖与专门的工作流工具。工作流工具对于特定任务可能更方便,而全面覆盖则赋予智能体灵活组合操作的能力。性能因客户端而异——某些客户端受益于结合基本工具的代码执行,而其他客户端则更适合高级工作流。当不确定时,优先考虑全面的 API 覆盖。
工具命名与可发现性:
清晰、描述性的工具名称帮助智能体快速找到合适的工具。使用一致的前缀(例如 github_create_issue、github_list_repos)和面向动作的命名方式。
上下文管理: 智能体受益于简洁的工具描述以及过滤/分页结果的能力。设计返回聚焦、相关数据的工具。某些客户端支持代码执行,可以帮助智能体高效地过滤和处理数据。
可操作的错误消息: 错误消息应该通过具体的建议和后续步骤引导智能体找到解决方案。
浏览 MCP 规范:
从站点地图开始找到相关页面:https://modelcontextprotocol.io/sitemap.xml
然后使用 .md 后缀获取特定页面的 Markdown 格式(例如 https://modelcontextprotocol.io/specification/draft.md)。
需要查看的关键页面:
推荐技术栈:
加载框架文档:
TypeScript(推荐):
https://raw.githubusercontent.com/modelcontextprotocol/typescript-sdk/main/README.mdPython:
https://raw.githubusercontent.com/modelcontextprotocol/python-sdk/main/README.md了解 API: 查看服务的 API 文档,识别关键端点、认证要求和数据模型。根据需要,使用网络搜索和 WebFetch。
工具选择: 优先考虑全面的 API 覆盖。列出要实现的端点,从最常见的操作开始。
查看语言特定的指南以进行项目设置:
创建共享工具:
总的来说,对于每个工具:
输入模式:
输出模式:
outputSchema 以获取结构化数据structuredContent(TypeScript SDK 特性)工具描述:
实现:
注解:
readOnlyHint:true/falsedestructiveHint:true/falseidempotentHint:true/falseopenWorldHint:true/false对于拥有2个或多个工具的复杂任务开发,use patterns from tools patterns,尤其是当工具涉及以下讨论时:
| 分类 | 核心问题 |
|---|---|
| Tool Types | Query、Command 还是 Discovery? |
| Tool Interface | Agent 如何理解和调用? |
| Tool Discovery | Agent 如何找到合适的 Tool? |
| Tool Composition | 是否应该捆绑多个操作? |
| Tool Execution | 同步、异步还是事务性? |
| Tool Response | 结果应该是什么样? |
| Tool Context | 身份和状态如何管理? |
| Tool Resilience | 如何从失败中恢复? |
| Tool Security | 如何控制访问? |
| Integration | 如何连接外部系统? |
审查:
TypeScript:
npm run build 验证编译npx @modelcontextprotocol/inspectorPython:
python -m py_compile your_server.py查看语言特定指南以获取详细的测试方法和质量检查清单。
实现 MCP 服务器后,创建全面的评估以测试其有效性。
加载 ✅ 评估指南 以获取完整的评估指南。
使用评估来测试大语言模型是否能够有效地使用你的 MCP 服务器来回答现实的复杂问题。
要创建有效的评估,请遵循评估指南中概述的流程:
确保每个问题:
创建具有以下结构的 XML 文件:
<evaluation>
<qa_pair>
<question>查找关于以动物代号命名的 AI 模型发布的讨论。一个模型需要特定的安全标识,格式为 ASL-X。对于以斑点野猫命名的模型,正在确定什么数字 X?</question>
<answer>3</answer>
</qa_pair>
<!-- 更多 qa_pairs... -->
</evaluation>
在开发过程中根据需要加载这些资源:
https://modelcontextprotocol.io/sitemap.xml 开始,然后使用 .md 后缀获取特定页面https://raw.githubusercontent.com/modelcontextprotocol/python-sdk/main/README.md 获取https://raw.githubusercontent.com/modelcontextprotocol/typescript-sdk/main/README.md 获取🐍 Python 实现指南 - 完整的 Python/FastMCP 指南,包括:
@mcp.tool 注册工具⚡ TypeScript 实现指南 - 完整的 TypeScript 指南,包括:
server.registerTool 注册工具