mcp-rest-api

by dkmaker

31 stars
1 downloads
Not rated
GitHub

About

A TypeScript-based MCP server that enables testing of REST APIs through Cline. This tool allows you to test and interact with any REST API endpoints directly from your development environment.

Details

Author
dkmaker
Repository
dkmaker/mcp-rest-api
GitHub stars
31
Downloads
1
License
MIT License
Categories
Developer Tools, Productivity

- Supports GET, POST, PUT, DELETE, PATCH methods
- Handles authentication (Basic, Bearer, API Key)
- Normalizes endpoints automatically
- Provides detailed response information
- Configurable SSL verification and response limits

Setting up with Highlight

Follow these steps to add this server as a custom Highlight plugin:

  1. Download and install Highlight from highlightai.com/download
  2. Navigate to the plugins tab and select "Add Custom Plugin"
  3. Configure the plugin with the settings below
    Plugin Name mcp-rest-api
    Command (node, npx, python, etc.) npx
    Arguments
    • Argument 1 -y
    • Argument 2 dkmaker-mcp-rest-api
    Environment
    • AUTH_BEARER your-token
    • HEADER_Accept application/json
    • REST_BASE_URL https://api.example.com
    • AUTH_APIKEY_VALUE your-api-key
    • AUTH_BASIC_PASSWORD your-password
    • AUTH_BASIC_USERNAME your-username
    • HEADER_Custom-Client my-client
    • HEADER_X-API-Version 2.0
    • REST_ENABLE_SSL_VERIFY false
    • AUTH_APIKEY_HEADER_NAME X-API-Key

    Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.

  4. Enable "Start Automatically" if you want the plugin to start when Highlight launches

From the repository

While these instructions are for Cline, the server should work with any MCP implementation. Configure based on your operating system:

test_request

Enables testing, debugging, and interacting with REST API endpoints. Parameters: method (string), endpoint (string), body (optional object), headers (optional object).

Claude Desktop / Cursor

Paste into your MCP client config file to install this server.

{
    "mcpServers": {
        "mcp-rest-api": {
            "env": {
                "AUTH_BEARER": "your-token",
                "HEADER_Accept": "application/json",
                "REST_BASE_URL": "https://api.example.com",
                "AUTH_APIKEY_VALUE": "your-api-key",
                "AUTH_BASIC_PASSWORD": "your-password",
                "AUTH_BASIC_USERNAME": "your-username",
                "HEADER_Custom-Client": "my-client",
                "HEADER_X-API-Version": "2.0",
                "REST_ENABLE_SSL_VERIFY": "false",
                "AUTH_APIKEY_HEADER_NAME": "X-API-Key"
            },
            "args": [
                "-y",
                "dkmaker-mcp-rest-api"
            ],
            "command": "npx"
        }
    }
}

Linux

{
    "env": [],
    "args": [
        "-y",
        "@highlight/mcp-server"
    ],
    "command": "npx"
}

Macos

{
    "env": {
        "AUTH_BEARER": "your-token",
        "HEADER_Accept": "application/json",
        "REST_BASE_URL": "https://api.example.com",
        "AUTH_APIKEY_VALUE": "your-api-key",
        "AUTH_BASIC_PASSWORD": "your-password",
        "AUTH_BASIC_USERNAME": "your-username",
        "HEADER_Custom-Client": "my-client",
        "HEADER_X-API-Version": "2.0",
        "REST_ENABLE_SSL_VERIFY": "false",
        "AUTH_APIKEY_HEADER_NAME": "X-API-Key"
    },
    "args": [
        "-y",
        "dkmaker-mcp-rest-api"
    ],
    "command": "npx"
}

Windows

{
    "env": {
        "AUTH_BEARER": "your-token",
        "HEADER_Accept": "application/json",
        "REST_BASE_URL": "https://api.example.com",
        "AUTH_APIKEY_VALUE": "your-api-key",
        "AUTH_BASIC_PASSWORD": "your-password",
        "AUTH_BASIC_USERNAME": "your-username",
        "HEADER_Custom-Client": "my-client",
        "HEADER_X-API-Version": "2.0",
        "REST_ENABLE_SSL_VERIFY": "false",
        "AUTH_APIKEY_HEADER_NAME": "X-API-Key",
        "REST_RESPONSE_SIZE_LIMIT": "10000"
    },
    "args": [
        "C:/Users/<YourUsername>/AppData/Roaming/npm/node_modules/dkmaker-mcp-rest-api/build/index.js"
    ],
    "command": "node"
}

