qlikcloud_logout

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

With no annotations, the description carries the full burden of revealing side effects. It explicitly states that it revokes the token, deletes the stored session, and removes access entirely, which is transparent. It lacks details about error behavior or confirmation of success, but the core effects are clearly disclosed.

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 and well-structured. It starts with a one-sentence summary, then elaborates on the mechanics and implications, and finally lists the parameter with its explanation. Each sentence serves a purpose 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?

The description covers the tool's action, side effects, and parameter meaning, and it references the login tool for context. It does not mention the output format (though the output schema is stated to exist but not shown), but for a logout operation, the expected outcome is straightforward. Overall, it is complete for practical use.

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 defines all_accounts as a boolean, and the description explains its meaning: 'Also remove every other stored account for this tenant.' This adds clear semantic value beyond the schema's bare type definition.

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's purpose: 'Sign out of Qlik Cloud and remove the stored session.' It further explains the effect of revoking the token and deleting the session, making the action unambiguous.

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 provides context for when to use the tool by referencing the need to call qlikcloud_login again after logout, implying it is used after a session is no longer needed. However, it does not explicitly compare with sibling tools like qlikcloud_get or qlikcloud_delete, so guidance on when not to use it is less direct.

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