MCP Rest Api

🚀 MCP REST API 測試工具

MCP REST API 測試工具是一款強大的 RESTful API 測試利器，支持多種 HTTP 方法，能提供詳細的響應信息，還具備靈活的配置選項。

🚀 快速開始

MCP REST API 測試工具可助力你高效測試 RESTful API。你可按如下步驟完成安裝與配置，開啟測試之旅。

✨ 主要特性

1. 支持多種 HTTP 方法：支持 GET、POST、PUT 和 DELETE 等常見 HTTP 方法。
2. 詳細的響應信息：響應信息詳盡，涵蓋狀態碼、頭信息和正文內容。
3. 自定義頭文件：
   • 可通過 HEADER_* 環境變量配置全局頭。
   • 頭文件名稱不區分大小寫（HEADER_, header_, HeAdEr_）。
   • 按優先級應用：請求頭 > 認證頭 > 自定義頭。
4. 處理請求正文：對 POST 和 PUT 方法的正文數據提供支持。
5. 響應大小管理：
   • 默認限制為 10KB（10000 字節）。
   • 可通過 REST_RESPONSE_SIZE_LIMIT 環境變量進行配置。
   • 超限響應會截斷，但保留結構不變。
6. SSL 證書驗證：
   • 默認啟用以確保安全。
   • 可禁用以支持自簽名證書或開發環境。
7. 多種認證方式：支持基本認證（用戶名/密碼）、Bearer Token 認證和 API Key 認證（自定義頭）。

📦 安裝指南

通過 Smithery 安裝

使用以下命令進行安裝：

mcp install dkmaker/mcp-rest-api

手動安裝

1. 克隆倉庫：

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

2. 安裝依賴：

npm install

3. 構建項目：

npm run build

4. 開發時使用自動重建：

npm run watch

📚 詳細文檔

配置 Cline 自定義指令

在 package.json 文件中添加以下配置：

{
  "mcp": {
    "tools": {
      "rest-api": {
        "command": "dkmaker-mcp-rest-api",
        "args": {
          "--test-request": "{method},{endpoint},{headers},{body}"
        }
      }
    }
  }
}

環境變量配置

在 config.json 文件中添加以下環境變量：

{
  "REST_BASE_URL": "https://api.example.com",
  // 基本認證（用戶名/密碼）
  "AUTH_BASIC_USERNAME": "your-username",
  "AUTH_BASIC_PASSWORD": "your-password",
  // Bearer Token 認證（如果未配置基本認證）
  "AUTH_BEAKER": "your-token",
  // API Key 認證（如果未配置上述兩種認證方式）
  "AUTH_APIKEY_HEADER_NAME": "X-API-Key",
  "AUTH_APIKEY_VALUE": "your-api-key",
  // SSL 證書驗證控制
  "REST_ENABLE_SSL_VERIFY": false,
  // 自定義頭文件（全局頭）
  "HEADER_X-API-Version": "2.0",
  "HEADER_Custom-Client": "my-client",
  "HEADER_Accept": "application/json"
}

💻 使用示例

基礎用法

測試 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",

📄 許可證

此項目採用 MIT 許可證，具體內容請參見 LICENSE 文件。