smokeball_request

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

Annotations already declare destructiveHint=true, readOnlyHint=false, and idempotentHint=true. The description adds valuable context beyond that: writes require an approval_ref ('Approved platform task UUID when resuming a write'), the effect is only 'claimed' and 'Spring verifies it,' and routing is restricted to the governed project/account authority. No contradiction with annotations exists.

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 efficiently structured: a two-line identity/routing preamble followed by a tight 7-line Args block. It is front-loaded with the platform tool name and the governing constraint before parameters. Each line of the Args block carries distinct information; there is no filler.

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?

Parameter semantics and the approval/write-resumption flow are well documented, and an output schema exists to cover return values. However, for a generic dispatcher in a list of 500+ siblings, the description omits what operations the arguments JSON can express, what effect values are valid, and how this tool relates to smokeball_api_request or the specific smokeball_* CRUD tools. An agent cannot confidently construct a correct call or choose between the generic request tools.

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?

Schema description coverage is 0%, so the description carries the burden, and the Args block glosses all 7 parameters with meaningful additions: idempotency_key is a 'Stable business-action identity,' approval_ref is tied to resuming a write, and arguments is a 'JSON string of arguments for the connector operation.' Some glosses remain vague (project_ref 'Exact project correlation reference', connector_account_ref alias), and effect's valid values are unlisted, but the description compensates well for the bare schema.

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 identifies the tool as 'Smokeball connector operation request (platform tool smokeball.request)' and states it 'Routes only through the exact project/account governed connector authority,' which names a verb and resource at the meta level. However, it never says what actual Smokeball operations (create matter, get contact, etc.) can be routed through it, and it doesn't differentiate itself from similar generic siblings like smokeball_api_request, clio_request, or xero_api_request in the sibling list.

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?

There is no explicit when-to-use or when-not-to-use guidance. The sentence about routing through the governed connector authority is a constraint, not a usage guideline. Alternatives such as smokeball_api_request or the specific smokeball_create_* / smokeball_get_* tools are never mentioned, so an agent cannot determine which tool to invoke for a given Smokeball operation.

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