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 许可证。