SuperAPI AI 工具集

mcp-builder

智能体与模型

查看项目

更新于 10-15 10:21

技能介绍

MCP Server Development Guide 是一份指导开发者创建高质量 MCP(Model Context Protocol)服务器的文档。其核心目标是让 LLM 能够通过设计良好的工具与外部服务交互,并明确指出 MCP 服务器的质量以“能否帮助 LLM 完成真实世界任务”来衡量。

用途 本指南用于指导从零构建 MCP 服务器,覆盖研究规划、实现、审查测试与评估四个阶段,适合需要将外部服务接入 LLM 的开发者参考。

主要能力与流程 指南将创建高质量 MCP 服务器分为四个主要阶段。

第一阶段:深度研究与规划。需要理解现代 MCP 设计,包括 API 覆盖与工作流工具的平衡(不确定时优先全面 API 覆盖)、工具命名与可发现性(使用一致前缀与面向动作的命名,如 github_create_issue、github_list_repos)、上下文管理(简洁描述、支持过滤与分页)、可操作的错误信息。同时需要研究 MCP 协议文档,建议从 sitemap 入手(https://modelcontextprotocol.io/sitemap.xml),再以 .md 后缀获取具体页面(如 https://modelcontextprotocol.io/specification/draft.md),重点查看规范概览与架构、传输机制(streamable HTTP、stdio)、工具/资源/提示定义。还需研究框架文档,推荐技术栈为 TypeScript(SDK 支持好、兼容 MCPB 等执行环境、模型擅长生成),传输方式为远程服务器用 Streamable HTTP(无状态 JSON,便于扩展与维护)、本地服务器用 stdio。最后规划实现:理解 API 文档、认证要求与数据模型,列出要实现的端点,从最常见操作开始。

第二阶段:实现。包括搭建项目结构、实现核心基础设施(带认证的 API 客户端、错误处理辅助、响应格式化 JSON/Markdown、分页支持),以及实现工具。每个工具需定义输入 Schema(TypeScript 用 Zod,Python 用 Pydantic,含约束、清晰描述与字段示例)、输出 Schema(尽可能定义 outputSchema,使用 structuredContent)、工具描述(功能摘要、参数说明、返回类型 Schema)、实现(异步 I/O、可操作错误处理、分页、同时返回文本内容与结构化数据)以及注解(readOnlyHint、destructiveHint、idempotentHint、openWorldHint)。

第三阶段:审查与测试。检查代码质量(无重复代码、一致错误处理、完整类型覆盖、清晰工具描述)。TypeScript 运行 npm run build 验证编译,并用 MCP Inspector 测试:npx @modelcontextprotocol/inspector;Python 用 python -m py_compile your_server.py 验证语法,同样用 MCP Inspector 测试。

第四阶段:创建评估。实现后创建全面评估以测试有效性。需理解评估目的(测试 LLM 能否有效使用服务器回答真实复杂问题),创建 10 个评估问题,流程为工具检查、内容探索(只读操作)、问题生成、答案验证。每个问题需满足:独立、只读、复杂(需多次工具调用与深入探索)、真实、可验证(单一明确答案,可字符串比较)、稳定(答案不随时间变化)。输出为 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 文档(先加载,从 sitemap 开始)、MCP 最佳实践(命名约定、响应格式 JSON vs Markdown、分页、传输选择、安全与错误处理标准)、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/FastMCP 指南含服务器初始化、Pydantic 模型、@mcp.tool 注册、完整示例与质量清单;TypeScript 指南含项目结构、Zod Schema、server.registerTool 注册、完整示例与质量清单)、评估指南(问题创建、答案验证、XML 格式、示例问答与运行脚本)。

适用场景 适用于需要为 LLM 构建外部服务集成工具的开发者,尤其是希望遵循 MCP 规范、提升工具可发现性与可评估性的场景。

限制 资料未提供该指南的具体安装命令、收费方式、价格、平台支持范围或实际效果数据,这些信息暂未提供。