Log in to WeChat via QR code

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

With no annotations, the description carries full burden. It discloses blocking behavior, QR code output to STDERR, need for mobile app scanning, and return of account id on success. It lacks details on failure modes or prerequisites.

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 with two main sentences covering purpose, behavior, and an alternative approach. No unnecessary words, front-loaded with the core action.

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 an interactive login tool, the description covers the process, blocking, and return value. It lacks output schema but states the return. Could mention error handling or cancellation, but overall sufficient.

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 100% with description for timeoutMs. The description adds context by mentioning the default timeout (8 minutes) and the blocking nature, which complements the schema.

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 logs in to WeChat via QR code, specifying the verb (login) and resource (WeChat). It distinguishes from sibling tools like wechat_list_accounts, wechat_logout, etc., by describing the interactive login process.

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?

Provides guidance that for first-time setup, running 'npm run login' in a real terminal is easier, indicating when not to use this tool. However, it does not explicitly list alternative tool uses or when to prefer this tool over others.

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