JinDaGe - mcp-rest-api MCP Details

article

README

🚀 MCP REST API 测试工具

MCP REST API 测试工具是一款强大的 RESTful API 测试利器，支持多种 HTTP 方法，能提供详细的响应信息，还具备灵活的配置选项。

🚀 快速开始

MCP REST API 测试工具可助力你高效测试 RESTful API。你可按如下步骤完成安装与配置，开启测试之旅。

✨ 主要特性

支持多种 HTTP 方法：支持 GET、POST、PUT 和 DELETE 等常见 HTTP 方法。
详细的响应信息：响应信息详尽，涵盖状态码、头信息和正文内容。
自定义头文件：
- 可通过 HEADER_* 环境变量配置全局头。
- 头文件名称不区分大小写（HEADER_, header_, HeAdEr_）。
- 按优先级应用：请求头 > 认证头 > 自定义头。
处理请求正文：对 POST 和 PUT 方法的正文数据提供支持。
响应大小管理：
- 默认限制为 10KB（10000 字节）。
- 可通过 REST_RESPONSE_SIZE_LIMIT 环境变量进行配置。
- 超限响应会截断，但保留结构不变。
SSL 证书验证：
- 默认启用以确保安全。
- 可禁用以支持自签名证书或开发环境。
多种认证方式：支持基本认证（用户名/密码）、Bearer Token 认证和 API Key 认证（自定义头）。

📦 安装指南

通过 Smithery 安装

使用以下命令进行安装：

mcp install dkmaker/mcp-rest-api

手动安装

克隆仓库：

git clone https://github.com/zenturacp/mcp-rest-api.git
cd mcp-rest-api

安装依赖：

npm install

构建项目：

npm run build

开发时使用自动重建：

npm run watch

📚 详细文档

配置 Cline 自定义指令

在 package.json 文件中添加以下配置：

{
  "mcp": {
    "tools": {
      "rest-api": {
        "command": "dkmaker-mcp-rest-api",
        "args": {
          "--test-request": "{method},{endpoint},{headers},{body}"
        }
      }
    }
  }
}

环境变量配置

在 config.json 文件中添加以下环境变量：

{
  "REST_BASE_URL": "https://api.example.com",
  // 基本认证（用户名/密码）
  "AUTH_BASIC_USERNAME": "your-username",
  "AUTH_BASIC_PASSWORD": "your-password",
  // Bearer Token 认证（如果未配置基本认证）
  "AUTH_BEAKER": "your-token",
  // API Key 认证（如果未配置上述两种认证方式）
  "AUTH_APIKEY_HEADER_NAME": "X-API-Key",
  "AUTH_APIKEY_VALUE": "your-api-key",
  // SSL 证书验证控制
  "REST_ENABLE_SSL_VERIFY": false,
  // 自定义头文件（全局头）
  "HEADER_X-API-Version": "2.0",
  "HEADER_Custom-Client": "my-client",
  "HEADER_Accept": "application/json"
}

💻 使用示例

基础用法

测试 GET 端点

use_mcp_tool('rest-api', 'test_request', {
  "method": "GET",
  "endpoint": "/users"
});

测试 POST 端点（带正文）

use_mcp_tool('rest-api', 'test_request', {
  "method": "POST",
  "endpoint": "/users",
  "body": {
    "name": "John Doe",
    "email": "john@example.com"
  }
});

测试自定义头文件

use_mcp_tool('rest-api', 'test_request', {
  "method": "GET",
  "endpoint": "/products",

📄 许可证

此项目采用 MIT 许可证，具体内容请参见 LICENSE 文件。

mcp-rest-api