Enables configuration of the MCP server through environment variables loaded from a .env file, allowing customization of server settings such as base URL, OpenAPI specification path, and port number.
Provides the web framework foundation for the MCP server, enabling RESTful API endpoints for model service documentation retrieval and invocation.
Integrated for issue tracking and contribution management, with specific links to report bugs and submit pull requests to the project repository.
Serves as the runtime environment for the MCP server, with specific version requirements (v20 or higher) to ensure compatibility and performance.
Used for package management and running scripts for building and starting the server, with version requirements (v6 or higher) specified.
Provides type safety for the MCP server implementation, enhancing code reliability and developer experience.
Supports OpenAPI specifications in YAML format, allowing the MCP server to process and serve API documentation from YAML files.
OpenAPI MCP Server
A Quick Way to Create an MCP Server with StreamableHTTP transport implementation from OpenAPI docs.
Overview
This server provides a standardized way to interact with model services through a RESTful API interface. It implements the Model Context Protocol (MCP) and is designed to be easily configurable. Simply set up your
It implements the Model Context Protocol (MCP) specification and supports OpenAPI documentation.
Related MCP server: MCP-OpenAPI
Features
OpenAPI 3.0.0 compliant API documentation
Model service API documentation retrieval
Model service invocation with parameter handling
TypeScript implementation for type safety
Prerequisites
Node.js (v20 or higher)
npm (v6 or higher)
Quick Start
Clone the repository:
git clone https://github.com/oneWalker/openapi-mcp-server.git cd openapi-mcp-serverInstall dependencies:
npm installConfigure your environment: Create a
.envfile in the project root and add your configuration. See the Configuration section for details.Run the server:
npm run build npm run start
Installation
Clone the repository
Install dependencies:
Development
Building the Project
Running in Development Mode
Starting the Server
Configuration
Create a .env file in the root of the project to configure the server.
API Endpoints
Get Model Service API Documentation
Retrieves the API documentation for a specific model service.
Parameters:
ID(path, required): Model service IDauthorization(header, required): Bearer token for authentication
Call Model Service
Invokes a specific model service with provided parameters.
Parameters:
id(path, required): Model service ID
Request Body:
Project Structure
Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
Please see the CONTRIBUTING.md file for details on our code of conduct, and the process for submitting pull requests to us.
Reporting Issues
We use GitHub Issues to track public bugs. Report a bug by opening a new issue; it's that easy!
Dependencies
openapi-mcp-generator: OpenAPI specification generatorNote: This project requires a pending fix from the
openapi-mcp-generatorlibrary. See this pull request.
@modelcontextprotocol/sdk: MCP SDK for protocol implementationexpress: Web frameworkdotenv: Environment variable managementgot: HTTP client
Development Dependencies
TypeScript@types/express@types/node
License
MIT License - See LICENSE file for details