describe_ocel

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Since no annotations are provided, the description carries the full burden. It discloses re-computation on demand, the eviction behavior (1-hour TTL or LRU overflow), and the error exception ('HandleNotFound'). It could mention read-only nature but is fairly transparent.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is two sentences with no waste, front-loading the core purpose. It uses technical terms efficiently without excess.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the presence of an output schema, the description appropriately focuses on non-obvious details (re-computation, eviction, error). It could be improved by explicitly linking the parameter to a prior action, but is largely complete for a simple retrieval tool.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

With schema description coverage at 0%, the tool description does not explain the 'ocel_id' parameter beyond the implicit context of 'previously loaded OCEL'. It fails to specify what value to use (e.g., the ID from load_ocel's response), leaving the agent to infer meaning.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the verb 'Return' and resource 'compact summary for a previously loaded OCEL', distinguishing it from siblings like 'describe_log' (for logs) and 'load_ocel' (which returns summary on load, not on demand).

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implies usage for retrieving an OCEL summary on demand after loading, but does not explicitly state when to use versus alternatives like 'describe_log' or address prerequisites (e.g., must have called 'load_ocel' first).

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.