What is OpenAPI to MCP Server Generator?
OpenAPI to MCP Server Generator is a Python CLI tool that generates a basic Node.js/TypeScript MCP (Model Context Protocol) server from an OpenAPI v3 specification file (JSON/YAML), mapping each operation to an MCP tool.
How to use OpenAPI to MCP Server Generator?
To use the tool, navigate to the project directory and run the command poetry run openapi-to-mcp generate --openapi-json <path_or_url> to generate the MCP server code based on the OpenAPI specification.
Key features of OpenAPI to MCP Server Generator?
- Parses OpenAPI v3 JSON or YAML from local files or URLs.
- Validates the OpenAPI specification structure.
- Maps OpenAPI operations (GET, POST, PUT, DELETE, PATCH) to MCP tools.
- Generates a runnable Node.js/TypeScript MCP server project with clear setup instructions.
- Integrated linting and formatting tools, along with unit and integration tests.
Use cases of OpenAPI to MCP Server Generator?
- Quickly generate an MCP server for existing OpenAPI specifications.
- Facilitate the development of applications that require interaction with APIs defined by OpenAPI.
- Streamline the process of creating and testing MCP servers for various APIs.
FAQ from OpenAPI to MCP Server Generator?
-
What is MCP?
MCP stands for Model Context Protocol, which is a protocol for managing and interacting with models in a structured way. -
Is the tool free to use?
Yes! The OpenAPI to MCP Server Generator is open-source and free to use. -
What are the prerequisites?
You need Python 3.12 or higher, Poetry for dependency management, and Node.js version 20 or higher for the generated server.