AutoMCP

AutoMCP

site icon
2025.03.21 1
TypeScript代码生成MCP 兼容服务开发效率
AutoMCP 是一个基于 [Model Context Protocol](https://github.com/modelcontextprotocol) 的代码生成器,能够根据 YAML 服务定义自动生成服务器和客户端代码。它旨在简化 MCP 兼容服务的开发流程,通过自动生成代码和提供工具处理程序存根,帮助开发者快速构建和集成服务。
View on GitHub

Overview

基本能力

产品定位

AutoMCP 是一个代码生成工具,专注于为 Model Context Protocol (MCP) 生成兼容的服务器和客户端代码,旨在提升开发效率和代码一致性。

核心功能

  • 自动生成 MCP 兼容的服务器代码:根据 YAML 定义生成服务器端实现。
  • 生成客户端库:方便服务消费,简化客户端集成。
  • 创建工具处理程序存根:为工具功能实现提供基础代码结构。
  • 按服务组织代码:在专用目录中管理服务相关代码。

适用场景

  • 快速开发 MCP 服务:适用于需要快速构建 MCP 兼容服务的开发者。
  • 代码一致性维护:适用于团队中需要保持代码一致性和规范的项目。
  • 工具链集成:适用于需要将自定义工具集成到 MCP 工作流中的场景。

工具列表

  • 代码生成器:根据 YAML 定义生成服务器和客户端代码。
  • 测试脚本:验证服务功能的正确性。

常见问题解答

  • 如何定义服务?:在 services/[service-name]/ 目录下创建 YAML 文件,定义服务结构和工具。
  • 如何生成代码?:运行 ./bin/automcp.sh generate 命令生成代码。
  • 如何实现工具功能?:编辑生成的 handler 文件,实现具体的工具逻辑。

使用教程

使用依赖

  • Node.js 18 或更高版本
  • npm 或 yarn

安装教程

  1. 克隆仓库: git clone [repository-url]
  2. 安装依赖: npm install

调试方式

  1. 运行测试脚本验证服务功能: ./bin/test-service.sh [service-name]
  2. 使用示例客户端代码进行测试:参考 examples/client_example.ts 文件。

许可证

该项目遵循 MIT 开源许可条款,请参阅 MIT 了解完整条款。