yaaif_platform_use

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

With no annotations provided, the description carries the behavioral disclosure burden. It does reveal a key side effect: 'Clears session if OIDC issuer changes.' This goes beyond the schema and is highly relevant for a state-changing tool, though it does not cover other potential behaviors such as failure modes or reversibility.

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 one front-loaded sentence that immediately states the action, then adds the critical side effect. Every word contributes value, with no fluff or repetition.

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 two-parameter tool with no annotations and no output schema, the description covers the core purpose and the most important side effect, but it omits details like default behavior of the boolean flag, handling of invalid custom IDs, and what a successful switch returns or changes beyond the session.

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. It adds meaning for profile_id by listing the allowed profile kinds (hosted, local-hybrid, local, custom id), but it does not clearly explain the clear_session_on_issuer_change boolean parameter beyond restating its name, nor does it define 'custom id' or how to discover valid 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 uses a specific verb and resource ('Switch active platform profile') and enumerates the accepted profile values (hosted | local-hybrid | local | custom id). This clearly distinguishes it from platform siblings like yaaif_platform_list, yaaif_platform_export, and yaaif_platform_save.

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 should be used when the active platform profile needs to be changed, but it does not explicitly state when to prefer it over alternatives or call out prerequisites such as retrieving available profiles first. No exclusions or alternative routing are provided.

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