hardhat_add_deployment

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

No annotations are provided, so the description must disclose behavioral traits. It only adds that this is a Pro feature; it does not state whether files are written or overwritten, whether api_key is required, or what side effects generation has.

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?

One compact sentence with no filler, and the Pro-feature caveat is placed immediately after the action. It is efficient, though it sacrifices detail needed elsewhere.

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 no output schema and no annotations, the description is too thin. An agent cannot tell what the deployment scripts entail, whether api_key is required, or how this relates to existing Hardhat scaffold/test tools.

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 schema documents 'directory' but not 'api_key', leaving 50% of parameters unexplained by structured data. The description does not compensate for this gap, so the agent must guess what api_key is for.

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 verb 'Generate' and object 'deployment scripts' clearly identify the action and resource. It lacks an explicit contrast with siblings like hardhat_generate_project or hardhat_add_tests, so it does not fully earn a 5.

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?

No guidance is given on when to use this tool versus alternatives. 'Pro feature' hints at entitlement/access but does not clarify selection criteria or prerequisites.

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