Skip to main content

mcpify

Python License

English | Türkçe

mcpify in action — listing and serving OpenAPI endpoints as MCP tools

Tests CodeQL Platforms MCP Registry CI Python Code style: ruff Types: mypy PyPI PyPI Downloads Run with uvx Dependencies

Turn any OpenAPI REST API into an MCP server — so Claude Code, Cursor, and every other MCP client can call your API directly. One command. Zero dependencies.

Your company has a REST API. Your AI agent needs to call it. Until now that meant hand-writing a custom MCP server for every API. With mcpify:

mcpify serve https://your-company.com/openapi.json

That's it — every endpoint just became a tool your AI agent can discover, understand, and call.

Deep docs: Usage guide — auth patterns, scoping, Docker, troubleshooting · Architecture · Contributing · Changelog · Security

The launch story: How a live weather API broke this tool — and made it better

Why you'll like it

  • 60 seconds to working — point it at any OpenAPI 3.x spec (file or URL)
  • Credentials never touch the spec or the model — pulled from your environment at call time (--auth-env), sent as Authorization: Bearer, a custom header, or a query parameter
  • Every operation becomes a first-class MCP tool — input schemas are generated from parameters + requestBody, internal $refs are resolved
  • Scope it down--read-only (GET only), --tag payments, --include /v1/orders, --exclude /admin, plus a policy layer for real-world APIs: --deny REGEX hides mutating GETs, --allow REGEX re-includes read-style POST endpoints. Deny always wins.
  • mcpify doctor — tells you if your spec is agent-friendly before you ship
  • Operational, not just functional. mcpify init wizard + .mcpify.toml configs with per-environment sections, GET response caching (--cache-ttl), safe retries (--retry — idempotent methods only, 502/503/504 only), verbose/log-file logging with masked credentials, XML→JSON conversion, strict argument mode, origin auto-discovery, legacy batch tolerance, and a health probe (mcpify status / mcpify_health)
  • Zero dependencies — one pure-Python file tree; YAML specs need an optional pip install 'mcpify[yaml]'
  • Agent-grade surface. Tool annotations derived from HTTP semantics (clients auto-approve read-only tools), structured output via MCP outputSchema/structuredContent, remediation-grade errors that teach the next call, dry-run request previews, and a --lazy search-then-call mode that cut api.weather.gov's listing by 95.5% (38,882 → 1,741 chars)
  • 162 tests across eleven suites — including a full MCP protocol run over stdio against a real local HTTP API and the live api.weather.gov document (69 tools, 16 enum'd parameters)

Quick start

# run without installing (uvx — pulls from PyPI on demand)
uvx --from mcpify-openapi mcpify list ./openapi.json --read-only

# first time? the wizard writes a config for you
uvx --from mcpify-openapi mcpify init

# or install (installs the `mcpify` command)
pipx install mcpify-openapi

# ...as a container (GHCR, published on every release)
docker run -i ghcr.io/furkan708/mcpify:latest serve ./openapi.json --read-only

# ...or from source
git clone https://github.com/furkan708/mcpify.git
cd mcpify && pip install .

# 1. preview the tools that will be generated
mcpify list examples/petstore.json

# 2. validate the spec is agent-friendly
mcpify doctor examples/petstore.json

# 3. serve it over MCP
mcpify serve examples/petstore.json --base-url https://petstore.example.com/v1

With authentication

# Bearer token read from the environment (never hardcoded)
export PETSTORE_KEY="sk-..."
mcpify serve petstore.json \
  --base-url https://petstore.example.com/v1 \
  --auth-env PETSTORE_KEY \
  --auth-style bearer \
  --read-only
Flag Meaning
--auth-env VAR environment variable holding the credential
--auth-style bearer|header|query how it is sent
--auth-name NAME header / query name for non-bearer styles (e.g. X-API-Key)

Plug it into your agent

Claude Code:

claude mcp add my-api -- mcpify serve openapi.json --read-only

Claude Desktop / Cursor / any MCP client (claude_desktop_config.json):

{
  "mcpServers": {
    "petstore": {
      "command": "mcpify",
      "args": ["serve", "~/specs/petstore.json", "--auth-env", "PETSTORE_KEY"]
    }
  }
}

Now ask your agent: "list the pets, then create one named Milo" — it discovers list_pets and create_pet, fills the arguments, and performs real HTTP calls.

How operations become tools

OpenAPI mcpify
operationId tool name (sanitized; falls back to method_path)
summary / description tool description the agent reads
deprecated: true shown by mcpify list before you expose old endpoints
parameters (path/query/header) individual typed arguments with enums
requestBody (JSON) a body object argument
$ref pointers resolved inline (components → real schemas)
servers[0].url default base URL (override: --base-url)

The agent only ever sees the tool list and your API's JSON responses — mcpify adds no middleware, caches nothing, and sends credentials nowhere except your API.

Doctor

$ mcpify doctor my-api.json
openapi: 3.0.3
title:   Acme API
paths:   23
tools:   41 operations
servers: https://api.acme.com
warning: 12/41 operations have no operationId (names fall back to method_path)
warning: 30/41 operations have no summary (agents see no description)

CLI reference

mcpify list <spec> [--tag T] [--include P] [--exclude P] [--read-only] [--json]
mcpify serve <spec> [--base-url URL] [--name N] [--auth-env VAR]
                    [--auth-style bearer|header|query] [--auth-name NAME]
                    [--timeout S] [--read-only] [--tag T] [--include P] [--exclude P]
mcpify doctor <spec>

Notes & limitations

  • JSON specs work out of the box; YAML specs need pip install 'mcpify[yaml]'
  • Only local $ref pointers are resolved (bundle external docs first — most tools do anyway)
  • Request bodies are exposed as a single body object argument — predictable over clever
  • Spec versions: OpenAPI 3.x and Swagger 2.x roots are accepted; 3.x is the happy path

Hardened against the real world

mcpify is audited on every release against a 10-category checklist of MCP best practices and published production failure modes — not just our own examples:

  • Hostile-spec corpus (12/12): circular $refs, multipart uploads, allOf schemas, server URL variables, relative base URLs, oversized responses — every scenario derived from a documented real-world failure, fixed, and locked in by a regression test. Sources include the arXiv study of REST→MCP generation across 18 real APIs.
  • Live integration: the real api.weather.gov spec loads in CI — the case that found (and fixed) our last crash-class bug.
  • MCP lifecycle enforced: tools are unreachable until the client completes the initialize handshake.
  • Blast-radius controls: read-only mode, deny/allow policy layer, 40k-char response truncation, --timeout, credentials never logged.

Full checklist with per-item status: docs/AUDIT-CHECKLIST.md

Tests

162 passing, plus one live-integration test that loads the real api.weather.gov document (auto-skipped when offline). Every suite runs on Python 3.10–3.12 across Linux and Windows; ruff, strict mypy and CodeQL gate every push.

Suite Tests What it pins down
Spec parsing & resolution 13 OpenAPI 3.x + YAML loading, $ref chains, allOf merge, server variables, malformed input
Tool translation 19 operationId naming with collision suffixing, input schemas, enums, body handling, annotation & output-schema derivation
Agent surface 31 HTTP-derived annotations, structured output contract, remediation errors, --lazy search, dry-run previews
CLI 15 list / doctor / serve flags, --json output, deprecated badges
Hostile corpus 11 circular $refs, multipart bodies, relative base URLs, 300 KB truncation, 500-op performance — each traced to a documented real-world failure
Lifecycle & hygiene 8 initialize handshake (-32002), byte-pure stdio, credentials never logged
Protocol end-to-end 9 real JSON-RPC over stdio against a live local HTTP API, wire-level assertions
Policy layer 7 --read-only, --allow / --deny precedence, mutating-GET protection
$ref parameters 4 parameter schemas resolved against the full spec — the weather.gov bug class (one test hits the live document)
Ops & configuration 41 config files + env precedence, init wizard, cache TTL & bounds, retry safety, XML conversion, discovery, batching, status/health
Protocol version compat 5 2026-07-28 stateless _meta requests and the legacy 2025-06-18 handshake, on the same wire

Policy on failures: every bug found in the wild becomes a pinned regression test before the fix ships — the suite only grows.

Run it locally:

pip install pytest pyyaml
pytest -v

Project Structure

mcpify/
├── mcpify/
│   ├── spec.py        # OpenAPI loading, $ref resolution, operation walking
│   ├── tools.py       # operation -> MCP tool, argument -> HTTP request
│   ├── http_client.py # execution (urllib, HTTP errors become tool results)
│   ├── api_server.py  # MCP stdio server (JSON-RPC 2.0)
│   └── cli.py         # list / serve / doctor
├── examples/petstore.json
└── tests/

Roadmap

  • --output-server FILE — generate a standalone, shareable server script
  • Per-operation rate limiting
  • OAuth2 client-credentials flow

License

MIT — see the LICENSE file for details.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mcpify_openapi-1.5.0.tar.gz (59.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mcpify_openapi-1.5.0-py3-none-any.whl (39.3 kB view details)

Uploaded Python 3

File details

Details for the file mcpify_openapi-1.5.0.tar.gz.

File metadata

  • Download URL: mcpify_openapi-1.5.0.tar.gz
  • Upload date:
  • Size: 59.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for mcpify_openapi-1.5.0.tar.gz
Algorithm Hash digest
SHA256 b492c0e88c43e44ef219a3cf58855826f77e55a7325c115965a36cb892a5084c
MD5 f09c60f2e15e944b001a38c8984dd90e
BLAKE2b-256 875d6869a6cb8912598137239a2999ba08dcdce15d133c62871fe84e5fb3cddc

See more details on using hashes here.

Provenance

The following attestation bundles were made for mcpify_openapi-1.5.0.tar.gz:

Publisher: release.yml on furkan708/mcpify

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file mcpify_openapi-1.5.0-py3-none-any.whl.

File metadata

  • Download URL: mcpify_openapi-1.5.0-py3-none-any.whl
  • Upload date:
  • Size: 39.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for mcpify_openapi-1.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3cad657c24637b21b5dc8034933b77c205225ce33f36313822f662408c49a251
MD5 5a6cc30af013767a6e4c38f65eda14ea
BLAKE2b-256 dd4ce95a930e740a9a34587b59f60955f5309fd1d27a1f5e530e3e36f29012df

See more details on using hashes here.

Provenance

The following attestation bundles were made for mcpify_openapi-1.5.0-py3-none-any.whl:

Publisher: release.yml on furkan708/mcpify

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

1.19.0

2 files

1.18.1

2 files

1.18.0

2 files

1.17.2

2 files

1.17.1

2 files

1.17.0

2 files

1.16.1

2 files

1.16.0

2 files

1.15.0

2 files

1.14.0

2 files

1.13.0

2 files

1.12.1

2 files

1.12.0

2 files

1.11.0

2 files

1.10.0

2 files

1.9.1

2 files

1.9.0

2 files

1.8.0

2 files

1.7.0

2 files

1.6.2

2 files

1.6.1

2 files

1.6.0

2 files

1.5.3

2 files

1.5.2

2 files

1.5.1

2 files

This release

1.5.0 This release

2 files

1.4.0

2 files

1.3.0

2 files

1.2.0

2 files

1.1.0

2 files

1.0.4

2 files

1.0.3

2 files

1.0.2

2 files

1.0.1

2 files

1.0.0

2 files

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