REST API Tester MCP服务器使用说明

项目简介

REST API Tester MCP服务器是一个基于Model Context Protocol (MCP) 的后端服务，旨在为LLM客户端提供测试和调试RESTful API接口的能力。它通过注册名为 'test_request' 的工具，允许LLM客户端发送各种HTTP请求（GET, POST, PUT, DELETE），并返回详细的API响应信息，帮助开发者在LLM应用中集成和验证外部API。

主要功能点

REST API 测试: 支持测试各种RESTful API端点，包括GET、POST、PUT和DELETE等HTTP方法。
详细响应信息: 返回全面的API响应，包括状态码、状态文本、响应头、响应体以及请求耗时。
多种认证方式: 支持Basic Auth, Bearer Token和API Key等多种API认证方式，通过环境变量配置。
自定义请求头: 允许通过环境变量或在工具调用时设置自定义请求头。
响应大小限制: 可以配置响应体的大小限制，避免返回过大的响应数据。
SSL证书验证: 支持SSL证书验证，并允许禁用以测试自签名证书的API。
错误处理: 详细返回请求错误信息，方便调试API集成问题。

安装步骤

安装Node.js和npm: 确保你的系统已安装Node.js和npm（Node包管理器）。
全局安装npm包: 打开终端或命令提示符，运行以下命令全局安装 'dkmaker-mcp-rest-api' 包：
```
npm install -g dkmaker-mcp-rest-api
```

服务器配置

为了让MCP客户端（如Cline）能够连接到REST API Tester MCP服务器，你需要在客户端的MCP服务器配置文件中添加以下配置信息。

重要提示: 请根据你的操作系统选择正确的配置，并替换占位符为你实际的环境变量值。

macOS 配置示例 ( '~/Library/Application Support/Code/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json' )

{
  "mcpServers": {
    "rest-api": {
      "command": "npx",
      "args": [
        "-y",
        "dkmaker-mcp-rest-api"
      ],
      "env": {
        "REST_BASE_URL": "https://api.example.com",  // 你的API基础URL，例如：https://your-api-domain.com
        // --- 认证配置 (选择一种配置) ---
        // Basic Authentication
        // "AUTH_BASIC_USERNAME": "your-username",
        // "AUTH_BASIC_PASSWORD": "your-password",
        // Bearer Token Authentication
        // "AUTH_BEARER": "your-token",
        // API Key Authentication (Header 方式)
        // "AUTH_APIKEY_HEADER_NAME": "X-API-Key",
        // "AUTH_APIKEY_VALUE": "your-api-key",

        // --- 可选配置 ---
        // 禁用SSL证书验证 (默认启用)
        // "REST_ENABLE_SSL_VERIFY": "false",
        // 响应大小限制 (默认 10000 字节)
        // "REST_RESPONSE_SIZE_LIMIT": "10000",
        // 自定义请求头 (可配置多个，例如 HEADER_X-API-Version)
        // "HEADER_X-API-Version": "2.0",
        // "HEADER_Custom-Client": "my-client",
        // "HEADER_Accept": "application/json"
      }
    }
  }
}

Windows 配置示例 ( 'C:\Users<YourUsername>\AppData\Roaming\Code\User\globalStorage\saoudrizwan.claude-dev\settings\cline_mcp_settings.json' )

