create_role

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

The description only says 'create' without any behavioral details. It does not disclose side effects (e.g., whether duplicates are rejected), permission requirements, or whether existing data is affected. With no annotations, the description should carry this burden but fails to do so.

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 a single, front-loaded sentence that efficiently states the action. No unnecessary words. However, it may be too terse, sacrificing clarity for brevity.

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 complexity of role creation in OpenMetadata (likely requiring specific properties), the description is too sparse. It lacks context about the role_data structure, return values (no output schema), and relationship to other role tools. The sibling set indicates CRUD operations, but this is not leveraged.

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 sole parameter role_data is an object with no schema description or hints about its structure. The description adds no meaning beyond the name; it does not explain what fields are expected or how to format the role data. With 0% schema coverage, this is a critical gap.

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 'Create a new role in OpenMetadata' clearly states the action (create) and resource (role), making the primary purpose unambiguous. However, it does not differentiate from sibling tools like create_policy or create_team, which also create entities in the same system.

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?

No guidance is provided on when to use this tool versus alternatives (e.g., update_role for modifications, get_role for retrieval). There is no mention of prerequisites, valid states, or conditions for successful creation.

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