buildx_imagetools_inspect

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

Annotations already indicate readOnlyHint=true and destructiveHint=false. Description adds context about handling OCI image indexes, attestations, and multi-platform manifests, which is beyond annotations. No contradictions.

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?

Front-loaded with purpose, then replacement info and alternatives before parameters. Slightly verbose but well structured. Could be slightly shorter.

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?

Explains return value format (dict with stdout, stderr, etc.) and notes that when raw=True or format='{{json .}}', stdout is a JSON document. Covers parameter interactions. Lacks some edge cases but adequate.

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 description fully compensates. Explains all four parameters: image (with examples), raw, format (mutually exclusive), and builder. Provides crucial details missing from schema.

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?

Clearly states purpose: 'Inspect a manifest in a registry without pulling.' Distinguishes from siblings by mentioning it replaces 'docker manifest inspect' and contrasts with 'registry_manifest'.

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?

Provides explicit guidance: use this instead of 'docker manifest inspect' for OCI support, and mentions 'registry_manifest' as an alternative using direct HTTPS. Clearly states when to use.

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