save_sprint_report

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

With no annotations, the description carries the full burden of disclosing behavior. It only says 'generate and save' without addressing file overwrite behavior, return values, authentication requirements, or side effects like creating GitHub repos. This leaves significant behavioral ambiguity for an agent.

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 sentence, front-loaded with the main verb and resource, and contains no filler. Every word contributes to the meaning.

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 5 parameters, no annotations, and no output schema, the description is too sparse. It doesn't explain what happens when saving locally vs GitHub, what the report contains, or what the tool returns after saving. This leaves the agent without enough context to anticipate the tool's full behavior.

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 input schema covers all 5 parameters with descriptions, so the baseline is 3. The description adds no parameter-level detail beyond the schema, such as how saveToGitHub interacts with githubRepo/githubOwner or what boardId influences.

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 sprint report, with explicit destination options (local file or GitHub). This distinguishes it from sibling tools like save_workload_report or save_release_notes_to_file, making the tool's purpose unambiguous.

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 implies usage for saving sprint reports but provides no explicit guidance on when to choose this over alternative save tools or when not to use it. There is no mention of prerequisites (e.g., GitHub auth) or relationship to other report tools, so the context is only implicit.

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