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

The description adds behavioral details beyond the annotations: it requires confirmation, states that source documents are not changed, and notes that existing room links may expose additions based on permissions. These are genuine behavioral traits not fully captured by the readOnlyHint, idempotentHint, or destructiveHint annotations.

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 concise, consisting of two clear sentences with no redundancy. It efficiently conveys the core action, constraints, and side effects without unnecessary detail.

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 provided output schema and annotations, the description covers the essential behavior, confirmation requirement, and non-destructive nature. It does not delve into error conditions or detailed return values, but those are not required because the output schema exists and the annotations cover idempotency.

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 description clarifies that 'documents' refers to explicitly selected document revisions and implies a limit of 25 via 'up to 25', matching the maxItems constraint. However, it does not explain other parameters like project_id, room_id, expected_version, or idempotency_key, leaving partial coverage given the schema's 0% description coverage.

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: pin up to 25 explicitly selected document revisions into a room after confirmation. It identifies the resource (document revisions) and the specific operation (pinning into a room), distinguishing it from other SparkRoom tools like create or 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 provides no guidance on when to use this tool versus alternatives such as sparkroom.update or sparkroom.create_share_link. It does not mention conditions, prerequisites, or scenarios that would favor this tool over others.

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