MCP 服务器

mcp-rest-api

一个基于 TypeScript 的 MCP 服务器，它可以通过 Cline 来测试 REST API。这个工具允许你直接从你的开发环境中测试和交互任何 REST API 端点。

Tools

test_request

Test a REST API endpoint and get detailed response information. Base URL: https://api.example.org/v2 | SSL Verification enabled (see config resource for SSL settings) | Authentication: No authentication configured | No custom headers defined (see config resource for headers) | The tool automatically: - Normalizes endpoints (adds leading slash, removes trailing slashes) - Handles authentication header injection - Applies custom headers from HEADER_* environment variables - Accepts any HTTP status code as valid - Limits response size to 10000 bytes (see config resource for size limit settings) - Returns detailed response information including: * Full URL called * Status code and text * Response headers * Response body * Request details (method, headers, body) * Response timing * Validation messages | Error Handling: - Network errors are caught and returned with descriptive messages - Invalid status codes are still returned with full response details - Authentication errors include the attempted auth method | See the config resource for all configuration options, including header configuration.

README

MCP REST API 测试工具

一个基于 TypeScript 的 MCP 服务器，可以通过 Cline 测试 REST API。此工具允许您直接从开发环境测试和交互任何 REST API 端点。

安装

通过 Smithery 安装

要通过 Smithery 为 Claude Desktop 自动安装 REST API 测试工具：

npx -y @smithery/cli install dkmaker-mcp-rest-api --client claude

手动安装

全局安装包：

npm install -g dkmaker-mcp-rest-api

配置 Cline 自定义指令：

为了确保 Cline 了解如何有效地使用此工具，请将以下内容添加到您的 Cline 自定义指令（设置 > 自定义指令）：

# REST API 测试指令

`test_request` 工具可以测试、调试和交互 REST API 端点。该工具提供全面的请求/响应信息，并自动处理身份验证。

## 何时使用

- 测试特定的 API 端点
- 调试 API 响应
- 验证 API 功能
- 检查响应时间
- 验证请求/响应格式
- 测试本地开发服务器
- 测试 API 序列
- 验证错误处理

## 主要特性

- 支持 GET、POST、PUT、DELETE 方法
- 处理身份验证（Basic、Bearer、API Key）
- 自动规范化端点
- 提供详细的响应信息
- 可配置的 SSL 验证和响应限制

## 资源

以下资源提供详细的文档：

- examples: 使用示例和常见模式
- response-format: 响应结构和字段
- config: 配置选项和设置指南

访问这些资源以了解用法、响应格式和配置选项。

## 重要提示

- 审查 API 实现以了解预期行为
- 适当处理敏感数据
- 考虑速率限制和 API 约束
- 配置更改后重启服务器

将服务器添加到您的 MCP 配置：

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

Windows

⚠️ 重要提示: 由于 Windows 路径解析存在已知问题 (issue #40)，您必须使用完整路径而不是 %APPDATA%。

添加到 C:\Users\<您的用户名>\AppData\Roaming\Code\User\globalStorage\saoudrizwan.claude-dev\settings\cline_mcp_settings.json:

{
  "mcpServers": {
    "rest-api": {
      "command": "node",
      "args": [
        "C:/Users/<您的用户名>/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", // 设置为 false 以禁用自签名证书的 SSL 验证
        // Response Size Limit (optional, defaults to 10000 bytes)
        "REST_RESPONSE_SIZE_LIMIT": "10000", // 响应的最大大小（以字节为单位）
        // 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", // 设置为 false 以禁用自签名证书的 SSL 验证
        // Custom Headers (optional)
        "HEADER_X-API-Version": "2.0",
        "HEADER_Custom-Client": "my-client",
        "HEADER_Accept": "application/json"
      }
    }
  }
}

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

Basic Authentication (用户名/密码)
Bearer Token (如果未配置 Basic Auth)
API Key (如果未配置 Basic Auth 和 Bearer Token)

特性

使用不同的 HTTP 方法测试 REST API 端点
支持 GET、POST、PUT 和 DELETE 请求
详细的响应信息，包括状态、标头和正文
自定义标头：
- 通过 HEADER_* 环境变量设置全局标头
- 不区分大小写的前缀 (HEADER_, header_, HeAdEr_)
- 保留标头名称的大小写
- 基于优先级的应用（每个请求 > 身份验证 > 自定义）
处理 POST/PUT 方法的请求正文
响应大小管理：
- 自动响应大小限制（默认：10KB/10000 字节）
- 可通过 REST_RESPONSE_SIZE_LIMIT 环境变量配置大小限制
- 当响应超过限制时，清除截断元数据
- 在仅截断正文内容的同时保留响应结构
SSL 证书验证：
- 默认启用以确保安全操作
- 可以为自签名证书或开发环境禁用
- 通过 REST_ENABLE_SSL_VERIFY 环境变量控制
多种身份验证方法：
- Basic Authentication (用户名/密码)
- Bearer Token Authentication
- API Key Authentication (自定义标头)

使用示例

安装和配置完成后，您可以使用 Cline 通过 REST API 测试工具来测试您的 API 端点：

// 测试 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",
  "headers": {
    "Accept-Language": "en-US",
    "X-Custom-Header": "custom-value"
  }
});

开发

克隆存储库：

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

安装依赖项：

npm install

构建项目：

npm run build

对于具有自动重建功能的开发：

npm run watch

许可证

该项目已获得 MIT 许可证的许可 - 有关详细信息，请参阅 LICENSE 文件。