返回市场
API-MCP

API-MCP

作者:suhuail53 星标更新:2025-07-08

项目介绍

Universal MCP 工具

一个通用的 MCP 工具,可以轻松地将 Web API 接口转换为 MCP 工具供AI助手使用。

特性

  • 通过简单配置快速将API转换为MCP工具
  • 支持GET和POST请求方法
  • 用户友好的可视化界面
  • 支持动态添加、删除和修改API配置
  • 实时查看和编辑API描述及参数格式
  • API测试功能:提前验证请求和响应以确保API可用性
  • API密钥管理:支持多种密钥认证方式,AI助手可自动使用密钥调用API

安装要求

python 3.13
requests>=2.31.0
beautifulsoup4>=4.12.3
websockets>=12.0
python-dotenv>=1.0.0
fastmcp>=0.1.0

快速开始

  1. 安装依赖
pip install -r requirements.txt
  1. 启动应用
python 启动_universal_mcp.py

用户指南

基本配置

  1. 在“基本配置”标签页中设置MCP端点
  2. 点击“保存配置”按钮保存设置

API管理

  1. 在“API管理”标签页中,您可以添加、删除和修改API配置

  2. 添加API时需要提供以下信息:

    • API名称:将成为MCP工具的名称
    • API URL:API的完整URL地址
    • 请求方法:GET或POST
    • API描述:API功能的简要描述
    • API密钥:授权API可以设置密钥
    • 密钥位置:header、query或body,指定密钥放置的位置
    • 密钥参数名:密钥的参数名,如“Authorization”、“api_key”等
    • 请求参数格式:JSON格式的请求参数描述
    • 返回参数格式:JSON格式的返回参数描述
  3. 添加后点击“保存API”按钮

API密钥管理

  1. 对于需要密钥的API,在添加时可以直接填写“API密钥”字段
  2. 密钥位置可以选择:
    • 将密钥添加到HTTP请求头(例如Authorization头)
    • 将密钥添加到URL查询参数(例如?api_key=xxx)
    • 将密钥添加到请求体(适用于POST请求)
  3. 根据API需求填写密钥参数名,如“Authorization”、“api_key”、“token”等
  4. 系统会自动处理密钥的添加,AI助手在调用API时无需知道密钥内容

API测试

  1. 选择已添加的API并点击“测试API”按钮
  2. 在弹出的测试窗口中填写API请求参数
  3. 点击“发送请求”按钮进行API测试
  4. 查看API响应结果及格式验证
    • 系统会自动验证响应是否符合预期格式
    • 如果有字段缺失,将显示警告信息

启动服务

  1. 在“日志”标签页中,点击“启动服务”按钮启动MCP服务
  2. 服务启动后将在后台运行,并可与AI助手集成

API配置示例

天气查询API

{
  "api_name": "查询天气",
  "api_url": "https://api.example.com/weather",
  "method": "GET",
  "request_format": {
    "city": "string",
    "days": "number"
  },
  "response_format": {
    "temperature": "number",
    "weather": "string",
    "humidity": "number"
  },
  "description": "根据城市名称查询天气预报"
}

需要API密钥的翻译API

{
  "api_name": "翻译文本",
  "api_url": "https://api.example.com/translate",
  "method": "POST",
  "api_key": "your-api-key-here",
  "key_location": "header",
  "key_name": "Authorization",
  "request_format": {
    "text": "string",
    "source": "string",
    "target": "string"
  },
  "response_format": {
    "translated": "string",
    "status": "number"
  },
  "description": "将文本从源语言翻译为目标语言"
}

高级用法

  1. 直接API注册:MCP服务本身提供了register_api工具可以直接调用AI助手注册新的API
  2. 查看已注册API:可以通过list_registered_apis工具查看所有已注册的API
  3. 删除已注册API:可以通过remove_registered_api工具删除指定的API
  4. 带密钥API调用:AI助手可以直接调用带密钥的API而无需知道密钥内容

注意事项

  1. API配置保存在api_configs.json文件中
  2. 基本配置保存在~/.xiaozhi_mcp_config.json文件中
  3. 确保您使用的API端点允许跨域请求
  4. API功能测试中的参数类型会自动转换,如数值类型、布尔类型等
  5. API密钥将保存在配置文件中,请确保配置文件的安全性