Getting started

From OpenAPI and docs to a working MCP surface.

If you already have an API, the path is simple: create a project, upload a spec, publish docs, generate an API key, and connect your MCP client.

1

Create a project and upload your OpenAPI spec

Create a tenant and project, then upload your OpenAPI 3.x file. Frege validates the spec, extracts operations, and turns them into MCP tools. You can also work in the built-in editor and publish a draft when it is ready.

# Example project shape Tenant: acme Project: payments Spec: openapi.yaml # Resulting MCP base path /mcp/acme/payments
2

Publish docs and choose how you want to operate versions

Upload markdown docs so agents can read the same product documentation your human users rely on. Frege exposes that material through the docs endpoint and keeps it aligned with the project version history.

Each publish creates an immutable version you can compare, activate, archive, or pin explicitly in a route. That lets you migrate MCP clients without forcing every consumer onto the latest change immediately.

# Default routes use the active version Tools: https://your-domain.com/mcp/acme/payments Docs: https://your-domain.com/mcp/acme/payments/docs # Version-pinned tools route https://your-domain.com/mcp/acme/payments/v2/tools
3

Generate an API key and connect your MCP client

Create an API key in the dashboard, then add the Frege endpoint to your MCP client. Claude Desktop, Cursor, Codex, and Amp can all connect to the same hosted surface.

# Claude Desktop example { "mcpServers": { "payments": { "url": "https://your-domain.com/mcp/acme/payments", "headers": { "Authorization": "Bearer frege_your_api_key" } } } }

Once connected, the client can list tools, call operations, and read docs. If you later need stricter rollout control, you can move clients onto a pinned version path.

What you can do next

  • Inspect the API in both HTTP and MCP form using the workspace and explorer views.
  • Grant or revoke tool access for API keys, users, and organizations through the access matrix.
  • Publish docs updates through the markdown editor and keep them in the same versioned workflow.
  • Configure webhooks so active MCP sessions can subscribe to live events.
  • Share a connect page with downstream users or customers for self-serve onboarding.

Open the dashboard and ship the first version.

Frege is at its best when you already have an API and want a production-grade MCP surface around it.