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.

The Klarity MCP exposes a read-only set of tools that an AI assistant can chain to answer real questions grounded in a customer’s workspace. The point of this reference is not to enumerate APIs — it’s to help you pick the right tool for the goal at hand.

How the toolset is organized

Every workflow reduces to: find the right process(es) → fetch detail → gather evidence → traverse relationships → synthesize.
GroupWhat it coversWhen to start here
Standard entry pointssearch, fetchThe default starting path for any process question
Process IndexHierarchy navigation, process details, workspace lookupsearch results feel sparse, or you need richer metadata than fetch returns
Process observationsRecent changes, observations, activity timelines”What changed?”, “what happened?”, “why does this run this way?”
VisualizationDiagram generationThe user wants to see the flow
ArtifactsDocument search, content retrieval, video framesThe user names a document or recording
Context GraphEntities, communities, relationships, lineageThe question is relational
ObjectivesAdvisor objective findings, actions, agent stateThe user is continuing in-flight transformation work
WorkspaceList workspaces, switch active workspace, attribute configsOrienting before drilling in, or switching context
Schema & webDatabase schema, raw SQL, web researchLast-resort fallback for analytics or external context

Before you call

Read Operating principles — the conventions for staying grounded, iterating on search, separating observed from inferred, and avoiding common mis-uses (treating search_* snippets as final answers, exposing internal IDs in user-facing prose, calling switch_mcp_workspace without permission).

What the assistant should do with results

A human using the Advisor might use two or three tools per question. An assistant in an agentic loop can chain ten or more — searching, drilling in, cross-referencing, synthesizing. The whole point of the MCP is that composition is the value. See How-to guides for end-to-end recipes.