{
  "mcpServers": {
    "rest-api": {
      "command": "node",
      "args": [
        "C:/Users/<YourUsername>/AppData/Roaming/npm/node_modules/dkmaker-mcp-rest-api/build/index.js" // 请替换为你的实际路径
      ],
      "env": {
        "REST_BASE_URL": "https://api.example.com",  // 你的API基础URL，例如：https://your-api-domain.com
        // --- 认证配置 (选择一种配置) ---
        // Basic Authentication
        // "AUTH_BASIC_USERNAME": "your-username",
        // "AUTH_BASIC_PASSWORD": "your-password",
        // Bearer Token Authentication
        // "AUTH_BEARER": "your-token",
        // API Key Authentication (Header 方式)
        // "AUTH_APIKEY_HEADER_NAME": "X-API-Key",
        // "AUTH_APIKEY_VALUE": "your-api-key",

        // --- 可选配置 ---
        // 禁用SSL证书验证 (默认启用)
        // "REST_ENABLE_SSL_VERIFY": "false",
        // 响应大小限制 (默认 10000 字节)
        // "REST_RESPONSE_SIZE_LIMIT": "10000",
        // 自定义请求头 (可配置多个，例如 HEADER_X-API-Version)
        // "HEADER_X-API-Version": "2.0",
        // "HEADER_Custom-Client": "my-client",
        // "HEADER_Accept": "application/json"
      }
    }
  }
}

配置说明:

'server name': 'rest-api' (可以自定义，客户端调用工具时使用)
'command': 服务器启动命令。macOS 使用 'npx'，Windows 使用 'node'。
'args': 启动命令的参数。macOS 使用 '[-y, dkmaker-mcp-rest-api]'，Windows 需要指定 'dkmaker-mcp-rest-api' 入口文件 'index.js' 的绝对路径。
'env': 环境变量配置，用于配置API的基础URL、认证信息、自定义请求头等。
- 'REST_BASE_URL': 必须配置，你的目标API的基础URL。
- 认证配置 ('AUTH_*'): 根据你的API认证方式选择配置其中一种。
  - Basic Auth: 配置 'AUTH_BASIC_USERNAME' 和 'AUTH_BASIC_PASSWORD'。
  - Bearer Token: 配置 'AUTH_BEARER'。
  - API Key: 配置 'AUTH_APIKEY_HEADER_NAME' (Header 名称) 和 'AUTH_APIKEY_VALUE' (API Key 值)。
- 可选配置:
  - 'REST_ENABLE_SSL_VERIFY': 设置为 '"false"' 禁用SSL证书验证 (用于测试自签名证书的API)。
  - 'REST_RESPONSE_SIZE_LIMIT': 设置响应大小限制，单位为字节。
  - 'HEADER_*': 设置自定义请求头，例如 'HEADER_X-API-Version: 2.0' 会添加 'X-API-Version: 2.0' 请求头。

基本使用方法

在MCP客户端（如Cline）中，你可以使用 'use_mcp_tool' 函数调用 'rest-api' 服务器的 'test_request' 工具来测试API。

示例代码 (Cline Custom Instructions):

// 测试 GET 请求
use_mcp_tool('rest-api', 'test_request', {
  "method": "GET",
  "endpoint": "/users" // 实际API路径，会拼接在 REST_BASE_URL 之后
});

// 测试 POST 请求，带请求体
use_mcp_tool('rest-api', 'test_request', {
  "method": "POST",
  "endpoint": "/users",
  "body": {
    "name": "New User",
    "email": "[email protected]"
  }
});

// 测试带有自定义请求头的请求
use_mcp_tool('rest-api', 'test_request', {
  "method": "GET",
  "endpoint": "/products",
  "headers": {
    "Accept-Language": "zh-CN",
    "X-Custom-Header": "test-value"
  }
});

使用说明:

使用 'use_mcp_tool('rest-api', 'test_request', ...)' 调用 'test_request' 工具。
'"method"': 指定HTTP方法 (GET, POST, PUT, DELETE)。
'"endpoint"': API端点路径，不要包含域名，只写路径部分，例如 '/users' 或 '/api/products'。服务器会自动将此路径拼接到 'REST_BASE_URL' 环境变量之后构成完整的请求URL。
'"body"' (可选): POST 或 PUT 请求的请求体，JSON格式。
'"headers"' (可选): 临时的自定义请求头，用于本次请求。敏感信息（如API Key）不建议在此处配置，请使用环境变量配置。

执行上述代码后，LLM客户端会调用REST API Tester MCP服务器，服务器会发送相应的HTTP请求到目标API，并将详细的响应信息返回给LLM客户端。

关键词