sync_repo

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

With no annotations, the description carries the full burden of behavioral disclosure. It explains the incremental nature and that a summary is returned, but it does not mention side effects, required permissions, whether the operation is destructive, or if it blocks or is async. This is a notable gap for a mutation-like action.

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 three concise sentences with no waste. It front-loads the action, then explains scope and return value. Every sentence adds value.

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?

For a one-parameter tool with an output schema, the description covers the core purpose and return value. However, it omits prerequisites (e.g., repo must already be indexed), potential side effects, and error conditions. It is minimally adequate but not rich enough for a tool that triggers a process.

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 0%, so the description must compensate for the repo_name parameter. It only mentions 'repository' generically, without clarifying the format, source, or relationship to the parameter. The meaning is mostly derived from the parameter name itself, not enhanced by the description.

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 states a specific verb and resource: 'Trigger an incremental sync for a repository.' The 'incremental' qualifier and the distinction from sibling read-only tools (get_repo_status, get_repo_overview, search_context) make its 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 when to use the tool ('Processes only files changed since the last indexed commit') but does not explicitly say when to prefer it over alternatives or provide when-not-to-use guidance. The context is clear but exclusions are absent.

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