Skip to main content
Glama

MCP-DOC-MID:用于 OpenAPI 与集成生成的 MCP 服务器

为 Node.js(ES Modules)中的 Model Context Protocol(MCP) 生态系统打造的企业级服务器,专注于 学习、解引用($ref)并让 LLM 查询 OpenAPI/Swagger 规范,从而生成可直接用于生产的代码集成。

它使用 @apidevtools/swagger-parser 在服务器启动时于内存中解析所有指针和组件模型,并公开了一个包含 8 个 MCP 工具 的目录,这些工具专为搜索、检查、验证和生成多种语言(TypeScript、Python、JavaScript、cURL、C#)的 HTTP 客户端而设计。


📚 详细文档

如需专业指南和完整图表,请参阅:


Related MCP server: mcp-swagger

🏛️ 主要特性

  1. 自动读取与解引用(swaggers/):

    • 递归扫描 .yml、.yaml 和 .json 文件。

    • 完整解析组件、参数和模型中的 $ref 引用。

  2. 为 LLM 生成代码整合:

    • generate_integration_code:为任意端点生成代码片段和强类型客户端。

    • 支持 TypeScript(fetch/axios)、JavaScript、Python(httpx/requests)、cURL 和 C#。

  3. 安全验证与提取:

    • validate_payload:预先检查 JSON 负载是否符合必需的类型和字段。

    • get_security_schemes:提取身份验证方案(Bearer 令牌、API 密钥、OAuth2)。

  4. 双传输模式:

    • STDIO:与 Claude Desktop、Antigravity、Cursor 和 MCP 扩展的标准集成。

    • SSE / HTTP:Express 服务器,支持 /sse、/messages、/metrics、/health 和 /dashboard。

  5. 可观测性与安全性:

    • 使用 Pino 将日志仅输出到 process.stderr。

    • 在 /metrics 上提供 Prometheus 指标(prom-client)。

    • 在 /messages 中实现会话绑定与会话劫持保护。


🛣️ 三步整合流程(零代码)

为了让新 API 的整合 100% 可扩展、无摩擦且无需编写任何代码,服务器实现了 自动发现与约定加载:

flowchart LR
    A["1. Copiar Archivo\n(swaggers/mi-api.json o .yml)"] --> B["2. Auto-Discovery & Caching\n(Hash SHA-256 + Dereference)"]
    B --> C["3. Auto-Diagnóstico\n(npm run self-test)"]
    C --> D["✅ Disponible en las 8 Tools MCP\n(search_docs, get_endpoint_doc, etc.)"]

1️⃣ 步骤 1:将文件放入 swaggers/

只需将你的 .json、.yml 或 .yaml 文件保存到 swaggers/ 目录中即可。

📁 推荐的可扩展结构(按域名或微服务组织):

扫描器是 递归的,因此随着 API 数量的增加,你可以将文件整理到按主题分类的子目录中:

swaggers/
├── middleware-api.json                # API Core Middleware
├── partners/
│   ├── avasa-car-rental.json          # Swagger de Avasa
│   └── iamsa-bus.json                 # Swagger de IAMSA
├── payments/
│   └── openpay-gateway.yml            # OpenAPI de Pasarelas de Pago
└── flights/
    └── viva-booking.yaml              # OpenAPI de Reservaciones Viva

[!TIP] 自动标识符(specId):
系统会根据文件的基本名称自动生成 specId:

  • avasa-car-rental.json $\rightarrow$ specId: "avasa-car-rental"

  • openpay-gateway.yml $\rightarrow$ specId: "openpay-gateway"


2️⃣ 步骤 2:通过 npm run self-test 验证完整性

无需盲目启动 MCP 客户端或重启服务器。在终端运行:

npm run self-test

这个命令在 < 15 毫秒内做什么?

  1. 检测新文件并计算其 SHA-256 哈希。

  2. 自动解析所有 $ref 引用并进行解引用。

  3. 清理损坏或缺失的引用,使服务器永不崩溃。

  4. 在 .cache/swaggers/ 中生成高性能快照。

  5. 实时显示摘要:

{
  "status": "healthy",
  "checks": {
    "swaggers": {
      "status": "pass",
      "specsCount": 4,
      "endpointsCount": 285,
      "schemasCount": 412
    }
  }
}

3️⃣ 步骤 3:可供代理和 LLM 立即查询

8 个 MCP 工具会立即学习新的端点和模式,无需任何额外配置:

  • 全局搜索:search_docs({ query: "renta autos" }) 将同时对所有 swaggers 进行搜索。

  • 过滤搜索:search_docs({ query: "renta", specId: "avasa-car-rental" }) 仅查询该 API。

  • 代码生成:generate_integration_code({ path: "/v1/cars/book", language: "typescript" }) 将生成类型化客户端。

  • 加载模板验证:validate_payload({ schemaName: "CarBookingDto", payload: { ... } }) 将根据新模型进行验证。


🏆 确保 LLM 的最大质量的最佳实践

为了使语言模型在读取你的新 swaggers 时生成最佳代码和准确响应:

  1. 声明基础 URL(servers):

    servers:
      - url: https://api.vivaaerobus.com/v1
        description: Ambiente de Producción
  2. 在模式中包含示例(example / examples):示例使 generate_integration_code 工具和 LLM 能够自动创建真实的测试负载。

  3. 使用清晰的标签(tags):按标签分组(例如 [ "CarRental", "Payments", "Security" ])可让代理通过 search_docs({ tag: "Payments" }) 快速筛选端点集合。

  4. 声明安全配置(components.securitySchemes):指定其使用 bearerFormat: JWT、ApiKey 还是 OAuth2,以便 get_security_schemes 工具公开所需的对头。


🛠️ 可用的 MCP 工具

工具

描述

主要对应参数

list_specs

列出所有已加载的 API 及其版本、服务器和路由数量。

无

search_docs

按关键词搜索端点、模型和描述。

query(必填项), specId(可选), tag(可选), limit(可选)

get_endpoint_doc

获取某个端点的完整且已解引用的规范。

path(必填), method(可选,默认 GET), specId(可选)

get_schema_doc

获取已解引用的数据模型 / schema。

schemaName(必填), specId(可选)

generate_integration_code

生成可直接用于生产的客户端代码(TypeScript、Python、JavaScript、cURL、C#)。

path(必填), method(可选), language(可选), clientType(可选)

get_security_schemes

获取身份验证方案及必需的对头。

specId(可选)

validate_payload

在调用 API 之前根据端点的 schema 验证 JSON 负载。

schemaName(必填), payload(必填), specId(可选)

query_api_knowledge

综合回答有关 API 的业务或架构问题。

query(必填), specId(可选)


⚙️ 环境变量(.env)

变量名

描述

默认值

TRANSPORT_MODE

传输模式(stdio、sse、http)

stdio

PORT

SSE/HTTP 模式的监听端口

3000

LOG_LEVEL

日志级别(debug、info、warn、error)

info

MCP_API_KEY

用于 API 身份验证的密钥

default-mcp-secret-key

ENABLE_AUTH

启用/禁用身份验证(true/false)

true

ALLOWED_ORIGINS

允许的 CORS 来源

*

DASHBOARD_USER

用于访问 Web 仪表盘的用户名

admin

DASHBOARD_PASSWORD

用于访问 Web 仪表盘的用户名密码

admin

RATE_LIMIT_WINDOW_MS

Rate Limit 的时间窗口(毫秒)

900000(15 分钟)

RATE_LIMIT_MAX

每个时间窗口的最大请求数

1000

STATS_STORAGE_ENABLED

是否将统计信息持久化到磁盘

true

STATS_STORAGE_PATH

持久化文件的位置

data/stats.json

SWAGGERS_DIR

OpenAPI 规范文件夹

swaggers


🚀 快速入门

# 1. Instalar dependencias
npm install

# 2. Autodiagnóstico en runtime (<5ms)
npm run self-test

# 3. Iniciar en modo STDIO (predeterminado)
npm start

# 4. Iniciar en modo SSE / HTTP (servidor web)
TRANSPORT_MODE=sse PORT=3000 npm start

🧪 自动化测试与基准测试

该项目拥有一个全面的测试套件,116 个测试全部通过(100%),语句覆盖率超过 93%:

# 1. Ejecutar suite completa de pruebas unitarias y de integración
npm test

# 2. Reporte de cobertura detallado con Vitest y V8 (>93% Stmts)
npm run test:coverage

# 3. Pruebas de carga de alta concurrencia (100 agentes concurrentes)
npm run test:load

# 4. Benchmark de latencia y throughput (<5ms)
npm run benchmark

# 5. Pipeline de integración continua (CI)
npm run test:ci

🐳 使用 Docker 部署

# Construir imagen Docker multi-stage
docker build -t mcp-doc-mid:latest .

# Ejecutar contenedor en modo SSE
docker run -p 3000:3000 -e TRANSPORT_MODE=sse mcp-doc-mid:latest

Available Tools

8 tools
generate_integration_codeB

Genera un snippet/cliente de código listo para producción en TypeScript, JavaScript, Python, cURL o C# para un endpoint específico.

NameRequiredDescriptionDefault
pathYesRuta del endpoint a integrar (ej. "/v1/members/{memberId}/balances", "/v1/security/login").
methodNoMétodo HTTP (GET, POST, PUT, DELETE, PATCH). Por defecto GET.
specIdNoID de la especificación (opcional).
languageNoLenguaje de programación de destino.
clientTypeNoLibrería cliente HTTP preferida (ej. "fetch" o "axios" en TypeScript).

TDQS

B3.3/5.0
Behavior2/5

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

No annotations are present, so the description must carry the full behavioral burden, and it only claims 'producción' (production-ready) quality without explaining output format, side effects, errors, prerequisites, or determinism. With no output schema, the absence of any statement about what the tool actually returns is a real gap.

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

Conciseness5/5

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

A single, efficient sentence that front-loads the action verb 'Genera', names the languages, and scopes the tool to a specific endpoint. Zero filler, every phrase earns its place.

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

Completeness3/5

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

For a simple five-parameter tool with 100% schema coverage this is adequate at a minimum-viable level, but the absence of an output schema and annotations puts more weight on the description than it handles: it doesn't state the return value shape, when to use the tool among its siblings, or whether runtime checks depend on a valid spec/endpoint.

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

Parameters3/5

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

Schema description coverage is 100%, so the baseline is 3 even though the description adds no parameter-level detail. The languages listed in the prose merely echo the enum values of the 'language' parameter, and 'segmento específico' matches 'path', so the description adds almost nothing beyond the schema.

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 uses a specific verb ('Genera') and a clear resource ('un snippet/cliente de código listo para producción... para un endpoint específico'), naming the target languages. Since all sibling tools only list, search, read, validate, or query knowledge, this is unmistakably the only code-generation tool, so it distinguishes itself implicitly.

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

Usage Guidelines2/5

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

The description provides no guidance on when to choose this tool versus any sibling, nor does it mention exclusions or prerequisites (e.g., needing a spec or a valid endpoint first). The usage context is only implied by the purpose sentence.

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

get_endpoint_docB

Obtiene la documentación completa, parámetros, request body y respuestas dereferenciadas de un endpoint específico.

NameRequiredDescriptionDefault
pathYesRuta del endpoint (ej. "/v1/members/{memberId}/balances", "/v1/security/login").
methodNoMétodo HTTP (GET, POST, PUT, DELETE, PATCH). Por defecto GET.
specIdNoID o nombre de la especificación a consultar (opcional).

TDQS

B3.4/5.0
Behavior3/5

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

With no annotations provided, the description carries the full burden. It discloses that the tool performs a read-only retrieval and specifically highlights that responses are 'dereferenciadas' (resolving $refs), which adds useful behavioral detail. However, it does not mention rate limits, authentication, or what a complete response structure actually looks like.

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

Conciseness5/5

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

One concise, dense sentence that starts with the verb and quickly enumerates the returned artifacts. No fluff, redundant phrases, or repetitive wording. It is front-loaded with the core action and object.

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

Completeness4/5

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

For a simple read-only tool with just 3 well-documented parameters and no output schema, the description sufficiently states what the tool retrieves and the key behavioral trait of de-referencing. The lack of an explicit when-to-use contrast is a gap, but that falls largely under usage guidance rather than overall completeness for invocation.

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

Parameters3/5

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

The schema covers all three parameters with detailed descriptions and an enum for method, achieving 100% schema description coverage. The description adds no extra information beyond what the schema already provides, so the baseline of 3 is appropriate.

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

Purpose4/5

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

The description states the specific verb 'Obtiene' and the exact resource: complete documentation including parameters, request body, and de-referenced responses for a specific endpoint. It clearly differentiates from sibling tools like list_specs or get_schema_doc through the 'endpoint específico' phrase, though it does not explicitly name the alternative.

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

Usage Guidelines2/5

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

The description gives no guidance on when to use this tool instead of alternatives such as search_docs or get_schema_doc. It merely describes what it retrieves, leaving the selection criteria entirely to the agent to infer. There are no exclusions, prerequisites, or explicit usage contexts.

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

get_schema_docA

Obtiene la definición de un modelo de datos o schema dereferenciado (propiedades, tipos, campos obligatorios y enums).

NameRequiredDescriptionDefault
specIdNoID o nombre de la especificación a consultar (opcional).
schemaNameYesNombre del schema o componente (ej. "LoginRequestDto", "MemberBalanceResponseDto").

TDQS

A3.6/5.0
Behavior3/5

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

With no annotations provided, the description carries the behavioral burden. It discloses that the schema is dereferenced and enumerates the returned content (properties, types, required fields, enums), which is useful. It does not mention error cases, optional specId handling, or any resolution side effects, leaving moderate ambiguity.

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

Conciseness5/5

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

A single, focused sentence that front-loads the main purpose and appends the relevant definition details. No filler or redundant content. It is compact without losing the essential scope.

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

Completeness4/5

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

For a simple retrieval tool, the description gives the core information: what is fetched and what the return content includes. There is no output schema, so a bit more detail on the response format or specId behavior would help, but the description is substantially sufficient for an agent to decide to invoke it.

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

Parameters3/5

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

The input schema already documents both parameters fully (coverage 100%), so baseline 3 applies. The description adds little about parameter semantics beyond implying schemaName is the thing to look up; no extra detail about how specId interacts is provided.

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

Purpose4/5

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

The description clearly identifies the resource (schema/data model definition) and what the tool returns (properties, types, required fields, enums). It does not explicitly differentiate from siblings like get_endpoint_doc or get_security_schemes, but the resource type is distinct enough that an agent can infer its purpose.

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

Usage Guidelines3/5

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

Usage context is implied: use this tool when you need a schema definition (e.g., 'LoginRequestDto' or 'MemberBalanceResponseDto'). There is no explicit guidance about when not to use it or which sibling alternative to prefer, but the purpose itself gives reasonable inference.

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

get_security_schemesA

Obtiene los esquemas de autenticación y seguridad (Bearer token, API Key, OAuth2) definidos en las especificaciones OpenAPI.

NameRequiredDescriptionDefault
specIdNoID de la especificación (opcional, si se omite lista todos).

TDQS

A3.6/5.0
Behavior3/5

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

No annotations are provided, so the description carries the behavioral disclosure burden. It does indicate a read-only 'obtiene' operation and states the source of the schemes (OpenAPI specifications). It does not disclose behaviors such as error handling, pagination, or what happens when specId is omitted — although the schema notes that behavior, so it is not completely hidden.

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

Conciseness5/5

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

The description is a single focused sentence with no filler. It immediately states the action and includes a parenthetical list of scheme types that adds useful detail without bloat. Structurally front-loaded and easy to parse.

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

Completeness4/5

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

This is a simple read-only tool with one optional parameter and no output schema, so full context is largely achieved. The description covers what is returned, and the schema covers the parameter behavior. The only missing piece is an explicit statement that an omission of specId returns schemes across all specs, but that is already in the schema description.

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

Parameters3/5

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

The only parameter, specId, has 100% schema description coverage ('opcional, si se omite lista todos'). The main description does not add any additional parameter detail beyond the schema baseline. The mention of scheme types (Bearer token, API Key, OAuth2) describes output concepts, not parameter semantics.

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

Purpose4/5

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

The description clearly states a specific verb and resource: 'obtiene' (gets) and 'esquemas de autenticación y seguridad' (authentication/security schemes), and names concrete types (Bearer token, API Key, OAuth2). It is clearly distinct from siblings like get_endpoint_doc or get_schema_doc, but does not explicitly distinguish itself by name.

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

Usage Guidelines3/5

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

The intended use is implied: this tool is for retrieving security schemes from OpenAPI specs. However, it never explicitly explains when to use this tool versus a sibling, such as get_endpoint_doc or get_schema_doc, which may also provide security-related information. Guidance is functional but not direct.

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

list_specsA

Lista todas las especificaciones OpenAPI/Swagger (.yml y .json) que han sido aprendidas y dereferenciadas en memoria con sus servidores y versiones.

NameRequiredDescriptionDefault

No parameters

TDQS

A3.8/5.0
Behavior3/5

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

There are no annotations provided, so the description carries the full burden. It does disclose that the specs are 'aprendidas y dereferenciadas en memoria' and that servers and versions are included, which is useful. It does not explain any potential limitations, whether it requires existing in-memory data, or what happens if no specs exist.

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

Conciseness5/5

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

Exactly one sentence with no filler. It includes the resource type, file extensions, the in-memory state, and the return components in a compact, front-loaded way.

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

Completeness4/5

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

For a simple parameterless listing tool, the description is sufficiently complete: it names the entities, their formats, their state, and the included properties. Minor gaps such as the exact response envelope or error behavior exist, but they are not critical for this simple operation.

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?

The tool has zero parameters, so the description has very little burden here. The schema already covers all parameters. The description's mention of servers and versions gives a hint about the result shape, but no parameter semantics are needed.

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 immediately states the verb ('Lista'), the resource ('todas las especificaciones OpenAPI/Swagger'), and the scope ('aprendidas y dereferenciadas en memoria'). It clearly differentiates this from sibling tools like get_schema_doc and get_endpoint_doc by being a list operation.

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

Usage Guidelines2/5

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

The description says what the tool does but gives no guidance on when to use it versus the sibling tools, such as get_schema_doc or get_endpoint_doc. An agent must infer that this is the right choice for enumerating available specs.

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

query_api_knowledgeB

Consulta y sintetiza el conocimiento transversal de las APIs OpenAPI aprendidas para resolver dudas de negocio o integración.

NameRequiredDescriptionDefault
queryYesPregunta o consulta técnica/negocio sobre la funcionalidad disponible en las APIs.
specIdNoID o nombre de la especificación para restringir la consulta (opcional).

TDQS

B3.2/5.0
Behavior2/5

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

No hay anotaciones, por lo que la descripción debe cargar con la transparencia de comportamiento. Dice que sintetiza conocimiento, lo cual aporta algo, pero no aclara si la búsqueda es de solo lectura, qué tipo de respuesta devuelve, si el conocimiento puede estar incompleto, ni cómo se relaciona con las especificaciones ya aprendidas.

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

Conciseness4/5

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

La descripción es una única oración clara y sin contenido redundante. Comunica el propósito y el contexto principal de forma compacta, aunque sacrifica espacio para matices de uso y comportamiento.

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

Completeness3/5

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

Para una herramienta de consulta con dos parámetros y esquema completo, la descripción alcanza lo esencial: qué hace y con qué objetivo. Pero al no existir esquema de salida ni anotaciones, y al competir con varias herramientas documentales cercanas, faltan detalles sobre resultado, alcance y límites de la 'síntesis' prometida.

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

Parameters3/5

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

La cobertura de esquema es del 100%, por lo que los parámetros query y specId ya están documentados en el esquema. La descripción no añade detalles nuevos sobre el formato de la consulta ni sobre cómo afecta specId al resultado, por lo que se mantiene la línea base.

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

Purpose4/5

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

La descripción nombra una acción específica ('consulta y sintetiza') y un recurso concreto: el conocimiento transversal de APIs OpenAPI aprendidas. Se diferencia razonablemente de herramientas como list_specs o get_endpoint_doc, aunque no delimita explícitamente su frontera con ellas.

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

Usage Guidelines3/5

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

La descripción indica un contexto de uso claro: resolver dudas de negocio o integración y trabajar sobre conocimiento transversal de varias APIs. Sin embargo, no señala cuándo preferir esta herramienta sobre alternativas como search_docs o get_schema_doc, ni menciona exclusiones o cuándo no usarla.

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

search_docsA

Busca endpoints, operaciones, etiquetas y modelos de datos en todas las especificaciones OpenAPI aprendidas por palabras clave.

NameRequiredDescriptionDefault
tagNoFiltrar por etiqueta/tag específico (opcional, ej. "MemberApi", "Security", "CarRental").
limitNoNúmero máximo de resultados a retornar (por defecto 10, máximo 50).
queryYesTérmino de búsqueda (ej. "balances", "login", "points", "memberId", "accrual").
specIdNoID o nombre de la especificación para limitar la búsqueda (opcional).

TDQS

A3.5/5.0
Behavior3/5

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

With no annotations, the description carries the behavioral burden. It conveys that this is a search-like operation across the full learned corpus, which is useful, but it does not mention whether the operation is strictly read-only, how results are ordered or shaped, or whether pagination or auth constraints apply.

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

Conciseness5/5

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

One front-loaded sentence with no filler. It states the action, the resources being searched, the corpus scope, and the keyword mechanism in a compact and immediately parseable way.

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

Completeness3/5

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

The input side is well covered by the schema, and the description gives the high-level behavior. But there is no output schema and no explanation of what results look like, and the boundary with sibling tools, especially query_api_knowledge, is not clarified.

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

Parameters3/5

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

Schema coverage is 100%, so parameters like query, tag, limit, and specId already have clear descriptions and examples. The description only reinforces the keyword-search mechanism without adding meaning beyond what the schema already provides.

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

Purpose4/5

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

The description clearly identifies the verb ('Busca'), the resource types ('endpoints, operaciones, etiquetas y modelos de datos'), and the scope ('todas las especificaciones OpenAPI aprendidas'). It distinguishes itself from list_specs and the get_doc siblings, though it does not explicitly address possible overlap with query_api_knowledge.

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

Usage Guidelines3/5

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

The usage context is implied: use this tool for keyword-based search across learned OpenAPI specifications. However, there are no explicit when-to-use or when-not-to-use conditions, and no sibling alternatives are named, so an agent has to infer differentiation.

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

validate_payloadA

Valida si un payload JSON cumple con la estructura, campos obligatorios y tipos de datos del schema OpenAPI antes de generar código.

NameRequiredDescriptionDefault
specIdNoID de la especificación (opcional).
payloadYesObjeto JSON a validar.
schemaNameYesNombre del schema a validar contra (ej. "LoginRequestDto", "MemberBalanceResponseDto").

TDQS

A3.6/5.0
Behavior2/5

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

No annotations are provided, so the description must carry the full burden of behavioral disclosure. It says validation occurs, but does not state whether it is read-only, what happens on invalid or valid payloads, whether errors are returned as exceptions, arrays, or booleans, or if the call has any side effects.

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

Conciseness5/5

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

The description is a single, efficient sentence with no wasted words. It starts with the key verb, names the involved resource and criteria, and closes with the temporal context. Very easy to read.

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

Completeness2/5

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

The tool has no output schema and no annotations, so return values and possible error behavior must be described. The current description only states that validation happens; it leaves unclear whether the tool returns a boolean, an error list, or something else.

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

Parameters3/5

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

Schema description coverage is 100%, and the parameter descriptions in the schema provide the needed meaning: schemaName, payload, and specId. The description adds no per-parameter semantics beyond what is already in the structured schema.

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 uses clear, specific verb ('Valida') and resource ('payload JSON...contra un schema OpenAPI') and even enumerates what is validated: structure, required fields, data types. This clearly distinguishes validate_payload from sibling tools that list, search, get, or generate code.

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

Usage Guidelines4/5

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

The description gives a clear temporal context: 'antes de generar código', so an agent knows to call it before generate_integration_code. It does not mention explicit exclusions or alternatives, but the timing signal is quite useful.

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. 8 tool updatesv1.0.0
    • First observedgenerate_integration_code
    • First observedget_endpoint_doc
    • First observedget_schema_doc
    • First observedget_security_schemes
    • First observedlist_specs
    • First observedquery_api_knowledge
    • First observedsearch_docs
    • First observedvalidate_payload

TDQS

A3.8/5.0

Scored across 8 tools

Disambiguation4/5

Each tool targets a distinct operation: list, search, get endpoint/schema, generate code, security, validate, and query knowledge. Some potential overlap exists between search_docs and query_api_knowledge, but descriptions clarify the difference between keyword search and synthesized cross-cutting knowledge.

Naming Consistency5/5

All tool names follow a consistent verb_noun pattern in snake_case, such as list_specs, get_endpoint_doc, and generate_integration_code. There are no mixed casing styles or vague verb variations.

Tool Count5/5

With 8 tools, the count is well-scoped for an OpenAPI documentation assistant. Each tool covers a necessary aspect of browsing, validating, and generating code from specs without redundancy.

Completeness5/5

The set covers the full document consumption lifecycle: discovering specs, searching content, retrieving endpoint/schema details, understanding security, validating payloads, and generating integration code. No significant gaps are apparent for the server's stated purpose.

Maintenance

ActivityStale
ResponsivenessNo recent community issues

Related MCP Connectors

Related MCP Servers

  • A
    license
    A
    quality
    D
    maintenance
    Exposes Swagger/OpenAPI API documentation to AI models, enabling exploration, search, and interaction with endpoints, schemas, and execution of API calls.
    14
    26 npm
    2
    MIT
  • A
    license
    A
    quality
    D
    maintenance
    Enables AI assistants to understand and interact with OpenAPI specifications, providing deep insight into API structures for faster and more accurate API integration.
    9
    26 npm
    1
    MIT