roles_add_role_setting

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

No annotations are provided, so the description carries the full burden. It states the need for admin permissions and that changes affect all users with the role. But it does not disclose whether the operation is idempotent, what happens on conflict, error conditions, or response format. For a mutation tool, this is insufficient.

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 structured with a brief intro, workflow tips, and common use cases. It is front-loaded with the core action. However, there is slight repetition (e.g., 'Add or update' and 'Creates or updates') that could be streamlined.

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 there is no output schema, the description does not explain the return value or response. It covers the basic operation and permissions but lacks details on idempotency, error handling, or side effects. For a simple upsert tool, it is adequate but not comprehensive.

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 input schema already describes parameters with 100% coverage. The description adds value by noting that setting keys should follow Pipedrive conventions, specifying value types (string, number, boolean), and providing concrete examples. This goes beyond the schema descriptions.

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's purpose: 'Add or update a role setting.' It specifies the action (create/update) and resource (role setting). Among siblings like roles_delete_role_setting and roles_update_role_setting, this tool is distinct as it handles both creation and update.

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 mentions 'Requires admin permissions' and provides workflow tips and common use cases. However, it lacks explicit guidance on when to use this tool versus alternatives like roles_update_role_setting or roles_delete_role_setting. It does not specify when not to use it.

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