agile_getBoardSnapshotToFile

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

Annotations already cover readOnly/idempotent/destructive hints. The description adds disclosure of the file-writing side effect and return behavior (path + counts), which is beyond the annotations. This enriches the agent's understanding of what happens.

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 sentences, front-loaded with the core purpose, and no filler. Every word earns its place.

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 purpose, return shape, and usage context, and annotations provide safety hints. However, with 10 parameters and only 20% schema coverage, the lack of parameter semantics makes the description incomplete for correct tool use.

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 only 20% (boardId and filePath have descriptions); the remaining 8 parameters are undocumented. The description does not compensate—it only references 'same as agile_getBoardSnapshot' without explaining any parameter details. This is a significant gap for correct invocation.

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 writes a board snapshot to a local file, distinguishing it from agile_getBoardSnapshot. It specifies the verb 'writes', the resource 'JSON to a local file', and context 'large boards / daily dumps'.

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?

It names the alternative tool (agile_getBoardSnapshot) and indicates when to use this variant (large boards / daily dumps) to avoid stuffing full payload into chat. It does not explicitly state when not to use it, but the context is clear.

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