Add a member to the group

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

Beyond the annotations, the description discloses important behavioral context: it requires operator write opt-in and confirm:true, and warns that it may notify recipients or change tenant data. This matches the destructiveHint and non-readOnly annotations and gives an agent a clearer risk picture.

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 compact and front-loaded: the action, endpoint, body fields, requirements, and side effects each get a short clause. There is slight redundancy with the title's first phrase, but no padding.

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 mutating tool without an output schema, the description covers the essential call context: endpoint, payload field names, prerequisites, and possible side effects. It lacks valid-value guidance for id/recipientType and any response/error hints, but the reference link and body-field listing are enough for a capable agent.

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 schema's body parameter is a generic JSON payload, so the description adds value by naming 'id' and 'recipientType' and placing groupID in the endpoint URL. It stops short of explaining valid values or relationships, but it meaningfully compensates for the schema's vagueness.

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 uses a specific verb and resource ('Add a member to the group') and confirms it with the exact endpoint, POST /api/xm/1/groups/{groupID}/members. This clearly distinguishes it from the sibling removal operation (xmatters_remove_a_member_from_the_group).

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?

Usage is implied by 'Add a member to the group' and the POST endpoint, but the description never explicitly states when to use this tool over alternatives or excludes other operations. An agent must infer from the sibling names.

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