diffci_verify_workflow

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

No annotations are provided, so the description carries the full disclosure burden. It implies a read-only check but never says whether it mutates state, what a failing verification means, whether it exits with an error or returns a result, or what the agent should do with a negative outcome.

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?

A single front-loaded sentence with no filler. It is efficient, though its brevity is part of why coverage is thin elsewhere.

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 verification tool with no output schema and no annotations, the description should at minimum explain what a pass/fail looks like and what is examined. As written, an agent cannot tell what the tool returns or what 'cannot affect the rest of CI' concretely checks.

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 single 'repo' parameter has a full schema description including its default, so the schema does the work here. The description adds no meaning beyond it (e.g., whether the repo must contain DiffCI config or a workflow file).

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 names a verb ('Check') and a resource ('a DiffCI GitHub Actions job'), plus a goal ('cannot affect the rest of CI'), so the general intent is inferable. However, 'cannot affect the rest of CI' is ambiguous — it never states what is actually being validated (workflow isolation, path filtering, permissions) and gives no clue how it differs from the closely named siblings diffci_verify and diffci_verify_changed.

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?

There is no guidance on when to call this versus diffci_verify, diffci_verify_changed, or diffci_check, and no stated preconditions. The agent must guess based on name alone.

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