Query Okareo Documentation
get_docsRead-onlyIdempotent
Query Okareo documentation to understand concepts like Scenarios, Checks, Targets, Drivers, Evaluations, and Simulations. Choose conceptual mode for technical detail or user_legible for plain-language explanations.
Instructions
Query the Okareo documentation system for information about Okareo primitives and workflows.
Use this tool when the agent or user needs to understand how Okareo
concepts work — Scenarios, Checks, Targets, Drivers, Evaluations,
and Simulations.
Two modes are available:
- 'conceptual': Detailed technical documentation for agent reasoning.
Default top_k=5 (returns up to 5 documentation entries).
- 'user_legible': Plain-language explanations for human users.
Default top_k=3 (returns up to 3 documentation entries).
If the Okareo documentation service is unavailable (e.g. air-gapped
environment), the tool returns a helpful error suggesting get_templates
as a fallback.
Args:
query: The question to ask the Okareo documentation system. Be
specific — e.g., 'How do Checks and Evaluations work together?'
or 'What is a Driver persona?'
mode: Documentation mode — 'conceptual' or 'user_legible'.
top_k: Number of documentation entries to return. Defaults to 5
for conceptual mode, 3 for user_legible mode. Maximum 10.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| mode | Yes | ||
| query | Yes | ||
| top_k | No |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |