set_pin

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

With no annotations provided, the description carries the full burden for behavioral disclosure. It only states the action without explaining side effects, whether the operation is idempotent, whether it requires specific permissions, or what happens if the thread is not indexed. The term 'indexed historical' adds minimal context but not enough to understand the tool's behavior.

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, front-loaded sentence that conveys the core purpose efficiently. There is no waste, but it is extremely brief given the tool's parameter count and lack of annotation support. Still, for what it attempts, it is concise and well-structured.

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 4 parameters, no annotations, and no output schema, the description is inadequate. It does not clarify the meaning of 'indexed historical', the role of global_scope, or any return behavior. A user cannot confidently invoke this tool correctly from the description alone, especially concerning edge cases like unindexed threads or workspace scope.

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 description adds no parameter-level detail. Schema coverage is 50% (workspace and global_scope have descriptions; pinned and thread_id do not). The description does not compensate for the undocumented parameters, leaving thread_id and pinned undefined beyond their names. It only trivially maps 'pin/unpin' to the pinned boolean.

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 action ('Pin or unpin') and the resource ('an indexed historical Codex task'). It distinguishes itself from sibling tools like list_pins (which lists pins) and index_workspace (which indexes workspaces). The verb+resource construction is specific and unambiguous.

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?

The description provides no guidance on when to use this tool versus alternatives. It does not mention that list_pins is the appropriate tool for viewing pins, nor does it describe any prerequisites like being indexed. There are no explicit exclusions or alternative tool references.

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