Docflow Get Review Repo

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

With no annotations provided, the description carries the behavioral disclosure burden. It explicitly states this is a GET operation and frames it as inspection, which implies a non-mutating read. It does not mention auth or error behavior, but that is acceptable for a simple read tool.

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 efficiently written sentences: the first states the verb, resource, scope, and endpoint, while the second gives a practical usage guideline. Every sentence earns its place with no 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?

The description covers the tool's purpose and read-only nature, and an output schema exists to document the return shape. However, the two required parameters are entirely undocumented, and no alternative or exclusion is mentioned. It is minimally viable but 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 for the undocumented parameters, but it does not. Neither workspace_id nor repo_id is explained; only the word 'repo' appears indirectly in the resource name. The agent is left to infer parameter meaning from naming conventions alone.

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 identifies a GET operation for a specific resource, 'review rule repository', and defines its scope as 'all its groups and rules'. This distinguishes it from the sibling list_review_repos, which likely returns only repository summaries. The inclusion of the endpoint further removes ambiguity.

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 a concrete usage context: 'Use this to inspect existing rule configurations before making changes.' This tells the agent when to invoke the tool, but it does not explicitly name alternatives or state when not to use it.

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