openapi

This MCP server acts as a stateless proxy that dynamically creates an MCP interface from any OpenAPI schema endpoint. You supply a base64url-encoded JSON payload in the MCP URL that includes the OpenAPI schema URL and the API base URL, and the server exposes a consistent MCP interface for interacting with that API. Typical usage involves pointing your MCP client at a URL like http://localhost:8787/mcp/{base64Payload}, where the payload encodes schemaUrl and baseUrl. The server then handles translation between MCP requests (tools and resources) and standard OpenAPI-defined endpoints, enabling operations such as listing resources, retrieving data, and performing actions defined by the API’s operations. A hosted service is also available at bridge.openapitomcp.com, which you can substitute in place of localhost in your configuration if you don’t want to run your own instance locally. Tools and resources exposed by the MCP server vary by the underlying OpenAPI definition but typically include common CRUD-style operations and any custom endpoints described in the OpenAPI specification.

Prerequisites:

• Node.js and npm installed on your system
• Basic familiarity with running npm scripts

1. Clone or download the repository for the OpenAPI MCP Server.
2. Install dependencies:

npm install

3. Run the service locally (development mode):

npm run dev

4. The server will be available at http://localhost:8787. If you modify environment settings, ensure that the port matches your local setup or update the running command accordingly.

Optional: If you want to deploy to a hosted environment, package.json scripts or the hosting provider’s instructions may differ; refer to the repository's docs for any deployment-specific steps.

Notes and tips:

• The MCP URL expects a base64url-encoded JSON payload. Example payloads typically include schemaUrl (OpenAPI schema endpoint) and baseUrl (the API’s base URL).
• If you use the hosted service at bridge.openapitomcp.com, replace http://localhost:8787 with https://bridge.openapitomcp.com in your payload URL.
• Ensure the OpenAPI schema you point to is publicly accessible or otherwise reachable from the environment where the MCP server runs.
• Some OpenAPI schemas require authentication or special headers; configure these in the payload or via server environment variables if supported.
• When deploying behind a proxy or CDN (e.g., Cloudflare Workers), verify that request paths and payload encoding are preserved correctly to avoid payload decoding errors.
• If you encounter issues loading a schema, verify that the schemaUrl is reachable and that the schema itself is valid OpenAPI (3.x) definitions.