Docflow Retry Review Rule

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

With no annotations, the description carries the full behavioral burden. It adds useful context about the retry being scoped to a single rule and not re-running other rules, but it does not disclose permissions, idempotency, whether previous results are overwritten, or what makes a rule retryable.

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 tightly written sentences. The action and endpoint are front-loaded, followed by precise usage context, with no redundant or filler content.

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 no annotations and zero schema-level parameter descriptions, some gaps remain: retryable rule states, error behavior, and whether a new review result is produced. The output schema covers return values and the input is simple, but the definition is not fully self-sufficient.

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?

Schema description coverage is 0%, so the description must compensate, but it does not explain the individual parameters or their relationships beyond the phrase 'single rule within a review task'. The IDs are self-explanatory by name, but the description adds no detail about formats, where to obtain them, or how they relate to other resources.

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?

States a specific action ('Retry evaluation of a single rule within a review task') and gives the endpoint. The explicit scope qualifier 'single rule' distinguishes it from sibling docflow_retry_review_task, so an agent can tell them apart immediately.

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?

Provides explicit when-to-use guidance: one specific rule failed or needs re-evaluation after updating its prompt. It also states the exclusion condition, 'without re-running all other rules in the task', which routes the agent away from task-level retry.

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