get_user_info_by_username

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

With no annotations, the description must disclose behavioral traits but only states that it returns a dictionary with user info. It does not mention whether it's a read-only operation, error handling behavior, or any authentication requirements, leaving significant gaps for an agent.

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, well-structured with Args and Returns sections, and front-loads the primary action. Every sentence serves a purpose with no redundant information.

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 single-parameter getter, the description covers the main purpose and return type. However, given no output schema or annotations, it leaves unanswered questions about error responses and edge cases (e.g., non-existent user), making it incomplete but not severely so.

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 description explains that the parameter is a Twitter username handle without the '@' symbol, which adds meaning beyond the bare schema definition. However, it inconsistently refers to the parameter as "username" while the schema defines it as "userName", creating potential confusion.

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 function: "根据用户名Handle获取用户信息" (Get user info by username handle). This specific verb-noun pair distinguishes it from sibling tools like batch_get_users_by_ids and get_tweet_replies.

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 is for retrieving user info via a username handle, and specifies that the handle should not include '@'. However, it does not provide explicit context for when to choose this tool over alternatives (e.g., batch_get_users_by_ids for ID-based lookups).

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