glama_generate_reports

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

With no annotations, the description discloses the side effect of creating files in reports/ and the conditional behavior for all repos, but lacks details on overwriting behavior, concurrency, or permissions.

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?

Three sentences with front-loaded purpose, no redundant information, and clear structure: purpose, details, conditional behavior.

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 an output schema exists and one parameter with 100% schema coverage, the description covers the main behavior and parameter effect. Lacks guidance on choosing between sibling tools, but otherwise complete.

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 describes the parameter as optional with a default, and the description adds the crucial context that an empty value triggers generation for all scored repos, enhancing understanding beyond the schema 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?

The description clearly states the tool generates markdown analysis reports for repos, specifying output format (markdown) and directory (reports/). However, it does not explicitly distinguish from sibling tools like glama_daily_report or glama_scores_summary.

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?

The description provides guidance on when to use the repo_name parameter (empty generates all scored repos) but doesn't advise on when to use this tool vs alternatives like glama_daily_report.

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