host_add

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

The description adds behavioral context beyond annotations: it persists data to a config file, returns a secret-free record, and explains the environment-variable password mechanism. Annotations already cover idempotency and non-destructiveness, so no contradiction 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 concise and well-structured: a short purpose statement, a key warning about passwords, a compact argument list, and a return value description. Every section adds value and is front-loaded with the most important usage constraint.

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 persistent configuration mutation with one nested parameter object, the description covers purpose, persistence, secret handling, and return type. The output schema is present, and annotations cover idempotency and destructiveness. Nothing essential is missing for correct invocation.

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 for the top-level parameter is 0%, but the description compensates by enumerating all fields in HostAddInput. It adds critical semantic meaning, especially that password_env and sudo_password_env should contain environment variable names, not passwords. The individual property descriptions in the schema provide additional detail.

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 states a specific verb and resource: adding a new remote host to the configuration and saving it to the config file. This clearly distinguishes host_add from sibling tools like host_remove, host_list, host_test, and host_run, which serve different purposes.

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 clearly indicates when to use the tool: when adding a new remote machine to the config. It also gives important usage guidance about not putting the actual password in password_env/sudo_password_env, only the name of an environment variable. It does not explicitly discuss alternatives or exclusions, but the context is clear.

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