yaaif_logout

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

With no annotations, the description carries the behavioral disclosure burden. It clearly states the core local session clearing effect and the optional Keycloak end_session side effect. It does not explain broader consequences of ending the Keycloak session, but the main behavioral profile is transparent.

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 short sentences with no filler. The primary behavior is front-loaded, and the optional parameter behavior is stated in the second sentence without redundancy.

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 low-complexity logout tool with one optional parameter and no output schema, the description covers the essential call behavior. It is slightly light on usage context and the precise meaning of the Keycloak end_session option, but it is sufficient for a straightforward logout operation.

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 provides no description for the single optional boolean 'end_session' (0% coverage). The description partially compensates by tying the parameter to 'Optionally open Keycloak end_session', but it does not clarify what exactly end_session does, such as whether it invalidates the SSO session or triggers a redirect.

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 states a specific action ('Clear the local YAA\F client session') and an optional secondary behavior ('Optionally open Keycloak end_session'). It is immediately distinguishable from auth-related siblings like yaaif_login, yaaif_whoami, and yaaif_ensure_session.

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 gives no explicit guidance on when to use this tool versus alternatives such as yaaif_ensure_session or yaaif_login, nor does it mention when not to use it. The intended context is implied by the tool name and the action, but not stated.

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