Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developers.klarity.ai/llms.txt

Use this file to discover all available pages before exploring further.

Before you install: enable the MCP in your Klarity workspace. Sign-in will fail until you do.
  • You can switch workspaces later by asking your AI assistant.
  • For other common install issues, see the FAQ.
Two install paths are supported. The plugin path is preferred — it ships the bundled skill prompt and uses OAuth.

Plugin install (preferred, OAuth)

From a Codex session:
/plugin marketplace add klarity-ai/klarity-mcp
/plugin install klarity@klarity
The first request that hits a Klarity tool will prompt you to sign in.

Config file install (API key)

Use this for long-running background agents. Generate an API key from Settings → MCP in your Klarity workspace (see Authentication) and add the server to ~/.codex/config.toml:
[mcp_servers.klarity_architect]
url = "https://architect-v2-api.klarity.ai/mcp"
bearer_token_env_var = "KLARITY_ARCHITECT_MCP_TOKEN"
Set the environment variable in your shell profile (~/.zshrc, ~/.bashrc):
export KLARITY_ARCHITECT_MCP_TOKEN=<YOUR_API_KEY>
Restart your terminal (or source the profile) so Codex picks up the new variable.
Treat the API key like a password. Rotate it from Settings → MCP in Klarity if it’s exposed.

Verify

In a Codex session, ask:
Search Klarity for AI transformation opportunities across our processes — where could we build skills or deploy agents?
The assistant should call search and return process results from your workspace.