hive_pinned

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

No annotations are supplied, so the description carries the full burden, and it discloses a lot: ordering, version semantics, the changed_since_pin flag and how to clear it, and that fleet_id access is privileged. It does not describe pagination, size limits, or error behavior for unauthorized fleet_id use.

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?

Dense but front-loaded, leading with what the tool returns before the usage cadence and the parameter note. The final sentence about fleet_id is well-placed, though the phrasing is compressed enough that the changed_since_pin clause reads slightly cryptically.

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?

For a single-optional-parameter read tool with no output schema, the description covers ordering, entry semantics, a derived field, usage cadence, and the privileged parameter. The main omission is the shape of returned entries, which the reader must infer.

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 0% and the single parameter is bare, but the description does explain fleet_id: optional, privileged, and used to read another fleet's pins. It does not say what happens if a non-privileged agent passes it or what the identifier format is.

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 the specific resource (pinned entries for the fleet) and its ordering (newest pin first), plus the semantic meaning of each entry as the current version. It is clearly distinguishable from siblings like hive_search or hive_list, which return broader entry sets.

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?

Gives explicit usage cadence: 'Read it once per session when you catch up,' plus the re-pin remedy for changed_since_pin items. It lacks explicit when-not-to-use guidance or a named alternative, keeping it below a 5.

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