This is a skeleton project that you can use as a starting point for building your own MCP server. The example addition function demonstrates how to implement handlers across all three protocols.
Overview
What is OpenAPI MCP Server?
OpenAPI MCP Server is a skeleton project designed to help developers build their own MCP (Multi-Channel Protocol) servers. It provides a foundational structure and an example addition function to demonstrate how to implement handlers across various protocols.
How to use OpenAPI MCP Server?
To use the OpenAPI MCP Server, you can build and run it using Docker or Docker Compose. You can choose to run it in different modes: standard I/O, Server-Sent Events (SSE), or OpenAPI/REST endpoints.
Key features of OpenAPI MCP Server?
- Supports multiple communication protocols: stdio, SSE, and OpenAPI/REST.
- Easy to configure using an
mcp.jsonfile. - Example implementation of an addition function.
Use cases of OpenAPI MCP Server?
- Building custom MCP servers for various applications.
- Implementing real-time data streaming using SSE.
- Creating RESTful APIs with OpenAPI specifications.
FAQ from OpenAPI MCP Server?
- What protocols does the OpenAPI MCP Server support?
It supports standard I/O, Server-Sent Events, and OpenAPI/REST endpoints.
- How can I run the server?
You can run the server using Docker or Docker Compose, specifying the desired mode through the
MODEenvironment variable.
- Is there an example configuration available?
Yes, the project includes an example
mcp.jsonconfiguration file for reference.