axint.project.syncVersion

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

Discloses that it updates local files, is idempotent, and does not make network calls. This adds value beyond annotations and aligns with idempotentHint=true.

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 concise sentences with clear structure: stating purpose, usage, and effects. No redundant words.

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 all essential aspects: when to use, what it does, effects (including dryRun), and no network. Output schema handles return details, so no need to describe output here.

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%, so description needs no additional parameter info. It adds no new meaning beyond the schema, meeting baseline for this coverage level.

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?

Description clearly states the tool updates version hints after upgrades, naming specific files and providing context. It differentiates from sibling tools like axint.upgrade by stating usage after upgrades.

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 says to use after axint.upgrade or npm/pip upgrades, providing clear context. Does not explicitly list when not to use or mention alternatives, which is a minor gap.

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