返回顶部
m

mcp-builderMCP服务器构建指南

Guide for creating high-quality MCP (Model Context Protocol) servers that enable LLMs to interact with external services through well-designed tools. Use when building MCP servers to integrate external APIs or services, whether in Python (FastMCP) or Node/TypeScript (MCP SDK).

作者: admin | 来源: ClawHub
源自
ClawHub
版本
V 1.0.0
安全检测
已通过
392
下载量
免费
免费
0
收藏
概述
安装方式
版本历史

mcp-builder

MCP 服务器开发指南

概述

创建 MCP(模型上下文协议)服务器,使大语言模型能够通过精心设计的工具与外部服务进行交互。MCP 服务器的质量取决于其帮助大语言模型完成实际任务的能力。



流程

🚀 高级工作流

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

阶段一:深入调研与规划

1.1 理解现代 MCP 设计

API 覆盖 vs. 工作流工具:
在全面的 API 端点覆盖与专门的工作流工具之间取得平衡。工作流工具对于特定任务可能更方便,而全面覆盖则赋予智能体组合操作的灵活性。不同客户端的性能表现各异——某些客户端受益于结合基础工具的代码执行,而其他客户端则更适合高级工作流。不确定时,优先考虑全面的 API 覆盖。

工具命名与可发现性:
清晰、描述性的工具名称有助于智能体快速找到合适的工具。使用一致的前缀(例如 githubcreateissue、githublistrepos)和面向操作的命名方式。

上下文管理:
简洁的工具描述以及过滤/分页结果的能力对智能体有益。设计能够返回聚焦、相关数据的工具。某些客户端支持代码执行,这可以帮助智能体高效地过滤和处理数据。

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

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。

加载框架文档:

对于 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.1 设置项目结构

请参阅特定语言的指南进行项目设置:

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 pycompile yourserver.py
  • 使用 MCP Inspector 测试

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



阶段四:创建评估

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

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

4.1 理解评估目的

使用评估来测试大语言模型是否能够有效使用您的 MCP 服务器来回答真实、复杂的问题。

4.2 创建 10 个评估问题

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

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

4.3 评估要求

确保每个问题:

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

4.4 输出格式

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

xml


查找关于使用动物代号进行 AI 模型发布的讨论。某个模型需要一种使用 ASL-X 格式的特定安全标识。以斑点野猫命名的模型正在确定的 X 数字是多少?
3





参考文件

📚 文档库

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

核心 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 获取

特定语言实现指南(阶段二加载)

- 服务器初始化模式 - Pydantic 模型示例 - 使用 @mcp.tool 注册工具 - 完整的工作示例 - 质量检查清单 - 项目结构 - Zod 模式模式 - 使用 server.registerTool 注册工具 - 完整的工作示例 - 质量检查清单

评估指南(阶段四加载)

- 问题创建指南 - 答案验证策略 - XML 格式规范 - 示例问题和答案 - 使用

标签

skill ai

通过对话安装

该技能支持在以下平台通过对话安装:

OpenClaw WorkBuddy QClaw Kimi Claude

方式一:安装 SkillHub 和技能

帮我安装 SkillHub 和 mcp-builder-anthropic-1776089363 技能

方式二:设置 SkillHub 为优先技能安装源

设置 SkillHub 为我的优先技能安装源,然后帮我安装 mcp-builder-anthropic-1776089363 技能

通过命令行安装

skillhub install mcp-builder-anthropic-1776089363

下载

⬇ 下载 mcp-builder v1.0.0(免费)

文件大小: 42.19 KB | 发布时间: 2026-4-15 13:21

v1.0.0 最新 2026-4-15 13:21
mcp-builder-anthropic 1.0.0

- Initial release of the MCP server development guide.
- Covers all phases: research, planning, implementation, review/testing, and evaluation creation.
- Includes best practices for tool design, naming, error handling, and evaluation question writing.
- Provides structured workflows and links to core and framework-specific documentation.
- Offers language-specific advice for TypeScript and Python MCP server development.

Archiver·手机版·闲社网·闲社论坛·羊毛社区· 多链控股集团有限公司 · 苏ICP备2025199260号-1

Powered by Discuz! X5.0   © 2024-2025 闲社网·线报更新论坛·羊毛分享社区·http://xianshe.com

p2p_official_large
返回顶部