Contract Testing: Admin Update Role

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

Annotations already indicate idempotent and non-destructive behavior. The description adds that it updates name and permissions, but does not clarify partial update semantics (e.g., whether omitted optional fields like description are cleared or left unchanged). No additional behavioral traits beyond what annotations and schema provide.

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 short and front-loaded with the action. The parameter list is redundant with the schema, but the overall length is reasonable. No unnecessary 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?

The description lacks information about the return value or success indicator. For a mutation tool with no output schema, the agent needs to know what the tool returns (e.g., the updated role object or a success message). This omission reduces completeness.

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 all parameters. The description repeats the parameter list but adds no extra meaning (e.g., does not explain that 'permissions' is an array of objects with a 'scope' property). The description adds marginal value beyond the schema.

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 identifies the action ('Update'), the resource ('existing role'), and the scope ('name and permissions'). It also includes '(admin)' to indicate the toolset. This distinguishes it from sibling tools like 'contract-testing_admin_create_role' and 'contract-testing_admin_delete_role'.

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 usage when updating a role but does not explicitly state when to use it versus alternatives (e.g., when to create vs update). No guidance on prerequisites (e.g., role must exist) or when not to use it. The context of 'admin' provides some implicit direction.

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