Get status updates

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

No annotations are provided, and the description only discloses the return structure. It fails to mention any behavioral aspects such as side effects, authentication needs, rate limits, or whether it is a read-only operation.

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?

Two sentences, no wasted words. Front-loads the verb and resource, and provides the return structure concisely.

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?

The description covers the main use cases and return format, but it does not clarify that `type` is always required (even with `id`), nor does it explain conditional requirements for `project` or `initiative` when listing. The `limit` parameter is also not mentioned.

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?

The description adds significant context beyond the schema, clarifying the dual mode (get by id vs list by type) and the return format. It explains how `type` and `id` relate, which the schema alone does not fully convey.

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 status updates either by id or lists for a project/initiative, specifying the return format. It distinguishes from siblings implicitly by focusing on status updates, but doesn't explicitly contrast with other list tools.

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 explains when to use the tool for fetching or listing, but does not provide guidance on when not to use it (e.g., for creating or updating) or mention alternative tools like save_status_update.

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