compare_artifact_pipelines

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

The description adds a key behavioral detail not captured by annotations: it does not return native artifact content. This clarifies the output nature beyond the readOnlyHint, which only indicates safety. However, it does not elaborate on compatibility criteria or potential errors.

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 a single, well-structured sentence that is front-loaded with the main verb and object. Every word contributes meaning, and there is no redundancy or filler.

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?

For a comparison tool with two required parameters, an output schema, and rich annotations, the description is adequate but minimal. It clarifies that native artifact content is not returned, which is helpful, but it leaves 'compatible' ambiguous and does not explain the purpose of the comparison beyond the tool name. Given the output schema, the agent can infer return structure, so this is above the minimum but not fully fleshed out.

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 schema has 0% description coverage, so the description must compensate. While the parameter names (baseline_pipeline_id, candidate_pipeline_id) are fairly self-explanatory, the description adds only 'compatible ordered stages' which implies the two pipelines are expected to have compatible structure. It does not explicitly tie the parameters to their roles or explain any format expectations.

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 action ('Compare') and the object ('compatible ordered stages'), and the phrase 'without returning native artifact content' distinguishes it from artifact extraction tools. The tool name 'compare_artifact_pipelines' reinforces the resource being compared.

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?

No guidance is provided on when to use this tool versus alternatives. It does not mention scenarios where comparison is appropriate, nor does it reference similar tools like compare_run_sets or artifact extraction tools. The context from siblings is not exploited.

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