Save Integration Flow as Version

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

The description goes beyond the basic action by explaining that the comment is applied to the artifact before saving, because the API doesn't accept a comment directly. It also flags the need for ALLOW_WRITE permission. With no annotations, this context is valuable for understanding side effects and requirements.

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: two sentences that cover purpose, permission, and a behavioral nuance. No extraneous information. Each sentence adds value and is front-loaded with the core action.

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?

Given the tool's straightforward nature (saving a version), the description adequately covers the core functionality, required permission, and a key quirk about comment handling. It could be improved by noting version format or return status, but for a write operation with no output schema, it is sufficiently complete.

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 covers 75% of parameters with descriptions. The description adds meaningful context about the 'comment' parameter (optional, applied before saving) and implicitly clarifies the 'confirm' flag as a safety measure. This enhances understanding beyond the raw schema.

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 the action: saving the current draft as a new version with an optional comment. It specifies the resource (integration flow) and the operation, and it stands out among siblings which are mostly deploy, list, get, etc., without any similar versioning tool.

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 explains when to use the tool (to save a draft as a version) and mentions the required ALLOW_WRITE permission. It does not explicitly list alternatives or when not to use it, but the purpose is clear enough to differentiate from deployment or other operations.

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