roles_update

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

Discloses that it requires admin permissions and mentions behavioral implications like hierarchy changes and name uniqueness. However, it does not explain error responses or behavior if the role does not exist. With no annotations, the description carries the burden and covers key traits well.

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 concise, using a brief introductory sentence followed by bullet points for workflow tips and use cases. Every sentence adds value without redundancy, and examples are front-loaded for quick understanding.

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 simple update tool with three parameters and no output schema, the description adequately covers purpose, prerequisites, workflow, and examples. It does not explain return values, but that is acceptable given the lack of output schema.

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%, but the description adds value beyond schema definitions by providing example JSON bodies and explaining the effect of changing parent_role_id. This helps the agent understand parameter usage beyond syntax.

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 states 'Update role details' and 'Updates information for an existing role,' using a specific verb and resource. It distinguishes from sibling tools like roles_create, roles_delete, and roles_get by focusing on update operations.

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?

Provides explicit workflow tips: only provided fields are updated, use roles/get to retrieve current values, and notes on uniqueness and hierarchy. Common use cases with JSON examples give clear context on when and how to use the tool.

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