axint.project.syncVersion

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

Describes effects (updates files, dryRun prevents writes, no network) beyond annotations. Annotations already indicate non-readonly, non-destructive, idempotent. Minor gap on permissions or error handling.

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 paragraphs: first defines purpose and usage, second repeats usage but adds effects. Slightly redundant but overall efficient and front-loaded with key information.

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?

Covers purpose, usage, effects, and dryRun. Output schema exists so return values not needed. Lacks details on error cases or file existence handling, but adequate for the tool's function.

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 coverage is 100% with descriptions for all 4 parameters. The description restates dryRun behavior but adds no new semantics beyond the schema. Baseline of 3 applies.

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 updates version hints in specific files (project.json, AGENTS.md, CLAUDE.md, rehydration docs) after upgrades, distinguishing it from sibling tools like axint.upgrade or axint.project.pack.

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?

Explicitly states when to use (after axint.upgrade, npm/pip upgrades) and the problem solved (stale version hints). Lacks explicit exclusions 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.