用途
mcp-builder 是一份 MCP(Model Context Protocol)服务器开发指南,目标是创建能让 LLM 通过设计良好的工具与外部服务交互的 MCP 服务器。指南指出,MCP 服务器的质量取决于它能否帮助 LLM 完成真实世界的任务。
主要能力与流程
指南将创建高质量 MCP 服务器划分为四个主要阶段。
阶段一:深度调研与规划
- 理解现代 MCP 设计:在 API 覆盖与工作流工具之间取得平衡。工作流工具对特定任务更方便,而全面的 API 覆盖让智能体有组合操作的灵活性。不同客户端表现不同,不确定时优先选择全面的 API 覆盖。
- 工具命名与可发现性:使用清晰、描述性的名称,采用一致前缀(如 github_create_issue、github_list_repos)和面向动作的命名。
- 上下文管理:工具描述应简洁,支持过滤和分页,返回聚焦且相关的数据。
- 可操作的错误信息:错误信息应给出具体建议和下一步,引导智能体解决问题。
- 研究 MCP 协议文档:从 sitemap(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 客户端、错误处理辅助、响应格式化(JSON/Markdown)、分页支持。
- 实现工具:输入 Schema 使用 Zod(TypeScript)或 Pydantic(Python),包含约束和清晰描述,在字段描述中加入示例;输出 Schema 尽可能定义 outputSchema,在工具响应中使用 structuredContent;工具描述包含功能摘要、参数说明、返回类型 Schema;实现时使用 async/await 处理 I/O,提供可操作的错误处理,支持分页,返回文本内容和结构化数据;注解包括 readOnlyHint、destructiveHint、idempotentHint、openWorldHint。
阶段三:审查与测试
- 代码质量:无重复代码(DRY)、一致的错误处理、完整类型覆盖、清晰的工具描述。
- 构建与测试:TypeScript 运行 npm run build 验证编译,用 MCP Inspector 测试(npx @modelcontextprotocol/inspector);Python 用 python -m py_compile your_server.py 验证语法,并用 MCP Inspector 测试。
阶段四:创建评估
实现 MCP 服务器后,创建全面评估来测试其有效性。
- 理解评估目的:测试 LLM 能否有效使用你的 MCP 服务器回答真实、复杂的问题。
- 创建 10 个评估问题:工具检查、内容探索(只读操作)、问题生成、答案验证。
- 评估要求:每个问题应独立、只读、复杂(需要多次工具调用和深入探索)、真实、可验证(单一明确答案,可通过字符串比较验证)、稳定(答案不随时间变化)。
- 输出格式:创建 XML 文件,结构为 <evaluation> 包含多个 <qa_pair>,每个含 <question> 和 <answer>。
使用方式
指南本身是一份开发流程文档,开发者在创建 MCP 服务器时按阶段参考。它提供了需要按需加载的参考文件:
- 核心 MCP 文档(优先加载):MCP 协议从 sitemap 开始,再用 .md 后缀获取具体页面;MCP 最佳实践(服务器与工具命名约定、响应格式指南、分页最佳实践、传输选择、安全与错误处理标准)。
- SDK 文档(阶段一/二加载):Python SDK 从 https://raw.githubusercontent.com/modelcontextprotocol/python-sdk/main/README.md 获取;TypeScript SDK 从 https://raw.githubusercontent.com/modelcontextprotocol/typescript-sdk/main/README.md 获取。
- 语言专属实现指南(阶段二加载):Python 实现指南(服务器初始化模式、Pydantic 模型示例、用 @mcp.tool 注册工具、完整示例、质量清单);TypeScript 实现指南(项目结构、Zod schema 模式、用 server.registerTool 注册工具、完整示例、质量清单)。
- 评估指南(阶段四加载):问题创建指南、答案验证策略、XML 格式规范、示例问答、用提供的脚本运行评估。
适用场景
适用于需要为 LLM 构建与外部服务交互的 MCP 服务器的开发者,尤其是希望遵循规范流程、保证工具设计质量和可评估性的场景。
限制
资料未提供该指南的具体安装命令、收费方式、价格、平台支持范围或实际效果数据,这些信息暂未提供。