Create post-install script

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

Beyond the annotations (readOnlyHint=false, destructiveHint=false), the description discloses important side effects: the script is saved to /post_install, gets the executable attribute, executes once the VM is installed, output goes to /post_install.log, and there is a 48KB size limit. This gives the agent a clear picture of what will happen.

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 short and front-loaded with the main purpose, followed by useful execution details. The final sentence is somewhat redundant with the opening but still reinforces the intended use case, so no sentence is wasted.

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 create endpoint with only two required parameters, the description covers the essentials: purpose, storage location, execution behavior, logging, and size limit. It does not describe the API response or how the script will be referenced later, but that is not critical for invoking this tool 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 coverage is 100% for the two parameters, so the baseline is 3. The description adds meaningful context beyond the bare schema: the content parameter maps to a script saved to /post_install, executed later, and capped at 48KB. It does not add constraints for the name parameter, but the name is self-descriptive.

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 opens with a specific verb and resource: 'Add a new post-install script to your account.' It also clarifies the intended lifecycle ('can then be used after virtual machine installation') and ends by restating the purpose as creating automation scripts. This clearly distinguishes it from sibling update/delete/get script tools.

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 clear context on when to use the tool: to create automation scripts for VPS setup, which run after installation. It does not explicitly mention alternatives like update/delete/get scripts, but the word 'new' and the creation purpose make the intended use unambiguous.

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