Skip to main content

openapi-atlas-mcp

openapi-atlas-mcp aggregates multiple OpenAPI/Swagger specifications from your backend services into a single searchable, documentation-focused Model Context Protocol server. It lets an AI agent (Claude Desktop, Cursor, Claude Code, VS Code) answer questions like "show me the payload for submit order" across all of your configured services in one query — instead of making you hunt through N separate Swagger UIs.

Install

# pip
pip install openapi-atlas-mcp

# uv (recommended for MCP servers)
uv tool install openapi-atlas-mcp

Quick start

  1. Create a config file (.openapi-atlas.json) in your project root:
openapi-atlas-mcp init

This launches an interactive wizard. Or write the file manually:

{
  "services": [
    {
      "name": "orders",
      "url": "http://localhost:8000"
    },
    {
      "name": "billing",
      "url": "https://billing.internal.example.com",
      "auth": {
        "type": "bearer",
        "token_env": "BILLING_API_TOKEN"
      }
    }
  ]
}
  1. Set any required environment variables:
export BILLING_API_TOKEN=your-secret-token
  1. Start the server:
openapi-atlas-mcp serve

Agent-host integration

Claude Desktop (claude_desktop_config.json)

{
  "mcpServers": {
    "openapi-atlas": {
      "command": "uv",
      "args": ["tool", "run", "openapi-atlas-mcp", "serve"]
    }
  }
}

Cursor (.cursor/mcp.json)

{
  "mcpServers": {
    "openapi-atlas": {
      "command": "openapi-atlas-mcp",
      "args": ["serve"]
    }
  }
}

Claude Code

claude mcp add openapi-atlas -- openapi-atlas-mcp serve

VS Code

Add to .vscode/mcp.json:

{
  "servers": {
    "openapi-atlas": {
      "command": "openapi-atlas-mcp",
      "args": ["serve"]
    }
  }
}

Configuration reference

The config file (.openapi-atlas.json or path via OPENAPI_ATLAS_CONFIG env var):

Field Type Required Description
services ServiceConfig[] Yes One or more backend services to aggregate
auth AuthConfig | null No Global default auth (overridable per-service)
allow_insecure_http_hosts string[] No Hosts allowed for plain HTTP (e.g. ["localhost"])
cache.spec_ttl_seconds int No Spec cache TTL in seconds (default: 60)
cache.disk_cache_dir string | null No Custom disk cache directory

ServiceConfig

Field Type Required Description
name string Yes Unique service identifier
url string Yes Base URL of the service (must include scheme)
spec_path string | null No Explicit spec path (e.g. /api/openapi.json). Auto-discovered if omitted.
auth AuthConfig | null No Per-service auth override

AuthConfig

Secrets are referenced by env-var name — never inline. See docs/auth.md for patterns.

Type Required fields Behavior
none (none) No auth headers sent
bearer token_env Sends Authorization: Bearer <env value>
basic username_env, password_env Sends Authorization: Basic <base64>
headers headers_env Sends custom headers from a JSON env var

Tools

Tool Description
search_endpoints Keyword-search operations across all services. Returns ranked matches with scores.
get_endpoint_detail Returns the fully $ref-resolved schema for one endpoint.
list_services Lists all configured services with health, version, and freshness metadata.
refresh_specs Force a fresh fetch of one or all services. Clears caches.

When things go wrong

Symptom Likely cause Fix
ConfigNotFoundError No .openapi-atlas.json found Run openapi-atlas-mcp init or set OPENAPI_ATLAS_CONFIG
MissingEnvVarError Referenced env var not set export BILLING_API_TOKEN=...
InsecureHttpHostError Plain HTTP to non-localhost Add host to allow_insecure_http_hosts
Service shows unhealthy Service unreachable Check URL, auth, and network connectivity
Service shows degraded Serving stale cache Service was up before; check if it restarted
Empty search results No services indexed yet Call refresh_specs or check service health

See docs/errors.md for the full warning catalog.

License

MIT

Metadata

Release files for openapi-atlas-mcp 0.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for openapi-atlas-mcp 0.0.1
File Size Uploaded Provenance Actions
openapi_atlas_mcp-0.0.1.tar.gz 256.7 kB Without provenance Details for openapi_atlas_mcp-0.0.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for openapi-atlas-mcp 0.0.1
File Interpreter ABI Platform Actions
openapi_atlas_mcp-0.0.1-py3-none-any.whl Python 3 none any Details for openapi_atlas_mcp-0.0.1-py3-none-any.whl

Total release size: 303.2 kB

Release files / openapi_atlas_mcp-0.0.1.tar.gz

Download URL openapi_atlas_mcp-0.0.1.tar.gz
Size 256.7 kB
Tags Source
SHA-256 checksum
How to use checksums
5a9eac548b62f96d4d1ed54b2f83067bac573743f06667537b9e8869e262861c
BLAKE2b-256 checksum
How to use checksums
f0659854ae84d5d5574d577c784b36c9c9264fe35e38f88f9cdf8775c2297c32
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.9.21 {"installer":{"name":"uv","version":"0.9.21","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Release files / openapi_atlas_mcp-0.0.1-py3-none-any.whl

Download URL openapi_atlas_mcp-0.0.1-py3-none-any.whl
Size 46.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
a88477c5c4cb4d38508a98db3f019800f9407117adfc15d5f64a9e0253c28e4d
BLAKE2b-256 checksum
How to use checksums
b7bee75b47ed9107cf1f94822232e09f329605d406d81136a0b3663e6b2f02ed
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.9.21 {"installer":{"name":"uv","version":"0.9.21","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Security for openapi-atlas-mcp 0.0.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.0.1 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page