Automcp

🚀 AutoMCP

AutoMCP 是一款強大的代碼生成器，它能夠基於 YAML 服務定義，為 模型上下文協議 自動生成服務器和客戶端代碼。目前該項目仍在持續開發中，倉庫裡包含一些臨時文件，這些文件會在最終版本打包為 npm、pypl 等之前被移除。你可以參考 MCP Agent 瞭解如何在代理工作流中使用此工具。

🚀 快速開始

先決條件

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

安裝

1. 克隆此倉庫
2. 安裝依賴：

npm install

使用方法

定義服務

在 services/[服務名稱]/ 目錄下創建一個 YAML 文件，結構如下：

service:
  name: ServiceName
  version: 1.0.0
  description: 描述你的服務

tools:
  - name: toolName
    description: 描述工具的作用
    parameters:
      - name: paramName
        type: string
        description: 參數描述
    returns:
      type: string
      description: 返回值的描述

生成代碼

運行生成器腳本：

./bin/automcp.sh generate

這將執行以下操作：

1. 在 generated/[服務名稱]/[服務名稱]_server.ts 創建服務器代碼
2. 在 generated/[服務名稱]/[服務名稱]_client.ts 創建客戶端代碼
3. 在 src/custom/[服務名稱]/[tool-name]Handlers.ts 創建處理程序存根

實現處理程序

編輯生成的處理程序文件，位於 src/custom/[服務名稱]/，以實現你的工具功能。

使用生成的客戶端

import { ServiceNameClient } from "./generated/service-name/service_name_client.js";

async function main() {
  const client = new ServiceNameClient();

  try {
    await client.connect();

    // 調用一個工具
    const result = await client.toolName({ paramName: "value" });
    console.log(result);
  } finally {
    await client.disconnect();
  }
}

main().catch(console.error);

✨ 主要特性

• 自動生成兼容 MCP 的服務器代碼
• 生成易於服務消費的客戶端庫
• 創建實現工具功能的處理程序存根
• 按照服務組織代碼，每個服務都有獨立目錄

💻 使用示例

基礎用法

import { ServiceNameClient } from "./generated/service-name/service_name_client.js";

async function main() {
  const client = new ServiceNameClient();

  try {
    await client.connect();

    // 調用一個工具
    const result = await client.toolName({ paramName: "value" });
    console.log(result);
  } finally {
    await client.disconnect();
  }
}

main().catch(console.error);

高級用法

你可以查看 examples/client_example.ts 文件以獲取使用生成客戶端的完整示例。

📦 安裝指南

先決條件

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

安裝步驟

1. 克隆此倉庫
2. 安裝依賴：

npm install

📚 詳細文檔

測試

使用測試腳本來驗證服務功能：

./bin/test-service.sh [service-name]

臨時目錄結構（將改進以便於打包）

.
├── bin/                    # 腳本
├── examples/               # 使用示例
├── generated/              # 生成代碼
│   ├── service-name/       # 服務特定生成代碼
│   │   ├── service_name_server.ts
│   │   └── service_name_client.ts
├── services/               # 服務定義
│   └── service-name/       # 服務名稱
│       └── service.yaml    # 服務 YAML 文件
└── src/
    └── custom/[服務名稱]/ # 自定義處理程序

未來計劃

• 支持更多服務定義格式（如 JSON、XML）
• 增加對不同語言客戶端生成的支持（如 Python、Java）
• 實現更復雜的工具參數驗證和錯誤處理
• 提供圖形化界面以便於配置和服務管理

📄 許可證

此項目使用 MIT 許可證，允許自由使用、修改和分發。請查看 LICENSE 文件以獲取詳細信息。