Create or update a role

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

With no annotations, the description discloses HTTP methods (POST/PUT), the body structure, and the rights enum names, adding useful behavioral context. However, it does not explain update semantics (replace vs merge), permissions, or side effects, which are important for a mutation tool.

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, front-loaded with the core behavior and followed by specific parameter details. Every sentence earns its place without fluff.

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?

Given the tool's moderate complexity (nested object, two modes) and the lack of annotations or output schema, the description covers purpose, parameters, and usage modes adequately. It could mention the response or organization parameter, but it is reasonably complete for an upsert operation.

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?

The description adds substantial meaning beyond the schema by explaining the role body structure, the roleId parameter, and the rights enum values. It does not explain the organization parameter, but schema coverage is 67%, so the description compensates well for the key parameters.

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 the tool creates or updates a role, using specific verbs and resource. It distinguishes from sibling tools like wflow_list_roles and wflow_delete_role by explaining the dual create/update behavior and the difference between POST and PUT.

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 provides clear context for when to use create (omit id) versus update (pass roleId). It does not explicitly mention alternatives or exclusions, but the sibling tools are clearly different operations, so the guidance is sufficient.

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