用途
mcp-builder 是一份面向开发者的技能指南,用于创建高质量的 MCP(Model Context Protocol)服务器,使 LLM 能通过设计良好的工具与外部服务交互。指南强调,MCP 服务器的质量应以“LLM 能否借助它完成真实世界任务”来衡量。
主要能力与工作流程
指南将开发过程划分为四个阶段。
第一阶段:深度研究与规划
- 理解现代 MCP 设计:在 API 全面覆盖与专用工作流工具之间取得平衡;不确定时优先保证全面的 API 覆盖。
- 工具命名与可发现性:使用清晰、描述性的名称与一致前缀(如 github_create_issue、github_list_repos),采用面向动作的命名。
- 上下文管理:提供简洁的工具描述,支持结果过滤与分页,返回聚焦且相关的数据。
- 可操作的错误信息:错误应给出具体建议与下一步。
- 研读 MCP 协议文档:从 https://modelcontextprotocol.io/sitemap.xml 入手,再以 .md 后缀获取具体页面(如 https://modelcontextprotocol.io/specification/draft.md),重点关注规范概览与架构、传输机制(streamable HTTP、stdio)、工具/资源/提示定义。
- 研读框架文档:推荐 TypeScript(SDK 支持好、兼容性好、静态类型与 lint 工具完善、AI 模型生成 TypeScript 代码能力强);传输方式为远程服务器用 Streamable HTTP(无状态 JSON,便于扩展和维护)或本地服务器用 stdio。
- 规划实现:查阅服务 API 文档,识别关键端点、认证要求与数据模型,列出要实现的端点并从最常见操作开始。
第二阶段:实现
- 搭建项目结构(参见语言专属指南中的目录结构、package.json、tsconfig.json 或模块组织与依赖)。
- 实现核心基础设施:带认证的 API 客户端、错误处理辅助、响应格式化(JSON/Markdown)、分页支持。
- 实现工具:输入模式用 Zod(TypeScript)或 Pydantic(Python),包含约束、清晰描述与字段示例;尽可能定义 outputSchema,并在响应中使用 structuredContent;工具描述包含功能摘要、参数说明与返回类型模式;实现采用 async/await 处理 I/O、可操作的错误处理、分页支持,并在现代 SDK 中同时返回文本内容与结构化数据。
- 注解:readOnlyHint、destructiveHint、idempotentHint、openWorldHint。
第三阶段:审查与测试
- 代码质量:避免重复代码(DRY)、一致的错误处理、完整类型覆盖、清晰的工具描述。
- 构建与测试:TypeScript 运行 npm run build 验证编译,并用 npx @modelcontextprotocol/inspector 测试;Python 用 python -m py_compile your_server.py 验证语法,并用 MCP Inspector 测试。
第四阶段:创建评估
实现后创建全面评估,测试 LLM 能否有效使用服务器回答真实、复杂的问题。流程为:工具检查、以只读操作探索内容、生成 10 道复杂真实的问题、自行求解验证答案。每道题需满足:独立、只读、复杂(需多次工具调用与深入探索)、真实、可验证(单一明确答案,可通过字符串比较验证)、稳定(答案不随时间变化)。输出为 XML 文件,结构示例:
<evaluation>
<qa_pair>
<question>Find discussions about AI model launches with animal codenames. One model needed a specific safety designation that uses the format ASL-X. What number X was being determined for the model named after a spotted wild cat?</question>
<answer>3</answer>
</qa_pair>
<!-- More qa_pairs... -->
</evaluation>
参考文件
指南列出按需加载的文档库:核心 MCP 文档(协议 sitemap 与规范页)、MCP 最佳实践(服务器与工具命名、响应格式、分页、传输选择、安全与错误处理)、SDK 文档(Python SDK 与 TypeScript SDK 的 README)、语言专属实现指南(Python/FastMCP 指南含服务器初始化模式、Pydantic 模型示例、@mcp.tool 注册、完整示例与质量清单;TypeScript 指南含项目结构、Zod 模式、server.registerTool 注册、完整示例与质量清单)、评估指南(问题创建、答案验证策略、XML 格式规范、示例问答、运行评估的脚本)。
适用场景
适合需要为 LLM 开发 MCP 服务器、封装外部服务 API、或为已有 MCP 服务器补充测试评估的开发者。
限制
资料未提供具体收费、价格、平台支持范围或实际使用效果数据;技能的具体运行方式与环境要求暂未提供。