MCP REST API Tester

MCP REST API 测试器

这是一个基于 TypeScript 的 MCP 服务，可通过 Claude、Cline 和其他 MCP 客户端测试 REST API。此工具可让你直接在开发环境中测试并与任何 REST API 端点交互。

安装

全局安装此软件包：

npm install -g dkmaker-mcp-rest-api

配置

Cline 自定义指令

为确保 Cline 能有效使用此工具，请将以下内容添加到 Cline 自定义指令中（Settings > Custom Instructions）：

# REST API Testing Instructions

The `test_request` tool enables testing, debugging, and interacting with REST API endpoints. The tool provides comprehensive request/response information and handles authentication automatically.

## When to Use

- Testing specific API endpoints
- Debugging API responses
- Verifying API functionality
- Checking response times
- Validating request/response formats
- Testing local development servers
- Testing API sequences
- Verifying error handling

## Key Features

- Supports GET, POST, PUT, DELETE, PATCH methods
- Handles authentication (Basic, Bearer, API Key)
- Normalizes endpoints automatically
- Provides detailed response information
- Configurable SSL verification and response limits

## Resources

The following resources provide detailed documentation:

- examples: Usage examples and common patterns
- response-format: Response structure and fields
- config: Configuration options and setup guide

Access these resources to understand usage, response formats, and configuration options.

## Important Notes

- Review API implementation for expected behavior
- Handle sensitive data appropriately
- Consider rate limits and API constraints
- Restart server after configuration changes

MCP 服务配置

虽然这些说明针对 Cline，但此服务应适用于任何 MCP 实现。请根据你的操作系统进行配置：

Windows

⚠️ 重要：由于 Windows 路径解析存在已知问题（issue #40），必须使用完整路径，而不是 %APPDATA%。

添加到 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",
        // Basic Auth
        "AUTH_BASIC_USERNAME": "your-username",
        "AUTH_BASIC_PASSWORD": "your-password",
        // OR Bearer Token
        "AUTH_BEARER": "your-token",
        // OR API Key
        "AUTH_APIKEY_HEADER_NAME": "X-API-Key",
        "AUTH_APIKEY_VALUE": "your-api-key",
        // SSL Verification (enabled by default)
        "REST_ENABLE_SSL_VERIFY": "false", // Set to false to disable SSL verification for self-signed certificates
        // Response Size Limit (optional, defaults to 10000 bytes)
        "REST_RESPONSE_SIZE_LIMIT": "10000", // Maximum response size in bytes
        // Custom Headers (optional)
        "HEADER_X-API-Version": "2.0",
        "HEADER_Custom-Client": "my-client",
        "HEADER_Accept": "application/json"
      }
    }
  }
}

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",
        // Basic Auth
        "AUTH_BASIC_USERNAME": "your-username",
        "AUTH_BASIC_PASSWORD": "your-password",
        // OR Bearer Token
        "AUTH_BEARER": "your-token",
        // OR API Key
        "AUTH_APIKEY_HEADER_NAME": "X-API-Key",
        "AUTH_APIKEY_VALUE": "your-api-key",
        // SSL Verification (enabled by default)
        "REST_ENABLE_SSL_VERIFY": "false", // Set to false to disable SSL verification for self-signed certificates
        // Custom Headers (optional)
        "HEADER_X-API-Version": "2.0",
        "HEADER_Custom-Client": "my-client",
        "HEADER_Accept": "application/json"
      }
    }
  }
}

注意：将环境变量替换为实际值。每次只能配置一种身份验证方式：

1. Basic Authentication（用户名/密码）
2. Bearer Token（未配置 Basic Auth 时）
3. API Key（未配置 Basic Auth 或 Bearer Token 时）

功能

• 使用不同的 HTTP 方法测试 REST API 端点

• 支持 GET、POST、PUT、DELETE 和 PATCH 请求

• 提供详细的响应信息，包括状态、标头和正文

• 自定义标头：

  • 通过 HEADER_* 环境变量设置全局标头
  • 前缀不区分大小写（HEADER_、header_、HeAdEr_）
  • 保留标头名称的大小写
  • 按优先级应用（单次请求 > 身份验证 > 自定义）

• 处理 POST/PUT 方法的请求正文

• 响应大小管理：

  • 自动限制响应大小（默认：10KB/10000 字节）
  • 通过 REST_RESPONSE_SIZE_LIMIT 环境变量配置大小限制
  • 响应超过限制时提供明确的截断元数据
  • 保留响应结构，仅截断正文内容

• SSL 证书验证：

  • 默认启用，确保安全运行
  • 可针对自签名证书或开发环境禁用
  • 通过 REST_ENABLE_SSL_VERIFY 环境变量控制

• 多种身份验证方式：

  • Basic Authentication（用户名/密码）
  • Bearer Token 身份验证
  • API Key 身份验证（自定义标头）

使用示例

安装并配置后，你可以通过 Cline 使用 REST API 测试器测试 API 端点：

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

// Test a POST endpoint with body
use_mcp_tool('rest-api', 'test_request', {
  "method": "POST",
  "endpoint": "/users",
  "body": {
    "name": "John Doe",
    "email": "[email protected]"
  }
});

// Test with custom headers
use_mcp_tool('rest-api', 'test_request', {
  "method": "GET",
  "endpoint": "/products",
  "headers": {
    "Accept-Language": "en-US",
    "X-Custom-Header": "custom-value"
  }
});

开发

1. 克隆代码库：

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

2. 安装依赖：

npm install

3. 构建项目：

npm run build

使用自动重新构建进行开发：

npm run watch

许可证

本项目采用 MIT 许可证授权，详情请参阅 LICENSE 文件。