tunnel_share

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

Describes the complete process (reads, hashes, seals, offers), encryption details, and return fields (artifactId, offeredTo, olderMembers). Warns about plaintext filename. No annotations provided, so description carries full burden and meets it.

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?

Three sentences, front-loaded with purpose, then process, then return value and warning. Every sentence adds value with no redundancy.

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 one parameter, no output schema, and no annotations, the description covers all essential aspects: action, encryption, return values, and caveats (human approval, plaintext filename). Complete for agent usage.

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?

Only one parameter (path) with 0% schema coverage; description adds meaning by stating 'Reads the file at `path`', clarifying its purpose. Could mention path format but sufficient for single string param.

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?

Clearly states 'Share a file with the room (text or binary)', specifying verb, resource, and context. Differentiates from sibling tools like tunnel_say (text messages) and tunnel_receive.

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?

Provides explicit guidance to get human approval for sensitive data and warns about plaintext filename. Implicitly distinguishes from other tools by mentioning file sharing, but lacks explicit when-to-use vs siblings.

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