Probador de API REST de MCP

Un servidor MCP basado en TypeScript que permite probar APIs REST a través de Cline. Esta herramienta permite probar e interactuar con cualquier punto final de API REST directamente desde el entorno de desarrollo.

Instalación

Instalación mediante herrería

Para instalar REST API Tester para Claude Desktop automáticamente a través de Smithery :

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

Instalación manual

Instalar el paquete globalmente:

npm install -g dkmaker-mcp-rest-api

Instrucciones personalizadas para configurar Cline:

Para garantizar que Cline comprenda cómo usar esta herramienta de manera eficaz, agregue lo siguiente a sus instrucciones personalizadas de Cline (Configuración > Instrucciones personalizadas):

# 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 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

Agregue el servidor a su configuración de MCP:

Aunque estas instrucciones son para Cline, el servidor debería funcionar con cualquier implementación de MCP. Configure según su sistema operativo:

Ventanas

⚠️ IMPORTANTE : Debido a un problema conocido con la resolución de rutas de Windows ( problema n.° 40 ), debe utilizar la ruta completa en lugar de %APPDATA%.

Agregar a C:\Users\<YourUsername>\AppData\Roaming\Code\User\globalStorage\saoudrizwan.claude-dev\settings\cline_mcp_settings.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

Agregar a ~/Library/Application Support/Code/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.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"
      }
    }
  }
}

Nota: Reemplace las variables de entorno con sus valores reales. Configure solo un método de autenticación a la vez.

Autenticación básica (nombre de usuario/contraseña)
Token de portador (si la autenticación básica no está configurada)
Clave API (si no se configura ni la autenticación básica ni el token de portador)

Características

Pruebe los puntos finales de la API REST con diferentes métodos HTTP
Compatibilidad con solicitudes GET, POST, PUT y DELETE
Información de respuesta detallada, incluido el estado, los encabezados y el cuerpo.
Encabezados personalizados:
- Encabezados globales a través de variables de entorno HEADER_*
- Prefijo que no distingue entre mayúsculas y minúsculas (HEADER_, header_, HeAdEr_)
- Conservación de mayúsculas y minúsculas para los nombres de encabezado
- Aplicación basada en prioridad (por solicitud > autorización > personalizada)
Manejo del cuerpo de la solicitud para los métodos POST/PUT
Gestión del tamaño de la respuesta:
- Limitación automática del tamaño de respuesta (predeterminado: 10 KB/10 000 bytes)
- Límite de tamaño configurable mediante la variable de entorno REST_RESPONSE_SIZE_LIMIT
- Borrar metadatos de truncamiento cuando las respuestas exceden el límite
- Conserva la estructura de la respuesta mientras solo trunca el contenido del cuerpo
Verificación del certificado SSL:
- Habilitado de forma predeterminada para una operación segura
- Se puede deshabilitar para certificados autofirmados o entornos de desarrollo.
- Control mediante la variable de entorno REST_ENABLE_SSL_VERIFY
Múltiples métodos de autenticación:
- Autenticación básica (nombre de usuario/contraseña)
- Autenticación de token de portador
- Autenticación de clave API (encabezado personalizado)

Ejemplos de uso

Una vez instalado y configurado, puede utilizar el REST API Tester a través de Cline para probar sus puntos finales de API:

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

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

// Test with custom headers
use_mcp_tool('rest-api', 'test_request', {
  "method": "GET",
  "endpoint": "/products",
  "headers": {
    "Accept-Language": "en-US",
    "X-Custom-Header": "custom-value"
  }
});

Desarrollo

Clonar el repositorio:

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

Instalar dependencias:

npm install

Construir el proyecto:

npm run build

Para desarrollo con reconstrucción automática:

npm run watch

Licencia

Este proyecto está licenciado bajo la licencia MIT: consulte el archivo de LICENCIA para obtener más detalles.

mcp-rest-api