create_share_link

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

The description only states the action 'Create' without disclosing behavioral traits such as idempotency, required permissions, or side effects. With no annotations, the description carries full burden but fails to provide any.

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?

Two sentences, front-loaded with purpose, no wasted words. The parameter clarification is appropriately placed after the main action.

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?

Although the tool has only one parameter and an output schema, the description fails to provide sufficient context for the 'fields_json' parameter, leaving the agent to guess the required JSON structure. This is incomplete for a creation tool.

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 schema lists 'fields_json' as a string with 0% coverage. The description adds that it is a JSON object, which clarifies the type but does not specify its structure or required fields, adding only marginal value.

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 verb 'Create' and the resource 'document share link', distinguishing it from siblings like 'list_share_links' or 'delete_share_link'.

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?

No guidance on when to use this tool versus alternatives (e.g., when to create a share link vs. adding a document to a project). No usage context or prerequisites provided.

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