OpenAPI MCP Server
About
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.
Explore
Current implementation status:
- ✅ Standard I/O (stdio)
- ✅ Server-Sent Events (SSE)
- ✅ OpenAPI/REST endpoints
Setting up with Highlight
This MCP is not yet compatible with Highlight’s one-click setup. However, you can still use it with Highlight by following these steps:
- Download and install Highlight from highlightai.com/download
- Navigate to the plugins tab and select "Add Custom Plugin"
-
Configure the plugin with the settings below
Plugin Name
OpenAPI MCP ServerCommand (node, npx, python, etc.)Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.
- Enable "Start Automatically" if you want the plugin to start when Highlight launches
From the repository
The server can be configured using an mcp.json file. Here's 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"
}
}
}
The server supports three different modes of operation, 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)
Claude Desktop / Cursor
Paste into your MCP client config file to install this server.
{
"mcpServers": {
"openapi mcp server": {
"openapi-mcp-server-3loc": {
"command": "docker",
"args": [
"compose",
"build"
]
}
}
}
}McpServers
{
"openapi-mcp-server-3loc": {
"command": "docker",
"args": [
"compose",
"build"
]
}
}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.
Features
Current implementation status:
- ✅ Standard I/O (stdio)
- ✅ Server-Sent Events (SSE)
- ✅ OpenAPI/REST endpoints
Running Modes
The server supports three different modes of operation, 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)
Building and Running
Using Docker Compose
1. Build the container:
docker compose build
2. Run specific services:
```bash
Sign in to leave a review
Use Google, GitHub, or an email account so ratings stay tied to real people.
No reviews posted yet.
