Webapi MCP Server

🚀 WebAPI 轉換為 MCP 工具

本工具可幫助您將 WebAPI 轉換為 MCP，通過簡單配置即可註冊和管理各類 Web API，並以統一方式調用，極大提升開發效率。

🚀 快速開始

要使用此工具，請先安裝 npm 包：

npm install webapi-mcp-server

✨ 主要特性

這是一個用於將 Web API 轉換為 MCP 工具的模塊。它允許您通過簡單的配置註冊和管理各種 Web API，並以統一的方式進行調用。

📦 安裝指南

要使用此工具，請先安裝 npm 包：

npm install webapi-mcp-server

💻 使用示例

基礎用法

創建服務器

使用 webapi.createServer 函數創建一個自定義服務器：

const webapi = require('webapi-mcp-server');

// 創建基本服務器
const server = webapi.createServer({
  debug: true, // 啟用調試模式
  configFile: './config.json', // 配置文件路徑
  apisDir: './apis' // API 定義目錄
});

// 開始監聽
server.listen(3000);

註冊 API

您可以使用 registerApi 方法註冊單個 API：

webapi.registerApi({
  name: 'weather', // 唯一名稱
  description: '獲取天氣信息', // 描述
  url: 'https://api.example.com/weather', // 請求 URL
  method: 'GET' // HTTP 方法
});

使用參數

在 API 定義中，可以包含請求參數：

webapi.registerApi({
  name: 'weather',
  parameters: {
    city: {
      type: 'string',
      required: true,
      description: '城市名稱'
    },
    units: {
      type: 'string',
      required: false,
      description: '溫度單位 (celsius, fahrenheit)'
    }
  }
});

處理響應

通過 resultPath 字段指定如何提取結果：

webapi.registerApi({
  name: 'weather',
  resultPath: 'data.current' // 結果路徑，如 "data.items"
});

請求頭配置

在 API 定義中添加請求頭信息：

webapi.registerApi({
  name: 'news',
  headers: {
    'X-API-Key': 'your-key'
  }
});

JSON 格式定義示例

完整的 API 定義示例如下：

{
  "name": "weather",
  "description": "獲取天氣信息",
  "url": "https://api.example.com/weather",
  "method": "GET",
  "parameters": {
    "city": {
      "type": "string",
      "required": true,
      "description": "城市名稱"
    }
  },
  "headers": {
    "X-API-Key": "your-key"
  },
  "resultPath": "data.current"
}

Markdown 格式定義示例

完整的 API 定義也可以使用 Markdown 格式：

# Weather API

獲取天氣信息

## URL
https://api.example.com/weather

## 方法
GET

## 參數
- city (string, required): 城市名稱

## 請求頭
- X-API-Key: your-key

## 結果路徑
data.current

調用 API

調用 API 的示例：

const result = await webapi.call('weather', {
  city: 'London'
});
console.log(result);

高級用法

導出模塊

可以通過導出函數來擴展功能：

module.exports = {
  customFunction: function() {}
};

📚 詳細文檔

• 詳細文檔
• 示例項目

📄 許可證

此項目遵循 MIT 許可證。