使用说明

项目简介

dkmaker_mcp-rest-api 是一个 MCP (Model Context Protocol) 服务器，它实现了一个名为 'test_request' 的工具，用于测试和调试 RESTful API。通过这个服务器，LLM 应用（如 Cline）可以调用 'test_request' 工具，发送 HTTP 请求到指定的 REST API 端点，并获取详细的响应信息，包括状态码、响应头、响应体等。该服务器支持多种身份验证方式，并允许配置 SSL 证书验证和响应大小限制。

主要功能点

REST API 测试工具: 提供 'test_request' 工具，支持 GET, POST, PUT, DELETE 等 HTTP 方法，用于测试 REST API 端点。
详细的响应信息: 返回全面的 API 响应数据，包括请求 URL、方法、请求头、请求体、响应状态码、状态文本、响应头、响应体和响应时间。
多种身份验证: 支持 Basic Auth, Bearer Token 和 API Key 等多种身份验证方式。
可配置的 SSL 验证: 允许启用或禁用 SSL 证书验证，方便测试自签名证书或开发环境的 API。
响应大小限制: 可以配置响应体的大小限制，防止返回过大的响应数据。
资源文档: 提供关于使用示例、响应格式和配置选项的资源文档，方便用户查阅。

安装步骤

通过 Smithery 安装 (推荐 Claude Desktop 用户)

确保已安装 Smithery CLI。

运行以下命令，即可自动安装 'dkmaker-mcp-rest-api' 到 Claude Desktop：

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

手动安装

全局安装 npm 包:

npm install -g dkmaker-mcp-rest-api

配置 MCP 客户端: 根据你使用的 MCP 客户端，配置 MCP 服务器连接。以 Cline 为例，需要修改 Cline 的 MCP 配置文件 'cline_mcp_settings.json'。

服务器配置 (Cline 客户端配置示例)

以下是在 Cline 客户端中配置 'dkmaker_mcp-rest-api' 服务器的示例配置，你需要将这段 JSON 配置添加到 Cline 的 'cline_mcp_settings.json' 文件中。

Windows 操作系统:

{
  "mcpServers": {
    "rest-api": { # 服务器名称，可以自定义
      "command": "node", # 启动服务器的命令
      "args": [ # 启动服务器的参数
        "C:/Users/<YourUsername>/AppData/Roaming/npm/node_modules/dkmaker-mcp-rest-api/build/index.js" # dkmaker_mcp-rest-api 的执行文件路径，请替换为你的实际用户目录
      ],
      "env": { # 环境变量配置
        "REST_BASE_URL": "https://api.example.com", # 你的 REST API 基础 URL，例如：https://your-api-domain.com
        // 身份验证配置 (选择一种配置即可)
        // Basic Auth
        // "AUTH_BASIC_USERNAME": "your-username",
        // "AUTH_BASIC_PASSWORD": "your-password",
        // Bearer Token
        // "AUTH_BEARER": "your-token",
        // API Key
        // "AUTH_APIKEY_HEADER_NAME": "X-API-Key",
        // "AUTH_APIKEY_VALUE": "your-api-key",
        // SSL 验证配置 (默认启用)
        // "REST_ENABLE_SSL_VERIFY": "false", // 设置为 false 以禁用 SSL 验证 (例如用于自签名证书)
        // 响应大小限制配置 (可选，默认 10000 字节)
        // "REST_RESPONSE_SIZE_LIMIT": "10000" // 最大响应大小，单位字节
      }
    }
  }
}

macOS 操作系统:

{
  "mcpServers": {
    "rest-api": { # 服务器名称，可以自定义
      "command": "npx", # 启动服务器的命令
      "args": [ # 启动服务器的参数
        "-y",
        "dkmaker-mcp-rest-api" # 使用 npx 启动 dkmaker-mcp-rest-api
      ],
      "env": { # 环境变量配置
        "REST_BASE_URL": "https://api.example.com", # 你的 REST API 基础 URL，例如：https://your-api-domain.com
        // 身份验证配置 (选择一种配置即可)
        // Basic Auth
        // "AUTH_BASIC_USERNAME": "your-username",
        // "AUTH_BASIC_PASSWORD": "your-password",
        // Bearer Token
        // "AUTH_BEARER": "your-token",
        // API Key
        // "AUTH_APIKEY_HEADER_NAME": "X-API-Key",
        // "AUTH_APIKEY_VALUE": "your-api-key",
        // SSL 验证配置 (默认启用)
        // "REST_ENABLE_SSL_VERIFY": "false" // 设置为 false 以禁用 SSL 验证 (例如用于自签名证书)
      }
    }
  }
}

注意:

请根据你的操作系统选择相应的配置。
将 '<YourUsername>' 替换为你的 Windows 用户名。
将 'REST_BASE_URL' 替换为你要测试的 REST API 的基础 URL。
根据需要配置身份验证信息（Basic Auth, Bearer Token 或 API Key），只需要配置一种身份验证方式。
可以根据需要配置 'REST_ENABLE_SSL_VERIFY' 和 'REST_RESPONSE_SIZE_LIMIT' 环境变量。

基本使用方法

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

示例代码 (在 Cline 中使用):

// 测试 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": "John Doe",
    "email": "[email protected]"
  }
});

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

在 Cline 中执行上述代码，'test_request' 工具将会发送相应的 HTTP 请求到配置的 'REST_BASE_URL' 和 'endpoint'，并将详细的响应信息返回给 Cline。你可以在 Cline 的输出中查看 API 响应的详细内容。

关键词