squads_add_all_users

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. It mentions 'async 202' which alerts the agent that the operation is asynchronous and returns an HTTP 202 Accepted status, implying the action may not complete immediately. This is useful, but it does not disclose other behaviors such as whether the operation is idempotent, what happens if some users already belong to the squad, or whether the operation can be reversed. For a bulk action, more detail would be helpful, but the async hint provides essential context.

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, tight sentence that immediately states the primary action and a key behavioral trait (async 202). There is no verbosity or filler. Every word earns its place, making it an exemplar of concise documentation for a simple tool.

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 tool with one parameter and no output schema, the description covers the essential context: what it does (add all users to an internal squad) and a critical behavioral detail (async 202). It does not describe return values or error handling, but these are less critical given the simplicity. The description is sufficient for an agent to invoke the tool correctly, though additional details about side effects or idempotency would improve completeness.

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 tool has a single parameter, squadUuid, whose schema description is 'Squad UUID' and covers 100% of the parameter. The tool description does not add any additional meaning about the parameter (e.g., format, constraints, or how to obtain the UUID). Given the high schema coverage, the baseline is 3, and the description does not compensate further.

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 action: 'Add ALL users to an internal squad'. It uses a specific verb (Add) and resource (users to squad), and the 'ALL' qualifier distinguishes it from squads_add_users (which adds specific users). The word 'internal' distinguishes it from external_squads_add_all_users. This unambiguously identifies the operation and sets it apart from related tools.

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 implicitly signals that this tool is for adding every user to a squad, as opposed to adding selected users (which would use squads_add_users). However, it does not explicitly state when to prefer this tool over alternatives, nor does it mention any prerequisites or exclusions. The intended usage is clear from the name and description, but there is no explicit guidance for agent decision-making.

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