Api2mcptools

🚀 @terryliyongjie/api2mcptools

這是一個 Node.js 包，可將 API 轉換為 MCP（模型上下文協議）工具，助力開發者在相關場景中更高效地使用 API。

中文文檔

• CherryStudio 示例 CherryStudio

🚀 快速開始

此工具可幫助你將 API 轉換為 MCP 工具，以下是使用前的安裝與配置步驟。

📦 安裝指南

選項 1：使用 npx 快速開始（推薦）

set CONFIG_JSON_PATH=example.json
npx @terryliyongjie/api2mcptools

選項 2：傳統安裝

# 在項目中本地安裝
npm install @terryliyongjie/mcp-tools

# 或全局安裝以作為 CLI 工具使用
npm install -g @terryliyongjie/mcp-tools

📚 詳細文檔

配置

環境變量

# 必填：配置 JSON 文件的路徑
CONFIG_JSON_PATH=example.json

示例配置文件（example.json）：

// 單個工具配置
{
    "name": "tool_name",
    "description": "工具描述",
    "inputSchema": {
        "type": "object",
        "properties": {
            "param1": {
                "type": "string",
                "description": "參數描述"
            }
        },
        "required": ["param1"]
    },
    "axiosConfig": {
        "url": "https://api.example.com/endpoint",
        "method": "get",
        "params": {
            "key": "your_api_key"
        }
    }
}

// 或多個工具配置
[
    {
        "name": "baidu_place_search",
        "description": "使用百度地圖 API 進行地點檢索服務",
        "inputSchema": {
            "type": "object",
            "properties": {
                "query": {
                    "type": "string",
                    "description": "檢索關鍵字"
                },
                "region": {
                    "type": "string",
                    "description": "檢索行政區劃區域"
                }
            },
            "required": ["query", "region"]
        },
        "axiosConfig": {
            "url": "https://api.map.baidu.com/place/v2/search",
            "method": "get",
            "params": {
                "ak": "your_baidu_map_key"
            }
        }
    },
    // 更多工具...
]

功能

• 將 JSON API 轉換為 MCP 工具
• 與 MCP 生態系統輕鬆集成
• 支持多種 API 類型
• 命令行界面（CLI）支持

使用方法

作為 CLI 工具

全局安裝後，可以直接在終端中使用命令：

mcp-tools [options]

作為模塊

// 示例代碼即將發佈

開發

# 安裝依賴項
npm install

# 構建項目
npm run build

# 在開發模式下運行
npm run dev

# 開發期間監視文件變化
npm run watch

# 運行 MCP 檢查器
npm run inspector

📄 許可證

MIT