share_set_user

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

With no annotations, the description carries the full burden: it discloses that this is an upsert, that notify/message broadcast to all grantees, and that it returns updated sharing status. It never states whether the grants list replaces the existing share set or merges with it, nor any permission/auth requirements, which are exactly the traits an agent needs for a sharing mutation.

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 core upsert semantics and the parameter-shape disjunction are front-loaded, and the sentences are dense without filler. The 'confirm with its canonical notebook_id' clause is slightly cryptic and interrupts the otherwise clean structure.

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?

An output schema exists, so return values are covered elsewhere and the description is right to only summarize them. For a 7-parameter mutation tool with zero annotation and zero schema-description coverage, though, missing auth/permission requirements and replace-vs-merge behavior leaves a meaningful gap.

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 must compensate and largely does: it explains email+permission, the grants structure [{email, permission}] with its 1-100 bound, that notify and message apply to all grantees, and that the notebook is referenced by its canonical notebook_id. The confirm flag's exact semantics remain only indirectly implied, keeping it short of a 5.

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 (upsert) and resource (access) and spells out the two mutually exclusive input shapes: single email+permission or a 1-100 grants array. It does not distinguish itself from the near-identical sibling share_set_access, leaving an agent to guess which of the two to pick.

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?

It implies a preview-then-confirm workflow ('Preview lists every grant; confirm with its canonical notebook_id') and notes that batches allow mixed permissions, which gives some usage context. However, there is no explicit when-to-use/when-not guidance and no routing to share_set_access or share_remove_user, so the agent must infer the choice.

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