codesweep_list

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

With no annotations available, the description carries the behavioral disclosure burden. It communicates that the tool returns summary counts and that archived sweeps are excluded by default via 'include_archived ... default: false.' However, it does not disclose ordering, pagination, permission requirements, or potential side effects, though the verb 'List' strongly implies a non-mutating operation.

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 appropriately short and front-loaded with the core purpose: 'List all sweeps with summary counts.' The argument documentation is compact and useful. It is concise without being under-specified for a tool this simple.

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 simple list tool with one optional parameter and an output schema available, the description covers the essential behavior: what is listed, what counts are included, and how archived sweeps are handled. It does not explain pagination or ordering, but those are less critical given the tool's simplicity and existing output schema.

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. It restates the single parameter 'include_archived' with the clarification 'Include archived sweeps' and the default value. This adds some plain-language meaning, though the schema already includes the title 'Include Archived' and default false, so the added value is marginal.

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 states a clear action and resource: 'List all sweeps with summary counts.' This distinguishes it from sibling tools like codesweep_list_items, which presumably lists items, and codesweep_status, which likely shows a single sweep's state. It lacks an explicit sibling comparison but is specific enough to orient an agent.

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 use this tool versus alternatives such as codesweep_list_items or codesweep_status. The phrase 'List all sweeps' implies a broad listing use case, but no explicit conditions, exclusions, or alternative tool recommendations are provided.

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