MCP Rest Api

🚀 MCP REST API Testing Tool

The MCP REST API Testing Tool is a powerful utility designed for testing RESTful APIs. It supports multiple HTTP methods, offers detailed response information, and provides flexible configuration options.

🚀 Quick Start

The MCP REST API Testing Tool simplifies the process of testing RESTful APIs. With support for various HTTP methods and detailed response insights, it's an essential tool for API developers and testers.

✨ Features

1. Multiple HTTP Method Support: GET, POST, PUT, and DELETE.
2. Detailed Response Information: Includes status codes, headers, and body content.
3. Custom Headers:
   • Configure global headers via HEADER_* environment variables.
   • Header names are case - insensitive (HEADER_, header_, HeAdEr_).
   • Applied in order of priority: request headers > authentication headers > custom headers.
4. Request Body Handling: Supports body data for POST and PUT methods.
5. Response Size Management:
   • Default limit is 10KB (10000 bytes).
   • Configurable via the REST_RESPONSE_SIZE_LIMIT environment variable.
   • Over - limit responses are truncated while maintaining structure.
6. SSL Certificate Verification:
   • Enabled by default for security.
   • Can be disabled to support self - signed certificates or development environments.
7. Multiple Authentication Methods:
   • Basic authentication (username/password).
   • Bearer Token authentication.
   • API Key authentication (custom header).

📦 Installation

Installation via Smithery

Use the following command to install:

mcp install dkmaker/mcp-rest-api

Manual Installation

1. Clone the repository:

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

2. Install dependencies:

npm install

3. Build the project:

npm run build

4. Use automatic rebuild during development:

npm run watch

📚 Documentation

Configuration of Cline Custom Commands

Add the following configuration to the package.json file:

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

Environment Variable Configuration

Add the following environment variables to the config.json file:

{
  "REST_BASE_URL": "https://api.example.com",
  // Basic authentication (username/password)
  "AUTH_BASIC_USERNAME": "your-username",
  "AUTH_BASIC_PASSWORD": "your-password",
  // Bearer Token authentication (if basic authentication is not configured)
  "AUTH_BEAKER": "your-token",
  // API Key authentication (if neither of the above authentication methods is configured)
  "AUTH_APIKEY_HEADER_NAME": "X-API-Key",
  "AUTH_APIKEY_VALUE": "your-api-key",
  // SSL certificate verification control
  "REST_ENABLE_SSL_VERIFY": false,
  // Custom headers (global headers)
  "HEADER_X-API-Version": "2.0",
  "HEADER_Custom-Client": "my-client",
  "HEADER_Accept": "application/json"
}

💻 Usage Examples

Testing a GET Endpoint

use_mcp_tool('rest-api', 'test_request', {
  "method": "GET",
  "endpoint": "/users"
});

Testing a POST Endpoint (with Body)

use_mcp_tool('rest-api', 'test_request', {
  "method": "POST",
  "endpoint": "/users",
  "body": {
    "name": "John Doe",
    "email": "john@example.com"
  }
});

Testing Custom Headers

use_mcp_tool('rest-api', 'test_request', {
  "method": "GET",
  "endpoint": "/products"
});

📄 License

This project is licensed under the MIT License. Please refer to the LICENSE file for details.