Files

T

wehub-skill-sync 54a9c167be chore: import zh skill mcp-builder

2026-07-13 21:35:36 +08:00

8.3 KiB

Raw Blame History

name, description, license

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

MCP 服务器开发指南

概述

创建 MCP（模型上下文协议）服务器，使 LLM 能够通过精心设计的工具与外部服务进行交互。MCP 服务器的质量取决于它在多大程度上帮助 LLM 完成真实世界任务。

流程

🚀 高级工作流

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

阶段一：深入调研与规划

1.1 理解现代 MCP 设计

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）。

需要查阅的关键页面：

规范概述与架构
传输机制（可流式 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 特性）
帮助客户端理解和处理工具输出

工具描述：

功能简介
参数描述
返回类型模式

实现：

I/O 操作使用 async/await
带有可操作消息的恰当错误处理
在适用时支持分页
使用现代 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 个评估问题

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

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

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 格式规范
- 示例问题与答案
- 使用提供的脚本运行评估

8.3 KiB Raw Blame History Unescape Escape