@openapi-mcp/server

by sotayamashita

7 stars

324 downloads

Not rated

GitHub

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

Author: sotayamashita
GitHub stars: 7
Downloads: 324
Categories: Developer Tools, API, AI

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/server

Command (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

Setting up with Cursor

Open Cursor's settings
Navigate to the MCP section
Click "Add new Global MCP server"
Copy and paste the configuration below based on your operating system

JSON

{
    "mcpServers": {
        "@openapi-mcp/server": {
            "openapi-mcp-server-sotayamashita": {
                "command": "bun",
                "args": [
                    "run",
                    "src/index.ts",
                    "./path/to/openapi.yml"
                ]
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "@openapi-mcp/server": {
            "openapi-mcp-server-sotayamashita": {
                "command": "bun",
                "args": [
                    "run",
                    "src/index.ts",
                    "./path/to/openapi.yml"
                ]
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "@openapi-mcp/server": {
            "openapi-mcp-server-sotayamashita": {
                "command": "bun",
                "args": [
                    "run",
                    "src/index.ts",
                    "./path/to/openapi.yml"
                ]
            }
        }
    }
}

Setting up with Claude Desktop

Open Claude Desktop's settings
Go to the Integrations tab
Click "Add MCP Server"
Use the configuration below based on your operating system

Note: Make sure Claude Desktop is running before attempting to connect.

JSON

{
    "mcpServers": {
        "@openapi-mcp/server": {
            "openapi-mcp-server-sotayamashita": {
                "command": "bun",
                "args": [
                    "run",
                    "src/index.ts",
                    "./path/to/openapi.yml"
                ]
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "@openapi-mcp/server": {
            "openapi-mcp-server-sotayamashita": {
                "command": "bun",
                "args": [
                    "run",
                    "src/index.ts",
                    "./path/to/openapi.yml"
                ]
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "@openapi-mcp/server": {
            "openapi-mcp-server-sotayamashita": {
                "command": "bun",
                "args": [
                    "run",
                    "src/index.ts",
                    "./path/to/openapi.yml"
                ]
            }
        }
    }
}

Setting up with Windsurf

Open Windsurf's preferences
Go to the Integrations section
Click "Add MCP Integration"
Use the configuration below based on your operating system

JSON

{
    "mcpServers": {
        "@openapi-mcp/server": {
            "openapi-mcp-server-sotayamashita": {
                "command": "bun",
                "args": [
                    "run",
                    "src/index.ts",
                    "./path/to/openapi.yml"
                ]
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "@openapi-mcp/server": {
            "openapi-mcp-server-sotayamashita": {
                "command": "bun",
                "args": [
                    "run",
                    "src/index.ts",
                    "./path/to/openapi.yml"
                ]
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "@openapi-mcp/server": {
            "openapi-mcp-server-sotayamashita": {
                "command": "bun",
                "args": [
                    "run",
                    "src/index.ts",
                    "./path/to/openapi.yml"
                ]
            }
        }
    }
}

Setting up with Cline

Open Cline's settings
Navigate to the Integrations section
Click "Add MCP Server"
Copy and paste the configuration below based on your operating system

Note: Make sure to restart Cline after adding the configuration.

JSON

{
    "mcpServers": {
        "@openapi-mcp/server": {
            "openapi-mcp-server-sotayamashita": {
                "command": "bun",
                "args": [
                    "run",
                    "src/index.ts",
                    "./path/to/openapi.yml"
                ]
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "@openapi-mcp/server": {
            "openapi-mcp-server-sotayamashita": {
                "command": "bun",
                "args": [
                    "run",
                    "src/index.ts",
                    "./path/to/openapi.yml"
                ]
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "@openapi-mcp/server": {
            "openapi-mcp-server-sotayamashita": {
                "command": "bun",
                "args": [
                    "run",
                    "src/index.ts",
                    "./path/to/openapi.yml"
                ]
            }
        }
    }
}

Setting up with Goose

Open Goose's preferences
Go to the Integrations tab
Select "MCP Servers"
Click "Add New Server"
Use the configuration below based on your operating system

JSON

{
    "mcpServers": {
        "@openapi-mcp/server": {
            "openapi-mcp-server-sotayamashita": {
                "command": "bun",
                "args": [
                    "run",
                    "src/index.ts",
                    "./path/to/openapi.yml"
                ]
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "@openapi-mcp/server": {
            "openapi-mcp-server-sotayamashita": {
                "command": "bun",
                "args": [
                    "run",
                    "src/index.ts",
                    "./path/to/openapi.yml"
                ]
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "@openapi-mcp/server": {
            "openapi-mcp-server-sotayamashita": {
                "command": "bun",
                "args": [
                    "run",
                    "src/index.ts",
                    "./path/to/openapi.yml"
                ]
            }
        }
    }
}

From the repository

Clone the repository, install dependencies with bun install, then run bun run src/index.ts with a path to a local OpenAPI file or --api with a URL. Configure the required BASE_URL environment variable and optional HEADERS environment variable. Integrate with Claude Desktop or Cursor by adding the server to their MCP configuration.

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"
        ]
    }
}

@openapi-mcp/server

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

No reviews yet — be the first

Use Google, GitHub, or an email account so ratings stay tied to real people.

Email sign in

No reviews posted yet.

About

Details

Jump to

Setting up with Highlight

From the repository

Claude Desktop / Cursor

McpServers

@openapi-mcp/server

Features

Limitations

Installation

Install

More like this

Sentry

Github

Git

GitLab

Context 7

1Panel