MCP-DOC-MID
클로드 문서 미드: OpenAPI 및 통합 생성용 MCP 서버
Node.js(ES Modules) 기반 Model Context Protocol (MCP) 생태계를 위한 엔터프라이즈급 서버로, OpenAPI/Swagger 사양을 학습하고 $ref를 역참조하여 LLM이 이를 조회하고 프로덕션 준비가 된 코드 통합을 생성할 수 있게 합니다.
@apidevtools/swagger-parser를 사용하여 서버 시작 시 모든 포인터와 컴포넌트 스키마를 메모리에서 해석하며, TypeScript, Python, JavaScript, cURL, C# 등 다양한 언어로 검색·검사·검증·HTTP 클라이언트 생성에 설계된 MCP 도구 8개의 카탈로그를 제공합니다.
📚 상세 문서
전문 가이드와 완전한 다이어그램은 다음을 참조하세요:
🏛️ 시스템 아키텍처 가이드 (
docs/ARCHITECTURE.md): 플로우 다이어그램, 세션 바인딩, 관찰 가능성, 원자적 지속성 및 서킷 브레이커.🛠️ MCP 도구 참고 자료 (
docs/TOOLS_REFERENCE.md): 각 도구의 매개변수, JSON 스키마 및 응답 예제에 대한 자세한 설명.📂 Swagger / OpenAPI 파일 가이드 (
docs/SWAGGER_GUIDE.md):.yml및.json사양을 추가, 검증, 구성하는 방법.📋 Doters API Internal 구조 사양 (
docs/MIDDLEWARE_API_SPEC.md):middleware-api.json의 110개 엔드포인트, 221개 DTO, 응답 래퍼 및 25개 도메인에 대한 분석.
Related MCP server: mcp-swagger
🏛️ 주요 기능
자동 읽기 및 역참조 (
swaggers/):.yml,.yaml,.json파일을 재귀적으로 스캔합니다.컴포넌트, 매개변수, 모델의
$ref참조를 완전하게 해석합니다.
LLM용 코드 통합 생성:
generate_integration_code: 모든 엔드포인트에 대한 스니펫과 강력한 형식의 클라이언트를 생성합니다.TypeScript (
fetch/axios), JavaScript, Python (httpx/requests), cURL, C# 지원.
보안 검증 및 추출:
validate_payload: JSON 페이로드가 필수 유형과 필드를 충족하는지 사전 확인합니다.get_security_schemes: 인증 스키마(Bearer 토큰, API 키, OAuth2)를 추출합니다.
이중 전송:
STDIO: Claude Desktop, Antigravity, Cursor 및 MCP 확장과의 표준 통합.
SSE / HTTP:
/sse,/messages,/metrics,/health,/dashboard엔드포인트를 갖춘 Express 서버.
관찰 가능성 및 보안:
로그는 Pino와 함께 온전히
process.stderr로만 출력됩니다./metrics에 Prometheus(prom-client) 메트릭 제공./messages에서 세션 바인딩 및 세션 하이재킹 보호.
🛣️ 3단계 통합 흐름 (Zero-Code)
새로운 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단계: 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이 명령은 15ms 안에 무엇을 할까요?
새 파일을 감지하고 SHA-256 해시를 계산합니다.
모든
$ref포인터를 자동으로 해석하고 역참조합니다.끊어지거나 없는 참조를 정리하여 서버가 결코 무너지지 않게 합니다.
.cache/swaggers/에 무거운 트래픽용 스냅샷을 생성합니다.실시간 요약을 표시합니다:
{
"status": "healthy",
"checks": {
"swaggers": {
"status": "pass",
"specsCount": 4,
"endpointsCount": 285,
"schemasCount": 412
}
}
}3단계: 에이전트 및 LLM에서 조회할 준비 완료
즉시 8개의 MCP 도구가 추가 설정 없이 새 엔드포인트와 스키마를 학습합니다:
전역 검색:
search_docs({ query: "renta autos" })은 모든 swagger에서 동시에 검색합니다.한정 검색:
search_docs({ query: "renta", specId: "avasa-car-rental" })은 해당 API만 조회합니다.코드 생성:
generate_integration_code({ path: "/v1/cars/book", language: "typescript" })은 형식화된 클라이언트를 생성합니다.Payload 검증:
validate_payload({ schemaName: "CarBookingDto", payload: { ... } })은 새 모델에 대해 검증합니다.
🏅 LLM의 최대 품질을 위한 모범 사례
언어 모델이 새 swagger를 읽고 최고의 코드와 정확한 응답을 생성하려면:
기본 URL(
servers)을 선언하세요:servers: - url: https://api.vivaaerobus.com/v1 description: Ambiente de Producción스키마에 예시(
example/examples)를 포함하세요: 예제를 포함하면generate_integration_code도구와 LLM이 자동으로 실제 테스트를 위한 payload를 만들 수 있습니다.명확한 태그(
tags)를 사용하세요: 여러 태그로 그룹화(예:[ "CarRental", "Payments", "Security" ])하면 에이전트가search_docs({ tag: "Payments" })으로 엔드포인트 컬렉션을 빠르게 필터링할 수 있습니다.보안(
components.securitySchemes)을 선언하세요:bearerFormat: JWT,ApiKey또는OAuth2사용 여부를 지정하여get_security_schemes도구가 필요한 헤더를 반환하도록 합니다.
🛠 사용 가능한 MCP 도구
도구 | 설명 | 주요 매개변수 |
로드된 모든 API의 버전, 서버, 경로 수를 나열합니다. | 없음 | |
키워드로 엔드포인트, 모델 및 설명을 검색합니다. |
| |
엔드포인트의 전체 및 역참조된 명세를 가져옵니다. |
| |
역참조된 데이터 모델 / 스키마를 가져옵니다. |
| |
프로덕션 지원 가능한 클라이언트 코드(TS, Python, JS, cURL, C#)를 생성합니다. |
| |
인증 스키마 및 필수 헤더를 가져옵니다. |
| |
엔드포인트 호출 전에 JSON 페이로드를 엔드포인트 스키마에 대해 검증합니다. |
| |
API에 대한 비즈니스 또는 아키텍처 질문에 종합적으로 응답합니다. |
|
⚙️ 환경 변수 (.env)
변수 | 설명 | 기본값 |
| 전송 모드 ( |
|
| SSE/HTTP 모드용 수신 포트 |
|
| 로그 수준 ( |
|
| API 인증용 암호 키 |
|
| 인증 활성화/비활성화 ( |
|
| CORS에 허용된 출처 |
|
| 웹 대시보드 액세스 사용자 |
|
| 웹 대시보드 액세스 비밀번호 |
|
| ms 단위 Rate Limit 시간 창 |
|
| 창당 최대 요청 수 |
|
| 디스크에 통계 저장 여부 |
|
| 저장 파일 경로 |
|
| OpenAPI 파일 폴더 |
|
🚀 빠른 시작
# 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% 이상의 문장(stmt) 커가 포함된 종합 테스트 스위트를 갖추고 있습니다:
# 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:latestAvailable Tools
8 toolsgenerate_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.
| Name | Required | Description | Default |
|---|---|---|---|
| path | Yes | Ruta del endpoint a integrar (ej. "/v1/members/{memberId}/balances", "/v1/security/login"). | |
| method | No | Método HTTP (GET, POST, PUT, DELETE, PATCH). Por defecto GET. | |
| specId | No | ID de la especificación (opcional). | |
| language | No | Lenguaje de programación de destino. | |
| clientType | No | Librería cliente HTTP preferida (ej. "fetch" o "axios" en TypeScript). |
TDQS
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.
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.
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.
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.
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.
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.
| Name | Required | Description | Default |
|---|---|---|---|
| path | Yes | Ruta del endpoint (ej. "/v1/members/{memberId}/balances", "/v1/security/login"). | |
| method | No | Método HTTP (GET, POST, PUT, DELETE, PATCH). Por defecto GET. | |
| specId | No | ID o nombre de la especificación a consultar (opcional). |
TDQS
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.
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.
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.
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.
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.
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).
| Name | Required | Description | Default |
|---|---|---|---|
| specId | No | ID o nombre de la especificación a consultar (opcional). | |
| schemaName | Yes | Nombre del schema o componente (ej. "LoginRequestDto", "MemberBalanceResponseDto"). |
TDQS
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.
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.
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.
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.
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.
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.
| Name | Required | Description | Default |
|---|---|---|---|
| specId | No | ID de la especificación (opcional, si se omite lista todos). |
TDQS
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.
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.
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.
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.
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.
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.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
TDQS
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.
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.
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.
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.
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.
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.
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | Pregunta o consulta técnica/negocio sobre la funcionalidad disponible en las APIs. | |
| specId | No | ID o nombre de la especificación para restringir la consulta (opcional). |
TDQS
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.
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.
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.
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.
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.
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.
| Name | Required | Description | Default |
|---|---|---|---|
| tag | No | Filtrar por etiqueta/tag específico (opcional, ej. "MemberApi", "Security", "CarRental"). | |
| limit | No | Número máximo de resultados a retornar (por defecto 10, máximo 50). | |
| query | Yes | Término de búsqueda (ej. "balances", "login", "points", "memberId", "accrual"). | |
| specId | No | ID o nombre de la especificación para limitar la búsqueda (opcional). |
TDQS
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.
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.
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.
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.
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.
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.
| Name | Required | Description | Default |
|---|---|---|---|
| specId | No | ID de la especificación (opcional). | |
| payload | Yes | Objeto JSON a validar. | |
| schemaName | Yes | Nombre del schema a validar contra (ej. "LoginRequestDto", "MemberBalanceResponseDto"). |
TDQS
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.
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.
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.
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.
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.
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.
8 tool updates
v1.0.0- First observed
generate_integration_code - First observed
get_endpoint_doc - First observed
get_schema_doc - First observed
get_security_schemes - First observed
list_specs - First observed
query_api_knowledge - First observed
search_docs - First observed
validate_payload
TDQS
Scored across 8 tools
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.
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.
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.
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
Related MCP Connectors
Turn any task into the right API calls: discover, evaluate, and integrate public APIs.
Point Gecko at an OpenAPI spec; get first-call-correct, auth-hidden agent tools.
Convert, lint and generate LLM tool schemas for OpenAI, Anthropic, Gemini and MCP
Discover, compare, route, and execute machine-accessible capabilities for AI agents.
Related MCP Servers
- AlicenseNot gradedqualityDmaintenanceEnables LLMs to explore and query OpenAPI specifications, allowing natural language interaction with API endpoints, parameters, request bodies, and response schemas from any OpenAPI 3.x spec.14 npmMIT
- AlicenseAqualityDmaintenanceExposes Swagger/OpenAPI API documentation to AI models, enabling exploration, search, and interaction with endpoints, schemas, and execution of API calls.1426 npm2MIT
- FlicenseNot gradedqualityDmaintenanceBrings OpenAPI/Swagger documentation into AI assistants, enabling endpoint discovery, deep inspection, cURL generation, and TypeScript type generation.-
- AlicenseAqualityDmaintenanceEnables AI assistants to understand and interact with OpenAPI specifications, providing deep insight into API structures for faster and more accurate API integration.914 npm1MIT