MCP REST API

Name: MCP REST API
Author: dkmaker

作者：dkmaker79 星标更新：2025-07-11

安装使用来源：spider==github.com

项目介绍

MCP REST API 测试器

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

安装

通过Smithery安装

要通过Smithery自动安装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、PATCH方法
- 处理身份验证（基本、Bearer、API密钥）
- 自动规范化端点
- 提供详细的响应信息
- 可配置SSL验证和响应限制

## 资源

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

- 示例：用法示例和常见模式
- 响应格式：响应结构和字段
- 配置：配置选项和设置指南

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

## 重要说明

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

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

虽然这些指令是针对Cline的，但该服务器应该可以与任何MCP实现一起工作。根据您的操作系统进行配置：

Windows

⚠️ 重要：由于Windows路径解析的一个已知问题（问题#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",
        // 基本认证
        "AUTH_BASIC_USERNAME": "您的用户名",
        "AUTH_BASIC_PASSWORD": "您的密码",
        // 或Bearer令牌
        "AUTH_BEARER": "您的令牌",
        // 或API密钥
        "AUTH_APIKEY_HEADER_NAME": "X-API-Key",
        "AUTH_APIKEY_VALUE": "您的API密钥",
        // SSL验证（默认启用）
        "REST_ENABLE_SSL_VERIFY": "false", // 设置为false以禁用自签名证书的SSL验证
        // 响应大小限制（可选，默认为10000字节）
        "REST_RESPONSE_SIZE_LIMIT": "10000", // 最大响应大小（字节）
        // 自定义头部（可选）
        "HEADER_X-API-Version": "2.0",
        "HEADER_Custom-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",
        // 基本认证
        "AUTH_BASIC_USERNAME": "您的用户名",
        "AUTH_BASIC_PASSWORD": "您的密码",
        // 或Bearer令牌
        "AUTH_BEARER": "您的令牌",
        // 或API密钥
        "AUTH_APIKEY_HEADER_NAME": "X-API-Key",
        "AUTH_APIKEY_VALUE": "您的API密钥",
        // SSL验证（默认启用）
        "REST_ENABLE_SSL_VERIFY": "false", // 设置为false以禁用自签名证书的SSL验证
        // 自定义头部（可选）
        "HEADER_X-API-Version": "2.0",
        "HEADER_Custom-Client": "我的客户端",
        "HEADER_Accept": "application/json"
      }
    }
  }
}

注意：替换环境变量的实际值。一次只配置一种认证方式：

基本认证（用户名/密码）
Bearer令牌认证（如果未配置基本认证）
API密钥认证（如果未配置基本认证或Bearer令牌）

特性

使用不同的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环境变量控制
多种认证方法：
- 基本认证（用户名/密码）
- Bearer令牌认证
- API密钥认证（自定义头部）

使用示例

一旦安装并配置好，您可以使用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文件。