mcp-builder— agent skill

---
name: mcp-builder
description: 指导创建高质量 MCP (Model Context Protocol) 服务器，使 LLM 能够通过精心设计的工具与外部服务交互。在构建 MCP 服务器以集成外部 API 或服务时使用，无论是在 Python (FastMCP) 中还是在 Node/TypeScript (MCP SDK) 中。
license: 完整条款见 LICENSE.txt
---

# MCP 服务器开发指南

## 概述

创建 MCP (Model Context Protocol) 服务器，使 LLM 能够通过精心设计的工具与外部服务交互。MCP 服务器的质量取决于它在多大程度上帮助 LLM 完成现实世界中的任务。

---

# 流程

## 🚀 高层工作流

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

### 阶段 1：深入研究与规划

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

**API 覆盖与工作流工具：**
在全面的 API 端点覆盖与专业的工作流工具之间取得平衡。工作流工具在处理特定任务时可能更方便，而全面的 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`）。

关键审查页面：
- 规范概述与架构
- 传输机制 (streamable HTTP, stdio)
- 工具、资源和提示定义

#### 1.3 研究框架文档

**推荐技术栈：**
- **语言**：TypeScript (高质量的 SDK 支持以及在多种执行环境（如 MCPB）中的良好兼容性。此外，AI 模型擅长生成 TypeScript 代码，这得益于其广泛应用、静态类型和优秀的 linting 工具)
- **传输**：远程服务器使用 Streamable HTTP，采用无状态 JSON（相比有状态会话和流式响应，更易于扩展和维护）。本地服务器使用 stdio。

**加载框架文档：**

- **MCP 最佳实践**：[📋 查看最佳实践](./reference/mcp_best_practices.md) - 核心指南

**对于 TypeScript (推荐)：**
- **TypeScript SDK**：使用 WebFetch 加载 `https://raw.githubusercontent.com/modelcontextprotocol/typescript-sdk/main/README.md`
- [⚡ TypeScript 指南](./reference/node_mcp_server.md) - TypeScript 模式与示例

**对于 Python：**
- **Python SDK**：使用 WebFetch 加载 `https://raw.githubusercontent.com/modelcontextprotocol/python-sdk/main/README.md`
- [🐍 Python 指南](./reference/python_mcp_server.md) - Python 模式与示例

#### 1.4 规划你的实现

**理解 API：**
查看服务的 API 文档，以确定关键端点、认证要求和数据模型。根据需要使用网页搜索和 WebFetch。

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

---

### 阶段 2：实现

#### 2.1 建立项目结构

查看特定语言的指南以进行项目设置：
- [⚡ TypeScript 指南](./reference/node_mcp_server.md) - 项目结构、package.json、tsconfig.json
- [🐍 Python 指南](./reference/python_mcp_server.md) - 模块组织、依赖项

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

创建共享实用程序：
- 带认证的 API 客户端
- 错误处理辅助工具
- 响应格式化 (JSON/Markdown)
- 分页支持

#### 2.3 实现工具

对于每个工具：

**输入模式 (Schema)：**
- 使用 Zod (TypeScript) 或 Pydantic (Python)
- 包含约束和清晰的描述
- 在字段描述中添加示例

**输出模式 (Schema)：**
- 尽可能为结构化数据定义 `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 构建与测试

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

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

参阅特定语言的指南，了解详细的测试方法和质量清单。

---

### 阶段 4：创建评估

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

**加载 [✅ 评估指南](./reference/evaluation.md) 获取完整的评估指南。**

#### 4.1 理解评估目的

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

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

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

1. **工具检查**：列出可用工具并理解其功能
2. **内容探索**：使用只读 (READ-ONLY) 操作来探索可用数据
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> <!-- More qa_pairs... --> </evaluation>

---

# 参考文件

## 📚 文档库

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

### 核心 MCP 文档 (首先加载)
- **MCP 协议**：从站点地图 `https://modelcontextprotocol.io/sitemap.xml` 开始，然后获取带有 `.md` 后缀的特定页面
- [📋 MCP 最佳实践](./reference/mcp_best_practices.md) - 通用 MCP 指南，包括：
  - 服务器和工具命名约定
  - 响应格式指南 (JSON vs Markdown)
  - 分页最佳实践
  - 传输选择 (streamable HTTP vs 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 实现指南](./reference/python_mcp_server.md) - 完整的 Python/FastMCP 指南，包含：
  - 服务器初始化模式
  - Pydantic 模型示例
  - 使用 `@mcp.tool` 注册工具
  - 完整的工作示例
  - 质量清单

- [⚡ TypeScript 实现指南](./reference/node_mcp_server.md) - 完整的 TypeScript 指南，包含：
  - 项目结构
  - Zod 模式模式
  - 使用 `server.registerTool` 注册工具
  - 完整的工作示例
  - 质量清单

### 评估指南 (在阶段 4 加载)
- [✅ 评估指南](./reference/evaluation.md) - 完整的评估创建指南，包含：
  - 问题创建指南
  - 答案验证策略
  - XML 格式规范
  - 示例问题和答案
  - 使用提供的脚本运行评估