repos_update

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

The description is consistent with annotations (readOnlyHint=false indicates mutation). However, it does not disclose behavioral traits beyond what annotations provide, such as whether changes are overwritten or reversible. With annotations already indicating mutation, the description adds minimal behavioral context.

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, front-loaded sentence with no wasted words. It efficiently conveys the tool's core functionality.

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?

Despite having an output schema, the description omits important details: it does not explain that repo_id is required, does not mention mutual exclusivity of branch and tag, and leaves out repo_path. For a mutation tool with 5 parameters, the description is too sparse to be fully complete.

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 low (20%), with only repo_id described. The description maps three parameters (branch, tag, sparse_checkout) to the stated actions, adding meaning beyond the schema. However, repo_path is not mentioned, leaving its purpose unclear. The description partially compensates but is incomplete.

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 it updates a repo and specifies two main actions: switching branch/tag or changing sparse checkout. Among sibling tools (repos_create, repos_delete, repos_get, repos_list), this is clearly the update variant. However, it does not explicitly differentiate itself from siblings beyond the verb 'update'.

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?

No guidance on when to use this tool versus alternatives, no prerequisites mentioned, and no instructions on mutual exclusivity of branch and tag or required parameters beyond repo_id.

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