pin.inspect

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

Annotations already declare read-only, idempotent, and non-destructive behavior. The description adds a specific behavioral trait: 'status shows dirty work excluded from evidence,' which explains a filtering behavior. It does not detail return formats or pagination, but the annotation coverage lowers the burden.

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 concise sentences, front-loaded with the core purpose and a useful behavioral note. No wasted words.

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?

With three parameters, five operations, and no output schema, the description is relatively brief. It names the operations but omits details about what each returns (e.g., manifests vs tests) and does not explain the limit parameter. Annotations improve safety understanding, but an agent would benefit from more detail.

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 carries the burden. It explains the operation values (status, commits, manifests, tests, changes) and adds context for 'status', but does not explain the 'repository' or 'limit' parameters. Partial compensation for missing schema descriptions.

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 inspects HEAD-pinned status, commits, manifests, tests, or recent changes, with a specific verb and resource. It distinguishes from siblings by listing its unique operations (e.g., status, commits) compared to read/prove/analyze functions.

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 implies usage for inspecting repository state but does not explicitly state when to use it over sibling tools like pin.read or pin.prove. The note about status excluding dirty work provides context for one operation, but no when-not-to-use guidance or alternative references.

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