Add it to Claude Code
claude mcp add mcp-openapi -- npx -y mcp-openapi --spec https://petstore3.swagger.io/api/v3/openapi.jsonMake your agent remember this setup
mcp-openapi's config, env vars, and the gotchas you hit — recalled in every future Claude Code, Cursor, and Codex session.
npx conare@latestFree · one command · indexes the sessions already on disk. Set up in the browser instead →
What it does
- Instant conversion of OpenAPI 3.x specs into Claude tools
- Automatic resolution of all $ref references
- Supports both JSON and YAML specification formats
- Built-in authentication support for Bearer, API Key, and Basic Auth
- Two-tool design for clear discover-and-call workflows
Tools 2
list_endpointsReturns all operations grouped by tag with operationIds, methods, paths, and required parameterscall_endpointExecutes any operation by operationId with path/query/body parametersEnvironment Variables
OPENAPI_BEARER_TOKENBearer token for Authorization headerOPENAPI_API_KEYAPI key valueOPENAPI_API_KEY_HEADERHeader name for API key (default: X-Api-Key)OPENAPI_BASIC_USERHTTP Basic auth usernameOPENAPI_BASIC_PASSHTTP Basic auth passwordTry it
Original README from saurav61091/mcp-openapi
mcp-openapi
Turn any OpenAPI spec into MCP tools for Claude — instantly.
Point mcp-openapi at any OpenAPI 3.x spec and Claude can call every endpoint through natural language. No custom integration code. No manual tool definitions. One line of config.
Quick start
Add to your Claude Desktop / Cursor / Cline MCP config:
{
"mcpServers": {
"my-api": {
"command": "npx",
"args": ["-y", "mcp-openapi", "--spec", "https://petstore3.swagger.io/api/v3/openapi.json"]
}
}
}
That's it. Claude can now discover and call every endpoint in that API.
Example conversation
You: What pets are available, and add a new dog named Buddy
Claude: Let me check what's available first. [calls
list_endpoints→ seesfindPetsByStatus,addPet, etc.] [callscall_endpointwithfindPetsByStatus,status=available]There are 3 pets currently available. Now I'll add Buddy... [calls
call_endpointwithaddPet, body{"name":"Buddy","status":"available"}]Done! Buddy has been added with ID 12345.
Authentication
Pass credentials via environment variables:
{
"mcpServers": {
"my-api": {
"command": "npx",
"args": ["-y", "mcp-openapi", "--spec", "https://api.example.com/openapi.json"],
"env": {
"OPENAPI_BEARER_TOKEN": "your-token-here"
}
}
}
}
| Variable | Description |
|---|---|
OPENAPI_BEARER_TOKEN |
Bearer token → Authorization: Bearer <token> |
OPENAPI_API_KEY |
API key value |
OPENAPI_API_KEY_HEADER |
Header name for API key (default: X-Api-Key) |
OPENAPI_BASIC_USER |
HTTP Basic auth username |
OPENAPI_BASIC_PASS |
HTTP Basic auth password |
Tools
mcp-openapi exposes exactly two tools:
| Tool | Description |
|---|---|
list_endpoints |
Returns all operations grouped by tag with operationIds, methods, paths, and required parameters |
call_endpoint |
Executes any operation by operationId with path/query/body parameters |
The two-tool design means Claude always has a clear workflow: discover → call.
Using a local spec file
{
"mcpServers": {
"my-api": {
"command": "npx",
"args": ["-y", "mcp-openapi", "--spec", "/path/to/your/openapi.yaml"]
}
}
}
Supports both JSON and YAML specs. All $ref references are resolved automatically.
Requirements
- Node.js 18+
- OpenAPI 3.x spec (JSON or YAML, local file or URL)
Real-world examples
Stripe API:
["--spec", "https://raw.githubusercontent.com/stripe/openapi/master/openapi/spec3.json"]
GitHub REST API:
["--spec", "https://raw.githubusercontent.com/github/rest-api-description/main/descriptions/api.github.com/api.github.com.json"]
Your internal API:
["--spec", "http://localhost:8080/openapi.json"]
CLI usage
# From URL
npx mcp-openapi --spec https://api.example.com/openapi.json
# From file
npx mcp-openapi --spec ./openapi.yaml
# With auth
OPENAPI_BEARER_TOKEN=mytoken npx mcp-openapi --spec https://api.example.com/openapi.json
# Help
npx mcp-openapi --help
How it works
- At startup, loads the spec from the given URL or file path
- Dereferences all
$refschemas using@apidevtools/swagger-parser - Registers two MCP tools with the connected client
list_endpointsgenerates a human+LLM-readable summary of all operationscall_endpointresolves path params, builds the URL, attaches auth headers, and returns the response
License
MIT