yaaif_agent_spec_release_candidate_promote

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

With no annotations provided, the description carries the full burden. It explicitly discloses that promotion creates a new immutable record and never rewrites the candidate, which is valuable behavioral context. However, it omits side effects like whether approvals are required, what happens to existing stable versions, or error conditions.

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?

Two concise sentences with no fluff, front-loaded with the primary purpose. The behavioral note is efficiently integrated.

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 complexity (4 parameters, no output schema, no annotations), the description is incomplete. It lacks parameter explanations, preconditions like what 'verified' means, and any mention of return values or failure modes. An agent would need to infer too much.

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 is 0%, so the description must compensate, but it does not explain any of the parameters (spec_id, revision, change_summary, expected_version). The names and required fields hint at their purpose, but without explicit definitions, an agent may not correctly map values.

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 (promote), the resource (verified Scenario release candidate), and the target (stable SemVer release). It also distinguishes itself by noting it creates a fresh immutable record and never rewrites the candidate, which sets it apart from related promotion or publishing 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 implies the tool is for verified candidates and creates a stable release, but it does not explicitly state when to use it versus alternatives like yaaif_agent_spec_publish or other release tools. There is no exclusion or direct comparison to siblings.

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