@openapi-mcp/server
About
Powerful bridge between OpenAPI specifications and AI assistants using the Model Context Protocol (MCP). Automatically converts any OpenAPI/Swagger API specification into MCP tools that can be used by AI assistants like Claude Desktop.
Details
- License
- MIT
Explore
> ⚠️ Note:
> This server requires every operation in your OpenAPI/Swagger specification to have an operationId. If any operation is missing an operationId, the server will fail to start or process the specification. Always ensure that all operations are explicitly assigned a unique and descriptive operationId.
- 🔌 OpenAPI Integration
- Automatically converts OpenAPI/Swagger specifications into MCP tools
- 📚 Multiple OpenAPI Versions
- Support for OpenAPI v3.0.0 and v3.1.0
- 🔐 Authentication Support:
- HTTP authentication schemes:
- Basic authentication
- Bearer token authentication (static tokens, e.g., Personal Access Tokens)
- Other HTTP schemes as defined by RFC 7235
- API keys:
- Header-based API keys
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
bun install
- BASE_URL
- Required: Yes
- Description: API endpoint. Server Object's URL
- HEADERS
- Required: No
- Default: {"Content-Type": "application/json","User-Agent": "openapi-mcp-server"}
- Description: Custom headers that will overwrite default headers
Claude Desktop / Cursor
Paste into your MCP client config file to install this server.
{
"mcpServers": {
"@openapi-mcp/server": {
"openapi-mcp-server-sotayamashita": {
"command": "bun",
"args": [
"run",
"src/index.ts",
"./path/to/openapi.yml"
]
}
}
}
}McpServers
{
"openapi-mcp-server-sotayamashita": {
"command": "bun",
"args": [
"run",
"src/index.ts",
"./path/to/openapi.yml"
]
}
}
The openapi-mcp-server is a powerful bridge between OpenAPI specifications and AI assistants using the Model Context Protocol (MCP). It automatically converts any OpenAPI/Swagger API specification into MCP tools that can be used by AI assistants like Claude Desktop. This enables AI assistants to seamlessly interact with your APIs, making them capable of performing real-world actions through your services without requiring custom integrations.
Features
> ⚠️ Note:
> This server requires every operation in your OpenAPI/Swagger specification to have an operationId. If any operation is missing an operationId, the server will fail to start or process the specification. Always ensure that all operations are explicitly assigned a unique and descriptive operationId.
- 🔌 OpenAPI Integration
- Automatically converts OpenAPI/Swagger specifications into MCP tools
- 📚 Multiple OpenAPI Versions
- Support for OpenAPI v3.0.0 and v3.1.0
- 🔐 Authentication Support:
- HTTP authentication schemes:
- Basic authentication
- Bearer token authentication (static tokens, e.g., Personal Access Tokens)
- Other HTTP schemes as defined by RFC 7235
- API keys:
- Header-based API keys
Limitations
⚠️ Version Support:
- [ ] OpenAPI v2.0 (Swagger) is not currently supported
⚠️ Authentication Limitations:
- [ ] OAuth 2.0 authentication is not supported
- [ ] OpenID Connect Discovery is not supported
- [ ] Query parameter-based API keys are not supported
- [ ] Cookie-based authentication is not supported
- [ ] Dynamic JWT authentication (login-generated tokens) is not supported
Installation
```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.
