用途
mcp-builder 是一份开发指南,用于创建高质量的 MCP(Model Context Protocol)服务器,使 LLM 能够通过设计良好的工具与外部服务交互。指南明确指出,MCP 服务器的质量以它能否帮助 LLM 完成真实世界任务来衡量。
主要能力与内容
指南围绕四个阶段组织开发流程:
阶段一:深度研究与规划
- 理解现代 MCP 设计,包括 API 覆盖与工作流工具之间的平衡、工具命名与可发现性、上下文管理、可操作的错误信息。
- 研究 MCP 协议文档:从站点地图 https://modelcontextprotocol.io/sitemap.xml 开始,再用 .md 后缀获取具体页面(如 https://modelcontextprotocol.io/specification/draft.md)。重点页面包括规范概览与架构、传输机制(streamable HTTP、stdio)、工具/资源/提示定义。
- 研究框架文档。推荐技术栈为 TypeScript(SDK 支持好、兼容多种执行环境如 MCPB,且 AI 模型擅长生成 TypeScript 代码),传输方式为远程服务器使用 Streamable HTTP 与无状态 JSON,本地服务器使用 stdio。
- 规划实现:审阅服务 API 文档,识别关键端点、认证要求与数据模型,优先实现全面的 API 覆盖。
阶段二:实现
- 搭建项目结构(参见语言专属指南)。
- 实现核心基础设施:带认证的 API 客户端、错误处理辅助、响应格式化(JSON/Markdown)、分页支持。
- 实现工具:输入模式使用 Zod(TypeScript)或 Pydantic(Python),包含约束与清晰描述;输出模式尽可能定义 outputSchema,并在工具响应中使用 structuredContent;工具描述包含功能摘要、参数说明与返回类型模式;实现时使用 async/await、可操作的错误处理、分页支持,并同时返回文本内容与结构化数据;注解包括 readOnlyHint、destructiveHint、idempotentHint、openWorldHint。
阶段三:审查与测试
- 代码质量:无重复代码(DRY)、一致的错误处理、完整类型覆盖、清晰的工具描述。
- 构建与测试:TypeScript 运行 npm run build 验证编译,使用 MCP Inspector 测试(npx @modelcontextprotocol/inspector);Python 用 python -m py_compile your_server.py 验证语法,并用 MCP Inspector 测试。
阶段四:创建评估
- 创建 10 道评估问题,测试 LLM 能否有效使用该 MCP 服务器回答真实、复杂的问题。
- 流程:工具检查、内容探索(只读操作)、问题生成、答案验证。
- 每道问题需满足:独立、只读、复杂(需多次工具调用与深入探索)、真实、可验证(单一明确答案,可用字符串比较验证)、稳定(答案不随时间变化)。
- 输出为 XML 文件,结构为 <evaluation> 包含多个 <qa_pair>,每个含 <question> 与 <answer>。
使用方式
指南建议在开发过程中按需加载参考文件:核心 MCP 文档(优先加载)、MCP 最佳实践、SDK 文档(阶段一/二加载)、语言专属实现指南(阶段二加载)、评估指南(阶段四加载)。SDK 文档可通过 WebFetch 加载:
- Python SDK:https://raw.githubusercontent.com/modelcontextprotocol/python-sdk/main/README.md
- TypeScript SDK:https://raw.githubusercontent.com/modelcontextprotocol/typescript-sdk/main/README.md
适用场景
适用于需要为 LLM 构建与外部服务交互的 MCP 服务器的开发者,尤其是希望遵循规范流程、保证工具设计质量并进行系统评估的场景。
限制
资料未提供该指南的具体授权方式、版本信息、依赖的框架版本要求,以及评估脚本的具体运行细节。