MCP REST API Tester

License: MIT NPM Package A TypeScript-based MCP server that enables testing of REST APIs through Claude, Cline and other MCP clients. This tool allows you to test and interact with any REST API endpoints directly from your development environment. <a href="https://glama.ai/mcp/servers/izr2sp4rqo"> </a>

Installation

Install the package globally: ``bash npm install -g dkmaker-mcp-rest-api `

Configuration

Cline Custom Instructions

To ensure Cline understands how to effectively use this tool, add the following to your Cline custom instructions (Settings > Custom Instructions):
`markdown

REST API Testing Instructions

The
test_request tool enables testing, debugging, and interacting with REST API endpoints. The tool provides comprehensive request/response information and handles authentication automatically.

When to Use

- Testing specific API endpoints - Debugging API responses - Verifying API functionality - Checking response times - Validating request/response formats - Testing local development servers - Testing API sequences - Verifying error handling

Key Features

- Supports GET, POST, PUT, DELETE, PATCH methods - Handles authentication (Basic, Bearer, API Key) - Normalizes endpoints automatically - Provides detailed response information - Configurable SSL verification and response limits

Resources

The following resources provide detailed documentation: - examples: Usage examples and common patterns - response-format: Response structure and fields - config: Configuration options and setup guide Access these resources to understand usage, response formats, and configuration options.

Important Notes

- Review API implementation for expected behavior - Handle sensitive data appropriately - Consider rate limits and API constraints - Restart server after configuration changes
`

MCP Server Configuration

While these instructions are for Cline, the server should work with any MCP implementation. Configure based on your operating system:

Windows

⚠️ IMPORTANT: Due to a known issue with Windows path resolution (issue #40), you must use the full path instead of %APPDATA%. Add to
C:\Users\<YourUsername>\AppData\Roaming\Code\User\globalStorage\saoudrizwan.claude-dev\settings\cline_mcp_settings.json: `json { "mcpServers": { "rest-api": { "command": "node", "args": [ "C:/Users/<YourUsername>/AppData/Roaming/npm/node_modules/dkmaker-mcp-rest-api/build/index.js" ], "env": { "REST_BASE_URL": "https://api.example.com", // Basic Auth "AUTH_BASIC_USERNAME": "your-username", "AUTH_BASIC_PASSWORD": "your-password", // OR Bearer Token "AUTH_BEARER": "your-token", // OR API Key "AUTH_APIKEY_HEADER_NAME": "X-API-Key", "AUTH_APIKEY_VALUE": "your-api-key", // SSL Verification (enabled by default) "REST_ENABLE_SSL_VERIFY": "false", // Set to false to disable SSL verification for self-signed certificates // Response Size Limit (optional, defaults to 10000 bytes) "REST_RESPONSE_SIZE_LIMIT": "10000", // Maximum response size in bytes // Custom Headers (optional) "HEADER_X-API-Version": "2.0", "HEADER_Custom-Client": "my-client", "HEADER_Accept": "application/json" } } } } `

macOS

Add to
~/Library/Application Support/Code/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json: `json { "mcpServers": { "rest-api": { "command": "npx", "args": [ "-y", "dkmaker-mcp-rest-api" ], "env": { "REST_BASE_URL": "https://api.example.com", // Basic Auth "AUTH_BASIC_USERNAME": "your-username", "AUTH_BASIC_PASSWORD": "your-password", // OR Bearer Token "AUTH_BEARER": "your-token", // OR API Key "AUTH_APIKEY_HEADER_NAME": "X-API-Key", "AUTH_APIKEY_VALUE": "your-api-key", // SSL Verification (enabled by default) "REST_ENABLE_SSL_VERIFY": "false", // Set to false to disable SSL verification for self-signed certificates // Custom Headers (optional) "HEADER_X-API-Version": "2.0", "HEADER_Custom-Client": "my-client", "HEADER_Accept": "application/json" } } } } ``
No reviews yet — be the first

Sign in to leave a review

Use Google, GitHub, or an email account so ratings stay tied to real people.

Email sign in

No reviews posted yet.