Activate Flow Version

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

The description discloses the key side effect: activating a new version automatically deactivates the previous active version. This goes beyond the annotations (which only indicate it's a write and idempotent) and provides important behavioral context.

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 two concise sentences that front-load the purpose and end with a related-tool pointer. Every sentence earns its place, with no repetition or unnecessary detail.

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 2-parameter tool with annotations and no output schema, the description covers the action, side effect, and prerequisite discovery step. An agent has sufficient context to select and invoke the 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?

The schema already covers both parameters with 100% description coverage, including the default behavior of versionNumber. The description's mention of 'or the latest version' reinforces the schema but adds no new semantic information.

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 tool activates a specific Flow version via the Tooling API, naming the action and resource. It also notes the one-active-version constraint, distinguishing it from related tools like sf_deactivate_flow or sf_list_flow_versions.

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?

Explicitly directs users to first run sf_list_flow_versions to discover available versions, providing a clear workflow and prerequisite. It also explains the consequence of activating (auto-deactivating the previous version), which helps agents decide when to use this tool.

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