OpenAPI MCP Server

What is OpenAPI MCP Server?

OpenAPI MCP Server is a skeleton project for building your own Model Context Protocol (MCP) server. It includes an example addition function and demonstrates how to implement handlers across all three supported protocols: Standard I/O (stdio), Server-Sent Events (SSE), and OpenAPI/REST endpoints.

How to use OpenAPI MCP Server?

Run the server using Docker or Docker Compose. Set the MODE environment variable to stdio, sse, or openapi to select the transport mode. Launch a specific service (e.g., docker compose up sse-mcp-server) or run directly with Docker (e.g., docker run -i --rm -e MODE=stdio 3loc/openapi-mcp-server). Configure the server using an mcp.json file.

Key features of OpenAPI MCP Server

• Supports three transport modes: stdio, SSE, and OpenAPI
• Provides a starting point for building custom MCP servers
• Includes an example addition function handler
• Deployable via Docker or Docker Compose
• Configurable through environment variable MODE
• Can be used with mcp.json configuration file

Use cases of OpenAPI MCP Server

• Starting point for developing a new MCP server
• Testing and prototyping MCP functionality across different transports
• Demonstrating how to implement MCP handlers for all three protocols
• Quick local deployment of a basic MCP server using Docker

FAQ from OpenAPI MCP Server

What operating modes does OpenAPI MCP Server support?

It supports three modes: stdio (standard I/O), sse (Server-Sent Events on port 8001), and openapi (OpenAPI/REST on port 8002).

How do I run OpenAPI MCP Server in SSE mode?

Use docker run -p 8001:8000 --rm -e MODE=sse 3loc/openapi-mcp-server or docker compose up sse-mcp-server.

How do I configure OpenAPI MCP Server?

Create an mcp.json file with the appropriate command/args for stdio mode or a URL for SSE mode. The server reads the MODE environment variable to select the transport.

What is included as an example in OpenAPI MCP Server?

The server includes an example addition function that demonstrates how to implement handlers across all three protocols.

What are the runtime requirements for OpenAPI MCP Server?

The server runs inside a Docker container. The image is 3loc/openapi-mcp-server. No other dependencies are listed.