MCP-QA MCP Server

An MCP server for the comprehensive analysis of Swagger 2.0 and OpenAPI 3.x

README.md

MCP-QA: Analizador de Contratos Swagger/OpenAPI

MCP Server para análisis completo de contratos Swagger/OpenAPI con exportación a JSON y generación automática de documentación.

🎯 Características

  • ✅ Soporta Swagger 2.0 y OpenAPI 3.x
  • ✅ Análisis completo de endpoints (paths, métodos HTTP)
  • ✅ Extracción de parámetros (path, query, header, cookie)
  • ✅ Análisis de request bodies con schemas
  • ✅ Análisis de responses (códigos HTTP, schemas, headers)
  • ✅ Extracción de schemas con propiedades, tipos y formatos
  • ✅ Validaciones (obligatoriedad, tipos, formatos UUID/fecha/etc)
  • ✅ Información de servidores y seguridad
  • ✅ Tags y documentación
  • Exportación a JSON con toda la información estructurada
  • Generación de README con documentación estilo Swagger UI

🏗️ Arquitectura

El proyecto sigue arquitectura limpia y principios SOLID con estructura modular donde cada herramienta es completamente autónoma:

mcp-qa/
├── tools/                           # Herramientas de QA (una por subdirectorio)
│   └── swagger_analyzer/            # Analizador de contratos Swagger/OpenAPI
│       ├── src/                     # Código fuente de la herramienta
│       │   ├── domain/              # Capa de dominio
│       │   │   ├── models.py        # Entidades del dominio
│       │   │   ├── interfaces.py    # Abstracciones (Fetcher, Parser, Analyzer)
│       │   │   └── exporters.py     # Interfaces de exportación
│       │   ├── application/         # Capa de aplicación (casos de uso)
│       │   │   ├── swagger_analyzer.py            # Analizador de contratos
│       │   │   ├── complete_analysis_use_case.py  # Orquestador principal
│       │   │   └── export_use_cases.py            # Casos de uso de exportación
│       │   └── infrastructure/      # Capa de infraestructura
│       │       ├── http_fetcher.py           # Obtención HTTP
│       │       ├── contract_parser.py        # Parser YAML/JSON
│       │       ├── json_exporter.py          # Exportador JSON
│       │       └── markdown_generator.py     # Generador de Markdown
│       ├── __init__.py
│       ├── config.py                # Configuración de la herramienta
│       └── tool.py                  # Facade de la herramienta
├── output/                          # Salidas generadas (por herramienta)
│   └── swagger_analyzer/            # Salidas del analizador Swagger
│       ├── swagger-analysis.json
│       └── API-README.md
└── main.py                          # Punto de entrada MCP

Principios SOLID aplicados:

  • S (Single Responsibility): Cada clase tiene una única responsabilidad bien definida
  • O (Open/Closed): Fácil agregar nuevas herramientas sin modificar las existentes
  • L (Liskov Substitution): Las implementaciones son intercambiables vía interfaces
  • I (Interface Segregation): Interfaces específicas y focalizadas
  • D (Dependency Inversion): Dependencias de abstracciones mediante inyección

Estructura modular y escalable:

  • Cada herramienta es autónoma: Tiene su propio src/ con arquitectura limpia completa
  • Alta cohesión, bajo acoplamiento: No hay dependencias entre herramientas
  • Estructura homóloga: Todas las herramientas siguen el mismo patrón arquitectónico
  • Salidas organizadas: Por herramienta en output/
  • Fácil de mantener: Cambios en una herramienta NO afectan a otras
  • Fácil de escalar: Agregar nuevas herramientas es simplemente duplicar la estructura

📦 Instalación

# Instalar dependencias
pip install -e .

🚀 Uso principal:

Análisis completo de contrato Swagger (una herramienta, todo incluido)
# Análisis completo: texto + JSON + README
analizar_contrato_swagger("http://localhost:8080/v3/api-docs")

# Con URL de Swagger UI para incluir en README
analizar_contrato_swagger(
    "http://localhost:8080/v3/api-docs",
    swagger_ui_url="http://localhost:8080/swagger-ui/index.html"
)

# Solo texto, sin generar archivos
analizar_contrato_swagger(
    "https://petstore.swagger.io/v2/swagger.json",
    generar_json=False,
    generar_readme=False
)

# Solo JSON
analizar_contrato_swagger(
    "http://localhost:8080/v3/api-docs",
    generar_readme=False
)

Salidas generadas:

Todos los archivos se guardan automáticamente en output/swagger_analyzer/:

  • swagger-analysis.json: Análisis completo en JSON estructurado
  • API-README.md: Documentación estilo Swagger UI Esto genera un README.md profesional con:
  • Tabla de contenidos
  • Resumen y estadísticas
  • Links a Swagger UI
  • Documentación completa de endpoints
  • Tablas de schemas y propiedades
  • Códigos de estado HTTP

🔍 Información extraída

El analizador extrae:

  • Información general: título, versión, descripción
  • Servidores: URLs y configuraciones
  • Endpoints:
    • Path y método HTTP
    • Parámetros (ubicación, tipo, obligatoriedad)
    • Request body (content types, schemas)
    • Responses (códigos, schemas, headers)
  • Schemas:
    • Propiedade

Tools 1

analizar_contrato_swaggerPerforms a complete analysis of a Swagger/OpenAPI contract from a given URL.

Try it

Analyze the API contract at http://localhost:8080/v3/api-docs and generate a README.
Perform a full analysis of the Petstore API at https://petstore.swagger.io/v2/swagger.json and export the results to JSON.
Analyze this OpenAPI contract and include a link to the Swagger UI at http://localhost:8080/swagger-ui/index.html in the generated documentation.

Frequently Asked Questions

What are the key features of MCP-QA?

Supports both Swagger 2.0 and OpenAPI 3.x specifications. Extracts detailed endpoint, parameter, request body, and response schema information. Exports analysis results into structured JSON files. Generates professional API documentation in Markdown format. Validates data types, formats, and required fields.

What can I use MCP-QA for?

Automating the generation of API documentation for internal microservices. Validating API contract consistency during QA testing cycles. Converting complex OpenAPI specifications into readable Markdown README files for developers. Extracting structured API metadata for integration into other documentation tools.

How do I install MCP-QA?

Install MCP-QA by running: pip install -e .

What MCP clients work with MCP-QA?

MCP-QA works with any MCP-compatible client including Claude Desktop, Claude Code, Cursor, and other editors with MCP support.

Turn this server into reusable context

Keep MCP-QA docs, env vars, and workflow notes in Conare so your agent carries them across sessions.

Open Conare