Dynamically extracts Swagger/OpenAPI JSON specifications and generates MCP tools at runtime, enabling AI agents to interact with any REST API documented with Swagger UI through automatically created tool definitions.
swagger-mcp
Overview
swagger-mcp
is a tool designed to scrape Swagger UI by extracting the swagger.json
file and dynamically generating well-defined mcp tools at runtime. These tools can be utilized by the MCP client for further tool selection.
📽️ Demo Video
Check out demo video showcasing the project in action:
🙌 Support
If you find this project valuable, please support me on LinkedIn by:
- 👍 Liking and sharing our demo post
- 💬 Leaving your thoughts and feedback in the comments
- 🔗 Connecting with me for future updates
Your support on LinkedIn will help me reach more people and improve the project!
Prerequisites
To use swagger-mcp
, ensure you have the following dependencies:
- LLM Model API Key / Local LLM: Requires access to OpenAI, Claude, or Ollama models.
- Any MCP Client: (Used mark3labs - mcphost)
Installation and Setup
Follow these steps to install and run swagger-mcp
:
Run Configuration
To run swagger-mcp
directly, use:
Main flags:
--specUrl
: Swagger/OpenAPI JSON URL (required)--sseMode
: Run in SSE mode (default: false, if true runs as SSE server, otherwise uses stdio)--sseAddr
: SSE server listen address in IP:Port or format (if empty, will use IP from --sseUrl)--sseUrl
: SSE server base URL (if empty, will use sseAddr to generate, e.g. http://IP:Port or http://localhost)- If both --sseAddr and --sseUrl are set, they are used as-is without auto-complement.
--baseUrl
: Override base URL for API requests--security
: API security type (basic
,apiKey
, orbearer
)--basicAuth
: Basic auth in user format--bearerAuth
: Bearer token for Authorization header--apiKeyAuth
: API key(s), formatpassAs:name=value
(e.g.header:token=abc,query:user=foo,cookie:sid=xxx
)- See main.go for all supported flags and options.
MCP Configuration
To integrate with mcphost
, include the following configuration in .mcp.json
:
Demo Flow
- Some Backend:
- Ollama
- MCP Client
Flow Diagram
🛠️ Need Help
I am working on improving tool definitions to enhance:
✅ Better error handling for more accurate responses
✅ LLM behavior control to ensure it relies only on API responses and does not use its own memory
✅ Preventing hallucinations and random data generation by enforcing strict data retrieval from APIs
If you have insights or suggestions on improving these aspects, please contribute by:
- Sharing your experience with similar implementations
- Suggesting modifications to tool definitions
- Providing feedback on current limitations
Your input will be invaluable in making this tool more reliable and effective! 🚀
This server cannot be installed
remote-capable server
The server can be hosted and run remotely because it primarily relies on remote services or has no dependency on the local environment.
Dynamically generates MCP tools from Swagger/OpenAPI specifications by extracting swagger.json files at runtime. Enables natural language interaction with any REST API that has Swagger documentation.
Related MCP Servers
- -securityAlicense-qualityA server that enables interaction with any API that has a Swagger/OpenAPI specification through Model Context Protocol (MCP), automatically generating tools from API endpoints and supporting multiple authentication methods.Last updated -1594TypeScriptApache 2.0
- -securityAlicense-qualityswagger-mcp is a tool designed to scrape Swagger UI by extracting the swagger.json file and dynamically generating well-defined mcp tools at runtime. These tools can be utilized by the MCP client for further tool selection.Last updated -56GoMIT License
- AsecurityAlicenseAqualityA tool that creates MCP (Model Context Protocol) servers from OpenAPI/Swagger specifications, enabling AI assistants to interact with your APIs.Last updated -3821TypeScriptMIT License
- AsecurityAlicenseAqualityMCP server that provides tools for exploring and testing APIs through Swagger/OpenAPI documentation.Last updated -5154JavaScriptMIT License