Add workspace pin

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

Annotations indicate readOnlyHint=false and destructiveHint=false, so the description adding 'Add' is consistent but adds little. The description does not disclose required permissions, side effects (e.g., does it overwrite or create duplicates?), or behavior with respect to the idempotency_key (which is self-described in schema). The 'safe' qualifier for links is vague. Overall, the description provides minimal behavioral context beyond what annotations already imply.

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 a single sentence, making it concise and front-loaded with the action. However, it is too brief to cover essential details. While every word serves a purpose, the brevity compromises clarity for a non-trivial tool with nine parameters. A slightly longer description with parameter context would improve it.

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 tool has 9 parameters, no output schema, and complex behavior (idempotency, positioning, surfaces), the description is far from complete. It neither explains return values nor guides parameter usage. An agent lacks essential context to invoke the tool reliably, especially without output schema to infer results.

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?

With only 11% schema description coverage, the description should compensate by explaining key parameters. It mentions 'note or safe http(s) link' which covers kind and url, leaving seven other parameters (x, y, label, surface, project_id, version_id, idempotency_key) unexplained. The idempotency_key description exists only in schema, not in the tool description. This is insufficient for an agent to correctly construct calls.

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 tool adds an 'attributable note or safe http(s) link' to a project workspace. It identifies the key resource (pin) and the two kinds (note, link), which aligns with the 'kind' enum. It is specific enough to distinguish from siblings like 'remove_project_pin' or 'list_project_pins' by stating the action is addition, though it could better clarify what 'attributable' means.

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 is given on when to use this tool versus siblings or alternatives. It does not mention prerequisites (e.g., need for a valid project_id), conditions for safe use, or when not to use it. The agent receives no help in deciding between this and related tools like 'add_project_feedback' or 'remove_project_pin'.

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