API Reference

TypeDoc-generated API documentation for Swagger MCP Server.

Modules

This section contains auto-generated documentation from the TypeScript source code.

Available Modules

Module	Description
Globals	Global exports and type definitions

Source Structure

src/
├── index.ts                 # MCP server entry point
├── services/
│   ├── config-loader.ts     # swagger-targets.json loader
│   ├── swagger-parser.ts    # OpenAPI parsing
│   └── http-client.ts       # API testing & cURL generation
├── tools/
│   └── swagger-tools.ts     # 10 MCP tools implementation
└── types/
    └── swagger.ts           # TypeScript type definitions

Key Exports

Types

• SwaggerSpec - Parsed Swagger/OpenAPI specification
• EndpointInfo - API endpoint information
• RequestConfig - HTTP request configuration
• ApiResponse - API response structure

Services

• SwaggerParserService - Parses and caches Swagger/OpenAPI specs
• loadTargets() - Loads swagger-targets.json configuration
• executeRequest() - Executes HTTP requests
• generateCurl() - Generates cURL commands

Tools

10 MCP tools for Swagger/OpenAPI interaction:

Tool	Function
swagger_select_service	Connect to a service
swagger_list_services	List configured services
swagger_get_current	Get current service info
swagger_list_endpoints	List API endpoints
swagger_get_endpoint	Get endpoint details
swagger_search	Search endpoints
swagger_get_schema	Get schema structure
swagger_list_schemas	List all schemas
swagger_test	Execute HTTP request
swagger_curl	Generate cURL command

See Also

• Tools Reference - Detailed tool documentation
• Examples - Usage examples and best practices