MCP Rest Api

🚀 MCP REST API テストツール

MCP REST API テストツールは、RESTful API をテストするための強力なツールです。複数の HTTP メソッドをサポートし、詳細なレスポンス情報と柔軟な設定オプションを提供します。

🚀 クイックスタート

MCP REST API テストツールを使うことで、RESTful API のテストが簡単に行えます。以下のセクションでは、インストール方法、設定方法、機能の特徴、使用例などを説明します。

✨ 主な機能

1. 複数の HTTP メソッドをサポート：GET、POST、PUT、DELETE が使用可能です。
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 認証（上記の2つの認証方法が設定されていない場合）
  "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 ファイルを参照してください。