save_workload_report

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

With no annotations provided, the description carries the full burden of explaining side effects and requirements. It only states the basic action (generate and save) without disclosing whether GitHub authentication is needed, whether files are overwritten, or what output the tool returns. This is insufficient for a write 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 a single, concise sentence with no redundant words. It front-loads the core action and destination, making it easy to parse, though it sacrifices informative content for brevity.

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, no output schema, and 5 parameters, the description is incomplete. It does not explain what a workload report contains, the relationship between parameters, or any expected results. For a tool with moderate complexity, this is a significant gap.

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 60%, and the description adds little beyond the schema. The phrase 'to local file or GitHub' hints at the role of saveToGitHub, but it does not clarify githubOwner or githubRepo, nor does it elaborate on sprintId or projectKey beyond their basic schema descriptions. The tool description fails to compensate for undocumented parameters.

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 and saves a workload report, with a destination of local file or GitHub. It distinguishes itself as a report-saving tool, though it doesn't explicitly differentiate from sibling tools like save_sprint_report or save_doc_to_github.

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?

No guidance is provided on when to use this tool versus alternatives such as save_sprint_report or get_workload_dashboard. There are no explicit usage conditions, prerequisites, or exclusions, leaving the agent to infer suitability from the name alone.

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