yuque_get_user_groups

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

No annotations are provided, so the description carries the full burden. It mentions a 'read' permission, suggesting it is read-only, but lacks details on pagination, rate limits, or detailed behavior of parameters like role and offset.

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 a single line for purpose and bullet points for permission and parameters. Every sentence adds value, but the structure is basic.

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?

Given the tool has an output schema (not shown) and 3 parameters, the description covers the core purpose and parameter meanings but lacks completeness in behavioral aspects such as pagination, error handling, or team semantics.

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%, so the description must compensate. It explains that 'id' is a user ID or login, 'role' is an optional filter, and 'offset' is an optional offset. This adds meaning beyond the schema, though it could be more specific (e.g., valid role values).

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: '获取指定用户所属的团队列表' (Get list of teams for a specified user). It uses a specific verb (get) and resource (user groups), and it is distinct from sibling tools like yuque_get_user_info or yuque_get_group_repos.

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 includes a permission requirement ('权限要求: read') and lists optional filters (role, offset), which imply usage context but do not explicitly state when to use this tool vs alternatives or provide exclusions.

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