mcp-builder

MCP 服务开发指南

概述

创建 MCP（Model Context Protocol）服务，通过设计良好的工具让大模型与外部服务交互。MCP 服务的质量取决于它能在多大程度上帮助大模型完成真实世界的任务。

---

流程

🚀 高层工作流

创建高质量的 MCP 服务主要包含四个阶段：

阶段 1：深入研究与规划

1.1 理解现代 MCP 设计

API 覆盖范围与工作流工具： 在全面的 API 端点覆盖与专用工作流工具之间取得平衡。工作流工具在特定任务上更便捷，而全面覆盖则让 Agent 能够灵活组合操作。不同客户端的表现各不相同：有些客户端受益于组合基础工具的代码执行，而另一些则更适合使用更高层的工作流。不确定时，优先选择全面的 API 覆盖。

工具命名与可发现性： 清晰、描述性强的工具名称有助于 Agent 快速找到合适的工具。请使用一致的前缀（例如 github_create_issue、github_list_repos）并采用以动作为导向的命名方式。

上下文管理： Agent 受益于简洁的工具描述，以及对结果进行过滤和分页的能力。请设计返回聚焦、相关数据的工具。一些客户端支持代码执行，这有助于 Agent 高效地过滤和处理数据。

可操作的错误信息： 错误信息应通过具体建议和后续步骤，引导 Agent 找到解决方案。

1.2 学习 MCP 协议文档

浏览 MCP 规范：

从站点地图开始查找相关页面：https://modelcontextprotocol.io/sitemap.xml

然后访问带有 .md 后缀的具体页面，以获取 Markdown 格式（例如 https://modelcontextprotocol.io/specification/draft.md）。

需要重点查阅的页面：

• 规范概览与架构
• 传输机制（Streamable HTTP、stdio）
• 工具、资源和提示词的定义

1.3 学习框架文档

推荐技术栈：

• 语言：TypeScript（SDK 支持质量高，在 MCPB 等多种执行环境中兼容性良好。此外，大模型擅长生成 TypeScript 代码，受益于其广泛使用、静态类型和完善的代码检查工具）
• 传输：远程服务使用 Streamable HTTP，采用无状态 JSON（相比有状态会话和流式响应，更易于扩展和维护）。本地服务使用 stdio。

加载框架文档：

• MCP 最佳实践：📋 查看最佳实践，包含核心指南

TypeScript（推荐）：

• TypeScript SDK：使用 WebFetch 加载 https://raw.githubusercontent.com/modelcontextprotocol/typescript-sdk/main/README.md
• ⚡ TypeScript 指南，包含 TypeScript 模式与示例

Python：

• Python SDK：使用 WebFetch 加载 https://raw.githubusercontent.com/modelcontextprotocol/python-sdk/main/README.md
• 🐍 Python 指南，包含 Python 模式与示例

1.4 规划实现方案

理解 API： 查阅服务的 API 文档，找出关键端点、身份验证要求和数据模型。根据需要使用网页搜索和 WebFetch。

工具选择： 优先全面覆盖 API。列出要实现的端点，从最常用的操作开始。

---

阶段 2：实现

2.1 搭建项目结构

项目搭建请参阅对应语言的指南：

• ⚡ TypeScript 指南，包含项目结构、package.json、tsconfig.json
• 🐍 Python 指南，包含模块组织、依赖项

2.2 实现核心基础设施

创建共享工具：

• 带身份验证的 API 客户端
• 错误处理辅助函数
• 响应格式化（JSON/Markdown）
• 分页支持

2.3 实现工具

针对每个工具：

输入 Schema：

• 使用 Zod（TypeScript）或 Pydantic（Python）
• 包含约束条件和清晰的描述
• 在字段描述中添加示例

输出 Schema：

• 在可能的情况下为结构化数据定义 outputSchema
• 在工具响应中使用 structuredContent（TypeScript SDK 特性）
• 帮助客户端理解并处理工具输出

工具描述：

• 简明扼要的功能概述
• 参数描述
• 返回类型 Schema

实现：

• I/O 操作使用 async/await
• 进行适当的错误处理，并给出可操作的提示信息
• 在适用的场景下支持分页
• 使用现代 SDK 时，同时返回文本内容和结构化数据

注解：

• readOnlyHint：true/false
• destructiveHint：true/false
• idempotentHint：true/false
• openWorldHint：true/false

---

第 3 阶段：审查与测试

3.1 代码质量

检查以下方面：

• 没有重复代码（DRY 原则）
• 错误处理保持一致
• 类型覆盖完整
• 工具描述清晰

3.2 构建与测试

TypeScript：

• 运行 npm run build 验证编译
• 使用 MCP Inspector 测试：npx @modelcontextprotocol/inspector

Python：

• 验证语法：python -m py_compile your_server.py
• 使用 MCP Inspector 测试

详细的测试方法和质量检查清单，请参阅对应语言的指南。

---

第 4 阶段：创建评估

实现 MCP 服务之后，创建全面的评估用例来测试其效果。

完整的评估指南请参阅 ✅ 评估指南。

4.1 理解评估目的

使用评估来测试大模型能否有效地利用你的 MCP 服务回答真实且复杂的问题。

4.2 创建 10 个评估问题

要创建有效的评估，请遵循评估指南中的流程：

1. 工具检查：列出可用工具并了解其能力
2. 内容探索：使用只读操作探索可用数据
3. 问题生成：创建 10 个复杂且真实的问题
4. 答案验证：自行解答每个问题以验证答案

4.3 评估要求

确保每个问题满足以下条件：

• 独立：不依赖其他问题
• 只读：只需要非破坏性操作
• 复杂：需要多次工具调用和深入探索
• 真实：基于人们真正关心的实际使用场景
• 可验证：答案唯一且明确，可通过字符串比较进行验证
• 稳定：答案不会随时间变化

4.4 输出格式

创建一个 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>

</evaluation>

---

参考文件

📚 文档库

开发过程中按需加载这些资源：

核心 MCP 文档（优先加载）

• MCP 协议：从站点地图 https://modelcontextprotocol.io/sitemap.xml 开始，然后获取带有 .md 后缀的具体页面
• 📋 MCP 最佳实践：通用的 MCP 指南，包括：
  • 服务与工具的命名规范
  • 响应格式指南（JSON 与 Markdown 对比）
  • 分页最佳实践
  • 传输方式选择（streamable HTTP 与 stdio）
  • 安全与错误处理标准

SDK 文档（在第 1/2 阶段加载）

• Python SDK：从 https://raw.githubusercontent.com/modelcontextprotocol/python-sdk/main/README.md 获取
• TypeScript SDK：从 https://raw.githubusercontent.com/modelcontextprotocol/typescript-sdk/main/README.md 获取

特定语言实现指南（在第 2 阶段加载）

• 🐍 Python 实现指南 - 完整的 Python/FastMCP 指南，包括：

  • 服务初始化模式
  • Pydantic 模型示例
  • 使用 @mcp.tool 注册工具
  • 完整可运行的示例
  • 质量检查清单

• ⚡ TypeScript 实现指南 - 完整的 TypeScript 指南，包括：

  • 项目结构
  • Zod Schema 模式
  • 使用 server.registerTool 注册工具
  • 完整可运行的示例
  • 质量检查清单

评估指南（在第 4 阶段加载）

• ✅ 评估指南 - 完整的评估创建指南，包括：
  • 问题创建指南
  • 答案验证策略
  • XML 格式规范
  • 示例问题与答案
  • 使用提供的脚本运行评估