Skip to main content
Glama
dkmaker

mcp-rest-api

by dkmaker

MCP REST API 测试器

许可证:MIT NPM 包 铁匠徽章

基于 TypeScript 的 MCP 服务器,支持通过 Cline 测试 REST API。此工具允许您直接从开发环境测试并与任何 REST API 端点交互。

安装

通过 Smithery 安装

要通过Smithery自动为 Claude Desktop 安装 REST API Tester:

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

手动安装

  1. 全局安装包:

npm install -g dkmaker-mcp-rest-api
  1. 配置 Cline 自定义说明:

为了确保 Cline 了解如何有效地使用此工具,请将以下内容添加到您的 Cline 自定义说明中(设置 > 自定义说明):

# 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
  1. 将服务器添加到您的 MCP 配置:

虽然这些说明适用于 Cline,但服务器应该适用于任何 MCP 实现。请根据您的操作系统进行配置:

视窗

⚠️重要提示:由于 Windows 路径解析存在已知问题(问题 #40 ),您必须使用完整路径而不是 %APPDATA%。

添加到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

添加到~/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"
      }
    }
  }
}

注意:请将环境变量替换为您的实际值。一次只能配置一种身份验证方法:

  1. 基本身份验证(用户名/密码)

  2. 持有者令牌(如果未配置基本身份验证)

  3. API 密钥(如果未配置基本身份验证或承载令牌)

Related MCP server: Angular Bootstrap MCP Server

特征

  • 使用不同的 HTTP 方法测试 REST API 端点

  • 支持 GET、POST、PUT 和 DELETE 请求

  • 详细的响应信息,包括状态、标题和正文

  • 自定义标题:

    • 通过 HEADER_* 环境变量的全局标头

    • 不区分大小写的前缀(HEADER_、header_、HeAdEr_)

    • 标题名称的大小写保存

    • 基于优先级的应用程序(每个请求 > 授权 > 自定义)

  • POST/PUT 方法的请求主体处理

  • 响应大小管理:

    • 自动响应大小限制(默认值:10KB/10000 字节)

    • 可通过 REST_RESPONSE_SIZE_LIMIT 环境变量配置大小限制

    • 当响应超出限制时清除截断元数据

    • 保留响应结构,同时仅截断正文内容

  • SSL 证书验证:

    • 默认启用以确保安全操作

    • 可以针对自签名证书或开发环境禁用

    • 通过 REST_ENABLE_SSL_VERIFY 环境变量控制

  • 多种身份验证方法:

    • 基本身份验证(用户名/密码)

    • Bearer Token 身份验证

    • API 密钥认证(自定义标头)

使用示例

安装和配置完成后,您可以通过 Cline 使用 REST API 测试器来测试您的 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"
  }
});

发展

  1. 克隆存储库:

git clone https://github.com/zenturacp/mcp-rest-api.git
cd mcp-rest-api
  1. 安装依赖项:

npm install
  1. 构建项目:

npm run build

对于使用自动重建的开发:

npm run watch

执照

该项目根据 MIT 许可证获得许可 - 有关详细信息,请参阅LICENSE文件。

Available Tools

1 tool
test_requestA

Test a REST API endpoint and get detailed response information. Base URL: https://api.example.com | SSL Verification enabled (see config resource for SSL settings) | Authentication: No authentication configured | No custom headers defined (see config resource for headers) | The tool automatically: - Normalizes endpoints (adds leading slash, removes trailing slashes) - Handles authentication header injection - Applies custom headers from HEADER_* environment variables - Accepts any HTTP status code as valid - Limits response size to 10000 bytes (see config resource for size limit settings) - Returns detailed response information including: * Full URL called * Status code and text * Response headers * Response body * Request details (method, headers, body) * Response timing * Validation messages | Error Handling: - Network errors are caught and returned with descriptive messages - Invalid status codes are still returned with full response details - Authentication errors include the attempted auth method | See the config resource for all configuration options, including header configuration.

ParametersJSON Schema
NameRequiredDescriptionDefault
methodYesHTTP method to use
endpointYesEndpoint path (e.g. "/users"). Do not include full URLs - only the path. Example: "/api/users" will resolve to "https://api.example.com/api/users"
bodyNoOptional request body for POST/PUT requests
headersNoOptional request headers for one-time use. IMPORTANT: Do not use for sensitive data like API keys - those should be configured via environment variables. This parameter is intended for dynamic, non-sensitive headers that may be needed for specific requests.

TDQS

A4.7/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations, the description carries the full transparency burden. It fully discloses automatic endpoint normalization, auth injection, custom headers from env vars, response size limit, acceptance of any HTTP status, and detailed response fields. Error handling and authentication details are also covered.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is comprehensive but somewhat verbose, with repeated references to 'see config resource.' It front-loads the purpose effectively but could be condensed without losing meaning.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's complexity (4 parameters, no output schema), the description covers all essential aspects: base URL, SSL, auth, headers, automatic behaviors, response details, error handling, and configuration options. It comprehensively supports agent decision-making.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so baseline is 3. The description adds valuable semantics: for 'headers', it warns against using sensitive data; for 'endpoint', it explains resolution against base URL; for 'body', it clarifies usage with POST/PUT. This goes beyond the schema, earning a 4.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states 'Test a REST API endpoint and get detailed response information,' which is a specific verb and resource. It also provides the base URL and key behavioral details, making the purpose unmistakable.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides extensive guidance, including when to use the tool, automated behaviors (normalization, auth injection, header handling), and error handling. It also references a config resource for additional settings, helping the agent decide when and how to use the tool.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

  1. 1 tool updatev0.4.0
    • First observedtest_request

TDQS

A4.3/5.0

Scored across 1 tool

Disambiguation5/5

Only one tool exists, so there is no possibility of confusion between tools.

Naming Consistency5/5

With a single tool, naming is trivially consistent and follows a clear verb_noun pattern.

Tool Count2/5

The server is named 'mcp-rest-api' but only provides one testing tool, which is far too few for comprehensive REST API interaction; typically multiple CRUD tools are expected.

Completeness1/5

The server lacks fundamental operations like create, read, update, and delete; it only offers a test request tool, leaving major gaps for any practical REST API workflow.

Maintenance

ActivityInactive
ResponsivenessUnresponsive

Related MCP Connectors

Related MCP Servers

  • A
    license
    B
    quality
    D
    maintenance
    A TypeScript-based MCP server that enables interaction with Azure Table Storage directly through Cline. This tool allows you to query and manage data in Azure Storage Tables.
    1
    7 npm
    3
    MIT
  • A
    license
    Not graded
    quality
    D
    maintenance
    A TypeScript-based MCP server that provides backend API handling and facilitates communication between microservices. Features an organized structure with controllers, routes, and models for easy extensibility and maintenance.
    221 npm
    1
    MIT
  • A
    license
    Not graded
    quality
    D
    maintenance
    A demonstration MCP server built in TypeScript that shows how to implement stdio-based communication for integration with MCP clients. Serves as a template for building custom MCP servers with strong typing and maintainability.
    ISC
  • F
    license
    C
    quality
    D
    maintenance
    A modular MCP server that connects to external APIs, providing tools for weather data, user management, and company operations. Features a scalable architecture with TypeScript support, HTTP client abstraction, and robust error handling.
    5
    -