tru8_get_result

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

No annotations are provided, so the description carries the burden. It describes the return value in detail but does not explicitly state that the operation is read-only or non-destructive. However, the term 'retrieve' implies reading, and no side effects are mentioned. A bit more explicitness could improve confidence.

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 concise and well-structured. It starts with a clear purpose sentence, then describes the return value, then gives usage guidance, and finally lists the argument. No unnecessary words.

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 tool has an output schema (though not shown), the description explains what the output contains in detail (computed block, distributions, etc.). It covers the single parameter well and provides context for when to use the tool. It feels complete for a 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?

There is only one parameter, check_id. The schema has type 'string', and the description adds semantic meaning by stating it is a UUID returned by tru8_check. This helps the agent understand the parameter's source and format.

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 tool retrieves a previously submitted check with pre-computed analytics, using specific verb and resource. It also distinguishes itself from sibling tool tru8_get_result_raw by emphasizing structured analytics.

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?

Explicit guidance is provided: use this over tru8_get_result_raw when you want structured analytics for summarisation or comparison. This directly helps the agent decide which tool to use.

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