ivo-toby/mcp-openapi-server

A Model Context Protocol (MCP) server that exposes OpenAPI endpoints as MCP tools, along with optional support for MCP prompts and resources. This server allows Large Language Models to discover and interact with REST APIs defined by OpenAPI specifications through the MCP protocol.
## 📖 Documentation
User Guide - For users wanting to use this MCP server with Claude Desktop, Cursor, or other MCP clients
Library Usage - For developers creating custom MCP servers using this package as a library
Developer Guide - For contributors and developers working on the codebase
AuthProvider Guide - Detailed authentication patterns and examples
# User Guide
This section covers how to use the MCP server as an end user with Claude Desktop, Cursor, or other MCP-compatible tools.
## Overview
This MCP server can be used in two ways:
1. CLI Tool: Use npx @ivotoby/openapi-mcp-server directly with command-line arguments for quick setup
2. Library: Import and use the OpenAPIServer class in your own Node.js applications for custom implementations
The server supports two transport methods:
1. Stdio Transport (default): For direct integration with AI systems like Claude Desktop that manage MCP connections through standard input/output.
2. Streamable HTTP Transport: For connecting to the server over HTTP, allowing web clients and other HTTP-capable systems to use the MCP protocol.
## Quick Start for Users
### Option 1: Using with Claude Desktop (Stdio Transport)
No need to clone this repository. Simply configure Claude Desktop to use this MCP server:
1. Locate or create your Claude Desktop configuration file:
On macOS: ~/Library/Application Support/Claude/claudedesktopconfig.json
2. Add the following configuration:
json
"mcpServers": {
"openapi": {
"command": "npx",
"args": ["-y", "@ivotoby/openapi-mcp-server"],
"env": {
"APIBASEURL": "https://api.example.com",
"OPENAPISPECPATH": "https://api.example.com/openapi.json",
"APIHEADERS": "Authorization:Bearer token123,X-API-Key:your-api-key"
3. Replace the environment variables with your actual API configuration:
APIBASEURL: The base URL of your API
OPENAPISPECPATH: URL or path to your OpenAPI specification
APIHEADERS: Comma-separated key:value pairs for API authentication headers
### Option 2: Using with HTTP Clients (HTTP Transport)
To use the server with HTTP clients:
1. No installation required! Use npx to run the package directly:
bash
npx @ivotoby/openapi-mcp-server \
--api-base-url https://api.example.com \
--openapi-spec https://api.example.com/openapi.json \
--headers "Authorization:Bearer token123" \
--transport http \
--port 3000
2. Interact with the server using HTTP requests:
bash
# Initialize a session (first request)
curl -X POST http://localhost:3000/mcp \
-H "Content-Type: application/json" \
-d '{"jsonrpc":"2.0","id":0,"method":"initialize","params":{"protocolVersion":"2025-03-26","capabilities":{},"clientInfo":{"name":"curl-client","version":"1.0.0"}}}'
# The response includes a Mcp-Session-Id header that you must use for subsequent requests
# and the InitializeResult directly in the POST response body.
# Send a request to list tools
# This also receives its response directly on this POST request.