📦 Mcp Builder test — MCP Builder 测试
v0.1.1创建高质量MCP(Model Context Protocol)服务器的指南,实现LLMs通过精心设计的工具与外部服务交互。使用...
运行时依赖
安装命令
点击复制技能文档
MCP 服务器开发指南概述 创建MCP(模型上下文协议)服务器,以便LLM通过精心设计的工具与外部服务交互。MCP服务器的质量由其使LLM能够完成实际任务的能力来衡量。
过程 创建高质量的MCP服务器涉及四个主要阶段:
阶段1:深入研究和规划 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代码,受益于其广泛的使用、静态类型和良好的linting工具) 传输:远程服务器使用可流式的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:实现 2.1 设置项目结构 查看语言特定的指南以设置项目: TypeScript指南 - 项目结构、package.json、tsconfig.json Python指南 - 模块组织、依赖项
2.2 实现核心基础设施 创建共享的实用程序: API客户端(带身份验证) 错误处理助手 响应格式(JSON/Markdown) 分页支持
2.3 实现工具 对于每个工具: 输入模式:使用Zod(TypeScript)或Pydantic(Python) 包括约束和清晰的描述 在字段描述中添加示例 输出模式:在可能的情况下定义输出模式 使用结构化内容(TypeScript SDK功能)在工具响应中 帮助客户端了解和处理工具输出 工具描述:功能的简要摘要 参数描述 返回类型模式 实现:异步/等待I/O操作 正确的错误处理,具有可操作的消息 在适用情况下支持分页 使用现代SDK时返回文本内容和结构化数据 注释: readOnlyHint:true/false destructiveHint:true/false idempotentHint:true/false openWorldHint:true/false
阶段3:审查和测试 3.1 代码质量审查 无重复代码(DRY原则) 一致的错误处理 完整的类型覆盖 清晰的工具描述
3.2 构建和测试 TypeScript:运行npm run build以验证编译 使用MCP检查器测试:npx @modelcontextprotocol/inspector Python:验证语法:python -m py_compile your_server.py 使用MCP检查器测试 查看语言特定的指南以获取详细的测试方法和质量检查清单。
阶段4:创建评估 实现MCP服务器后,创建全面评估以测试其有效性。 加载评估指南,获取完整的评估指南。