Openapi MCP Server 3wh

🚀 OpenAPI MCP Server

This is an example project that you can use as a starting point to build your own MCP server. The addition function in this example demonstrates how to implement handlers in all three protocols.

🚀 Quick Start

✨ Features

Current implementation status:

• ✅ Standard Input/Output (stdio)
• ✅ Server-Sent Events (SSE)
• ✅ OpenAPI/REST Endpoints

📦 Installation

The server supports three different operating modes, controlled by the MODE environment variable:

• stdio: Run as a standard I/O server.
• sse: Run as a Server-Sent Events server (port 8001).
• openapi: Run as an OpenAPI/REST server (port 8002).

Using Docker Compose

1. Build the container:

docker compose build

2. Run specific services:

# Run all services simultaneously
docker compose up

# Run only the SSE server
docker compose up sse-mcp-server

# Run only the OpenAPI server
docker compose up openapi-mcp-server

Using Docker Directly

You can also run the server directly using Docker:

# Run in stdio mode
docker run -i --rm -e MODE=stdio 3loc/openapi-mcp-server

# Run in SSE mode
docker run -p 8001:8000 --rm -e MODE=sse 3loc/openapi-mcp-server

# Run in OpenAPI mode
docker run -p 8002:8000 --rm -e MODE=openapi 3loc/openapi-mcp-server

🔧 Configuration

The server can be configured through a mcp.json file. Here is an example configuration:

{
  "mcpServers": {
    "stdio-mcp-server": {
      "command": "docker",
      "args": [
        "run",
        "--rm", 
        "-i",
        "--name", "openapi-mcp-server",
        "-e", "MODE=stdio",
        "3loc/openapi-mcp-server"
      ]
    },
    "sse-mcp-server": {
      "url": "http://localhost:8001/sse"
    }
  }
}

📚 Documentation

This project provides a foundation for implementing an MCP server with multiple communication protocols. All three modes (stdio, SSE, and OpenAPI) are now implemented and can be used interchangeably as needed.