generate_deployment_guidance

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

Annotations provide no meaningful safety constraints (all hints are false), so the description carries the full burden of behavioral disclosure. The description only says it 'generates' guidance, which sounds read-only, yet the schema includes generateFiles with 'Actually generate files (vs just guidance)', indicating a potentially mutating side effect. This behavioral trait is not reflected in the description.

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, front-loaded sentence that names the action, resource, source, and qualifier without wasted words. It is appropriately sized for a tool whose parameter details live in the schema.

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?

The tool has 11 parameters, no output schema, and no informative annotations, yet the description does not explain key behavioral aspects such as file generation side effects, whether the output is returned or written to disk, or how this relates to other deployment-focused tools. This creates a significant gap for an agent deciding how to invoke it correctly.

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 100%, so the parameters are already well documented. The description's reference to 'environment-specific configurations' loosely aligns with the environment and includeConfigs parameters but adds no new semantic detail beyond what the schema already provides. Baseline 3 is appropriate.

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 a specific action ('Generate'), a specific resource ('deployment guidance and instructions'), and the source ('from ADRs'), plus a distinguishing qualifier ('environment-specific configurations'). This differentiates it from sibling tools like deployment_readiness or analyze_deployment_progress, which target different concerns.

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 phrase 'from ADRs' implies the tool should be used when ADRs are the basis for deployment guidance, but there is no explicit statement of when to choose this tool over related siblings such as get_workflow_guidance, get_development_guidance, or deployment_readiness. No exclusions or alternatives are named.

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