name: mcp-builder
description: 创建高质量 MCP（模型上下文协议）服务器的指南，该服务器通过精心设计的工具使 LLM 能够与外部服务进行交互。在构建 MCP 服务器以集成外部 API 或服务时使用，无论是使用 Python (FastMCP) 还是 Node/TypeScript (MCP SDK)。
license: Complete terms in LICENSE.txt

MCP 服务端开发指南

概述

创建 MCP（模型上下文协议）服务端，使 LLM 能够通过精心设计的工具与外部服务交互。MCP 服务端的质量取决于它使 LLM 完成实际任务的能力。

---

流程

🚀 高层工作流

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

阶段一：深度调研与规划

#### 1.1 理解现代 MCP 设计

API 覆盖 vs. 工作流工具：

在全面的 API 端点覆盖与专门的工作流工具之间取得平衡。工作流工具对于特定任务可能更方便，而全面覆盖则赋予代理组合操作的灵活性。不同客户端表现各异——部分客户端受益于组合基本工具的代码执行，另一些则更适合高层工作流。不确定时，优先考虑全面的 API 覆盖。

工具命名与可发现性：

清晰、描述性的工具名称有助于代理快速找到合适的工具。使用一致的前缀（例如 github_create_issue、github_list_repos）和面向操作的命名。

上下文管理：

代理受益于简洁的工具描述以及过滤/分页结果的能力。设计返回重点明确、相关数据的工具。部分客户端支持代码执行，这有助于代理高效过滤和处理数据。

可操作错误消息：

错误消息应通过具体建议和后续步骤引导代理找到解决方案。

#### 1.2 学习 MCP 协议文档

浏览 MCP 规范：

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

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

需查阅的关键页面：

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

#### 1.3 学习框架文档

推荐技术栈：

• 语言：TypeScript（高质量 SDK 支持，在许多执行环境如 MCPB 中兼容性好。此外，AI 模型擅长生成 TypeScript 代码，得益于其广泛使用、静态类型和良好的 lint 工具）
• 传输：远程服务端使用可流式 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 文档，确定关键端点、认证要求和数据模型。按需使用 web 搜索和 WebFetch。

工具选择：

优先考虑全面的 API 覆盖。列出要实现的端点，从最常见的操作开始。

---

阶段二：实现

#### 2.1 设置项目结构

参阅特定语言的项目设置指南：

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

#### 2.2 实现核心基础设施

创建共享工具：

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

#### 2.3 实现工具

对每个工具：

输入模式：

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

输出模式：

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

工具描述：

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

实现：

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

注解：

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

---

阶段三：审查与测试

#### 3.1 代码质量

检查：

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

#### 3.2 构建与测试

TypeScript：

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

Python：

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

有关详细测试方法和质量检查清单，请参阅特定语言指南。

---

阶段四：创建评估

实现 MCP 服务端后，创建全面的评估以测试其有效性。

加载 ✅ 评估指南 获取完整的评估指南。

#### 4.1 理解评估目的

使用评估测试 LLM 是否能有效使用你的 MCP 服务端来回答真实、复杂的问题。

#### 4.2 创建 10 个评估问题

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

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

#### 4.3 评估要求

确保每个问题：

• 独立：不依赖其他问题
• 只读：仅需非破坏性操作
• 复杂：需要多次工具调用和深度探索
• 真实：基于人类关心的实际用例
• 可验证：单个、清晰的答案，可通过字符串比较验证
• 稳定：答案不会随时间变化

#### 4.4 输出格式

创建具有以下结构的 XML 文件：

<evaluation>
  <qa_pair>
    <question>查找关于使用动物代号进行 AI 模型发布的讨论。某个模型需要特定的安全标识，格式为 ASL-X。在以斑点野猫命名的模型中，X 的数字是多少？</question>
    <answer>3</answer>
  </qa_pair>
<!-- 更多 qa_pair... -->
</evaluation>

---

参考文件

📚 文档库

在开发过程中根据需要加载这些资源：

核心 MCP 文档（优先加载）

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

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 实现指南 - 完整的 Python/FastMCP 指南，包括：
• 服务端初始化模式
• Pydantic 模型示例
• 使用 @mcp.tool 注册工具
• 完整的可工作示例
• 质量检查清单

• ⚡ TypeScript 实现指南 - 完整的 TypeScript 指南，包括：
• 项目结构
• Zod 模式模式
• 使用 server.registerTool 注册工具
• 完整的可工作示例
• 质量检查清单

评估指南（在阶段四期间加载）

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