yuque_list_groups

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

With no annotations provided, the description must carry the full burden of behavioral disclosure. It only states that it lists groups/teams, without mentioning pagination, authentication requirements, whether archived or private groups are included, or what error behavior occurs. This is minimal disclosure for a read operation.

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 a single sentence of 10 words that immediately conveys the primary action and scope. There is no redundancy, and the information is front-loaded.

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's simplicity (one parameter, no output schema, no annotations), the description is minimally adequate but leaves gaps: it does not describe the return value shape (e.g., whether it returns IDs, names) or how it relates to sibling tools. For an agent to use the result fluently in a workflow, more detail would be beneficial.

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 already provides a description for the sole parameter 'user_id' ('User ID to list groups for'), and the tool description does not add any additional meaning. With 100% schema coverage, the baseline of 3 is appropriate; the description simply reinforces the schema without adding semantic depth.

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 uses a specific verb 'List' and names the resource 'groups/teams' with a clear scope ('that the user belongs to'). This clearly distinguishes it from sibling tools like yuque_list_group_members, which lists members of a group, and yuque_list_repos, which lists repositories.

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 when to use the tool: to retrieve groups for a given user. However, it does not explicitly mention when not to use it or point to any alternatives (e.g., for group members use yuque_list_group_members). The guidance is adequate but not explicit.

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