protocol-implementation-framework

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 找到解决方案。

以评估为驱动的迭代： 尽早起草几个贴近实际的评估问题，然后根据 Agent 遇到困难之处改进工具设计。

1.2 学习 MCP 协议文档

浏览 MCP 规范：

优先阅读完整规范文本：https://modelcontextprotocol.io/llms-full.txt。 如需查阅特定页面，请从站点地图开始：https://modelcontextprotocol.io/sitemap.xml

然后获取特定页面，并在 URL 后添加 .md 以使用 Markdown 格式（例如，https://modelcontextprotocol.io/specification/draft.md）。

建议查阅的关键页面：

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

1.3 学习框架文档

推荐技术栈：

• 语言：TypeScript（SDK 质量高，且与多种执行环境兼容性良好，例如 MCPB。此外，AI 模型擅长生成 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 实现工具

对于每个工具：

输入架构：

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

输出架构：

• 尽可能为结构化数据定义 outputSchema
• 在工具响应中使用 structuredContent（TypeScript SDK 功能）
• 帮助客户端理解和处理工具输出

工具描述：

• 简洁的功能摘要
• 参数描述
• 返回类型架构

实现：

• 对 I/O 操作使用 Async/await
• 通过可执行的错误消息妥善处理错误
• 在适用的情况下支持分页
• 使用现代 SDK 时，同时返回文本内容和结构化数据

注解：

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

---

阶段 3：审查和测试

3.1 代码质量

检查以下方面：

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

3.2 构建和测试

注意： MCP 服务是长期运行的进程。如果直接运行，它会阻塞并等待请求。建议使用评估工具，或者在单独的会话（tmux）中运行服务，或为其设置超时。

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/llms-full.txt。如需查找特定页面，请使用站点地图 https://modelcontextprotocol.io/sitemap.xml。
• 📋 MCP 最佳实践 - 通用 MCP 指南，包括：
  • 服务和工具命名规范
  • 响应格式指南（JSON 与 Markdown）
  • 分页最佳实践
  • 传输方式选择（可流式 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 格式规范
  • 示例问题与答案
  • 使用提供的脚本运行评估