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.

Use these tools when search results feel sparse, or when you need richer process metadata than fetch returns.
ToolWhen to use
search_processesLike search but returns mixed hierarchy-node + process results. Use when a top-level value stream or department might be a better starting point than a leaf process.
search_workspace_processesLookup by name / objective / team, not semantic. Use when you have an exact phrase or team filter.
get_process_hierarchy_treeBrowse the whole index structure. Use when search misses, or to orient before drilling in.
get_process_hierarchy_node_detailsInspect a single hierarchy node — parent, children, linked process.
get_process_detailFlat lookup by resource key or exact name. Light payload (name, objective, team, updated_at, source_url).
get_process_detailsThe rich nested payload: current_version, dependencies, hierarchy_node, optional version history. This is what fetch reshapes. Use directly when you need the structured shape.

Choosing among the lookup tools

  • Semantic, broadsearch (entry point) or search_processes (mixed results)
  • Exact phrase / team filtersearch_workspace_processes
  • You have a resource key / exact nameget_process_detail (light) or get_process_details (full)
  • Browse / orientget_process_hierarchy_tree, then get_process_hierarchy_node_details
  • Drill further (what actually happened on a specific process) → get_process_observationsget_observation_activity_timeline. See Process observations for the full toolset.

Common chains

  • “What’s in this value stream?” → get_process_hierarchy_treeget_process_hierarchy_node_details on the relevant node → get_process_details on each leaf
  • “Pull every dependency of process X” → get_process_details → walk the dependencies list with further get_process_details calls
  • “I have an exact name, give me the full payload” → get_process_detail (confirm match) → get_process_details (full structure)
  • “What actually happens when this process runs?” → get_process_detailsget_process_observationsget_observation_activity_timeline on a representative deviation