Create share link

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

Annotations already declare the mutation profile: readOnlyHint=false, destructiveHint=false, openWorldHint=true, idempotentHint=false. The description adds critical access-control behavior—only signed-in company members can open the link, it is not a public customer page—which is not captured in the 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 main purpose is front-loaded in the first sentence. The second paragraph contains useful exclusions but slightly repeats the opening idea before adding the important customer/PDF alternative.

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?

The description covers what the tool does, who can access the link, and what the return value is (a short URL). With no output schema, it adequately indicates the result, though it does not mention whether links expire or what happens if called repeatedly.

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 coverage is 50%: record_id is documented, and record_type has an enum but no description. The description names the supported record types (estimate, change order, invoice), but does not add format or mapping details beyond what the schema already provides.

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?

States a specific verb and resource: makes a short internal link that opens an estimate, change order, or invoice. It also distinguishes the tool from the public-facing send_* siblings by explaining that this link is only for signed-in team members.

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?

Explicitly says when to use this tool (internal team sharing) and when not to use it (customer-facing delivery). It names the alternative tools send_estimate, send_change_order, and send_invoice for the customer PDF scenario.

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