get_container_archive

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

Beyond annotations (readOnlyHint, destructiveHint), the description explains the in-band nature, the default size cap of 32 MiB, and the reason (MCP base64 encoding). It also details the return format.

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 concise and well-structured: main purpose first, then usage guideline, then parameter details, and return format. Every sentence adds value.

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 no output schema, the description fully documents the return value (dict with archive and stat). It covers parameters, behavior, limits, and provides an alternative tool, making it complete.

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 meaning to all three parameters: explains that 'max_bytes' aborts with ValueError on exceedance and defaults to 32 MiB, and mentions 'id_or_name' and 'path' explicitly. With 0% schema coverage, this fully compensates.

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 'Retrieve a file or directory from a container as a tar archive, returned in band.' It distinguishes from the sibling tool 'get_container_archive_to_file' by mentioning the in-band retrieval and capping.

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?

Explicitly advises to use 'get_container_archive_to_file' for large paths, providing a clear when-to-use and when-not-to-use guideline. Also explains the reason for the cap.

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