edit_role

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

With no annotations provided, the description bears full responsibility. It discloses that permissions replace the existing set and explains the inverted position scale, but does not mention auth requirements or potential side effects, such as the need for MANAGE_ROLES permission.

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 two concise sentences with no unnecessary words. It front-loads the purpose and then provides critical warnings, making it efficient and easy to parse.

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 mutation tool with 8 parameters and no output schema, the description covers key behaviors and warnings. However, it lacks mention of required permissions (e.g., MANAGE_ROLES) and does not specify that return values are not documented, leaving some context incomplete.

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 each parameter is documented in the schema. The description adds marginal value beyond the schema by noting the replacement behavior for permissions and the inverted position scale, but most parameter meanings are already clear from 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 starts with 'Edits a role's name, color, permissions, hoist, mentionable, or position,' clearly specifying the verb and resource. It distinguishes from siblings like 'create_role' and 'reorder_roles' by focusing on editing existing role attributes and explicitly mentioning reorder_roles as clearer for reordering.

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 provides guidance by noting that permissions REPLACE the existing set and that position uses Discord's inverted scale with reorder_roles recommended for reordering. However, it does not mention required permissions (e.g., MANAGE_ROLES) or when to use this tool for other fields, leaving some gaps.

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