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.
- 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 codebaseAuthProvider Guide - Detailed authentication patterns and examples
This section covers how to use the MCP server as an end user with Claude Desktop, Cursor, or other MCP-compatible tools.
This MCP server can be used in two ways:
- CLI Tool: Use
npx @ivotoby/openapi-mcp-serverdirectly with command-line arguments for quick setup - Library: Import and use the
OpenAPIServerclass in your own Node.js applications for custom implementations
The server supports two transport methods:
- Stdio Transport (default): For direct integration with AI systems like Claude Desktop that manage MCP connections through standard input/output.
- Streamable HTTP Transport: For connecting to the server over HTTP, allowing web clients and other HTTP-capable systems to use the MCP protocol.