OpenAPI MCP Server
A Model Context Protocol (MCP) server that exposes OpenAPI endpoints as MCP resources. This server allows Large Language Models to discover and interact with REST APIs defined by OpenAPI specifications through the MCP protocol.
Quick Start
You do not need to clone this repository to use this MCP server. You can simply configure it in Claude Desktop:
- Locate or create your Claude Desktop configuration file:
- On macOS:
~/Library/Application Support/Claude/claude_desktop_config.json
- On macOS:
- Add the following configuration to enable the OpenAPI MCP server:
- Replace the environment variables with your actual API configuration:
API_BASE_URL
: The base URL of your APIOPENAPI_SPEC_PATH
: URL or path to your OpenAPI specificationAPI_HEADERS
: Comma-separated key:value pairs for API authentication headers
Development Tools
This project includes several development tools to make your workflow easier:
Building
npm run build
- Builds the TypeScript sourcenpm run clean
- Removes build artifactsnpm run typecheck
- Runs TypeScript type checking
Development Mode
npm run dev
- Watches source files and rebuilds on changesnpm run inspect-watch
- Runs the inspector with auto-reload on changes
Code Quality
npm run lint
- Runs ESLintnpm run typecheck
- Verifies TypeScript types
Configuration
The server can be configured through environment variables or command line arguments:
Environment Variables
API_BASE_URL
- Base URL for the API endpointsOPENAPI_SPEC_PATH
- Path or URL to OpenAPI specificationAPI_HEADERS
- Comma-separated key:value pairs for API headersSERVER_NAME
- Name for the MCP server (default: "mcp-openapi-server")SERVER_VERSION
- Version of the server (default: "1.0.0")
Command Line Arguments
Development Workflow
- Start the development environment:
- Make changes to the TypeScript files in
src/
- The server will automatically rebuild and restart
- Use the MCP Inspector UI to test your changes
Debugging
The server outputs debug logs to stderr. To see these logs:
- In development mode:
- Logs appear in the terminal running
inspect-watch
- Logs appear in the terminal running
- When running directly:Copy
Contributing
- Fork the repository
- Create a feature branch
- Make your changes
- Run tests and linting:Copy
- Submit a pull request
License
MIT
This server cannot be installed
hybrid server
The server is able to function both locally and remotely, depending on the configuration or use case.
A server that enables Large Language Models to discover and interact with REST APIs defined by OpenAPI specifications through the Model Context Protocol.
Related Resources
Related MCP Servers
- -securityAlicense-qualityAn MCP server that exposes HTTP methods defined in an OpenAPI specification as tools, enabling interaction with APIs via the Model Context Protocol.Last updated -2PythonMIT License
- -securityFlicense-qualityA server based on Model Context Protocol that parses Swagger/OpenAPI documents and generates TypeScript types and API client code for different frameworks (Axios, Fetch, React Query).Last updated -1431TypeScript
- AsecurityFlicenseAqualityA Model Context Protocol server that enables large language models to interact with Apache Superset databases through REST API, supporting database queries, table lookups, field information retrieval, and SQL execution.Last updated -43TypeScript
- -securityAlicense-qualityA Model Context Protocol server that provides standardized interfaces for interacting with Ollama API, offering JSON responses, error handling, and intelligent guidance for LLM-based API calls.Last updated -PythonMIT License