wechat_logout

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

With no annotations, the description carries the burden. It discloses a key side effect: deleting credentials with clearCredentials=true and the consequent fresh QR requirement. This goes beyond a simple 'logout' statement, though it doesn't detail all state changes (e.g., message receiving stops).

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 sentences with no filler. The main action is front-loaded ('Stop the bot.'), followed by the conditional side effect. Every word earns its place.

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 one-parameter logout tool, the description covers the core behavior and the parameter effect. It doesn't elaborate on post-logout state or return values, but given the low complexity and absence of an output schema, it is sufficiently complete.

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 coverage is 0%, but the description thoroughly explains the single parameter clearCredentials: 'With clearCredentials=true, also deletes ~/.wechatbot/credentials'. It adds concrete meaning and behavior beyond the schema's bare boolean.

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 action: 'Stop the bot.' It uses a specific verb and resource, and the optional clearCredentials behavior adds precision. It is easily distinguished from sibling tools like wechat_login or wechat_send_text.

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 conveys clear usage context: to stop the bot, and explains the credential-clearing option. However, it does not explicitly mention when not to use it or name alternatives, so it falls short of a 5.

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