pip_freeze

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

Annotations already declare readOnlyHint=true and idempotentHint=true, clearly indicating a safe, non-mutating operation. The description adds the output format 'requirements syntax' but does not elaborate on behavior regarding `venv_path` or environment interactions. No contradiction with annotations exists.

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 sentence that is grammatically direct, front-loads the verb, and contains zero unnecessary words. It is appropriately sized 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?

For a simple tool with one optional parameter, an output schema, and read-only annotations, the description is largely sufficient. However, it omits mention of default environment behavior when `venv_path` is not provided and does not clarify its relationship to the sibling `export_requirements`, leaving minor gaps.

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 input schema contains one parameter `venv_path` with a full description ('Optional target virtual environment'), giving 100% schema coverage. The description adds no additional parameter details, but none are needed since the schema already fully documents the parameter.

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 uses a specific verb 'Freeze' with a clear resource 'installed packages' and output 'requirements syntax,' making the primary action unambiguous. However, it does not explicitly distinguish from the sibling tool `export_requirements`, which serves a similar purpose.

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 like `export_requirements` or `pip_list`. It only states what the tool does, with no contextual usage directions or exclusions.

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