Edit repository settings

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

Annotations already declare the mutation profile (destructive, idempotent, write-required). The description adds valuable behavior beyond annotations: partial update semantics, no rename support, and the non-obvious 404 behavior when unit toggles are off. It does not cover reversibility or permission nuances, but with annotations carrying that weight, this is strong.

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 front-loaded with the action and editable fields, then adds only high-value caveats: partial updates, no renames, 404 behavior, and write mode. Every sentence earns its place despite the density required for 14 parameters.

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 destructive, write-required, 14-parameter tool with no output schema, the description covers the essential context: which fields are editable, that updates are partial, that renames are unsupported, the 404 quirk for disabled units, and the write-mode prerequisite. Nothing critical is missing.

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 100%, so the schema already documents every parameter, including the 404 behavior for has_releases and has_actions. The description groups and summarizes the fields but adds little semantic detail beyond what the schema provides; baseline 3 is appropriate.

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 uses a specific verb ('Edit') and resource ('repository settings') and enumerates the editable fields, clearly distinguishing it from read-only siblings like get_repo and creation tools like create_repo.

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 gives clear operational context: only provided fields change, renames are unsupported, and write mode is required. It also explains the 404 symptom for disabled units, which helps an agent decide when to call this tool. It does not explicitly name alternative sibling tools, but the usage conditions are well covered.

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