Change Status

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

Expands on annotations by detailing automatic fetch of latest buildset when not in pipeline and the token reduction with 'brief'. No contradiction with annotations.

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?

Concise with a clear structure: main description followed by parameter list. Every sentence adds value, no redundancy.

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's complexity (4 optional parameters, output schema present), the description fully covers return behavior and parameter usage, making it self-contained.

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?

Provides meaningful examples for 'change', explains 'tenant' default behavior, describes 'url' as alternative, and explains 'brief' effect. Compensates for 0% schema description coverage.

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?

Clearly states the tool retrieves pipeline status for a specific change, differentiating from siblings by explicitly listing supported platforms (Gerrit, GitHub, GitLab) and the comprehensive return value.

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?

Describes when it returns live vs completed status and explains the benefit of the 'brief' parameter for polling. Implicitly suggests alternatives (list_buildsets + get_buildset) but does not explicitly state when not to use the tool.

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