Getting Started
What klaridian is, how it fits together, and where to go next.
klaridian turns an OpenAPI (or Swagger 2.0) spec into a stateless Model Context Protocol server — in TypeScript or Python, with observability and tool curation wired in from the start. You run it a handful of times per project, review the plain output, and ship it.
Your first server
The fastest path is npx — no install step:
npx klaridian generate --spec ./api.yaml --out ./my-server --plugin otel
cd my-server && npm install && npm startPrefer a permanent install, or a native binary with no Node.js? See Installation for npm, PyPI, Homebrew, and prebuilt binaries.
How the pieces fit
klaridian is a CLI with three verbs, one per stage of the lifecycle:
generate— read the spec, emit the server. Everything structural is decided here: the target language, which operations become tools (curation), the architecture, the transport, auth, and any observability plugins.start— run a generated server locally, in either language. See Running the server.deploy— emit the artifacts a hosting platform needs (Docker, Cloudflare Workers, or Fly.io). See Deploy.
New to the flags? klaridian init asks a few questions and writes a configuration file, then prints the exact generate command to run.
What you get
- One MCP tool per operation in your spec, with names matching your
operationIds exactly — or just two tools for large specs with code-mode - A stateless server in TypeScript (default) or Python (
--language python), with identical tools, annotations, and observability across both - OpenTelemetry tracing and product-analytics events wired at generation time, if you pass a
--plugin - A real
LICENSEby default, and plain readable source you can audit before trusting it with credentials
Got a Swagger 2.0 spec? Pass it the same way — klaridian detects it and converts it to OpenAPI 3.0 before generating.
klaridian is a CLI today. There's no library mode yet (no import/require) — that's tracked separately, not built.
Next steps
- Curating the tool surface — control which operations become tools
- Code-mode architecture — for large specs
- Deploy — ship to Docker, Cloudflare, or Fly
- CLI reference — every flag
- Plugins: OpenTelemetry · PostHog