Skip to main content
Glama

yuque_get_user_groups

Retrieve the list of groups a user belongs to, optionally filtered by admin or member role. Supports pagination for large result sets.

Instructions

List groups the user belongs to. GET /users/:id/groups. 详见 references/api/user_api.md

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesUser login or ID (required)
rawNoReturn raw full JSON (default false, returns trimmed fields)
roleNoRole filter: 0=admin, 1=member
offsetNoPagination offset, default 0

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.1/5.0
Behavior2/5

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. It only gives the HTTP method and endpoint, implying a read operation, but does not state authentication requirements, whether results are paginated, or any other behavioral traits beyond what the schema already implies.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is three short lines with zero waste. The core purpose is front-loaded, followed by the endpoint and a reference pointer, making it efficient and well-structured.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a simple read-only list operation with a fully documented schema and no output schema, the description provides adequate core information and points to a reference document. However, it lacks any usage context or behavioral notes that would help an agent select it over siblings, leaving it only minimally complete.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so all four parameters are already documented in the input schema. The description adds no parameter-level details beyond the schema, which is the baseline expectation when the schema is complete.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a specific verb ('List') and resource ('groups the user belongs to'), making the purpose clear. It does not explicitly differentiate from sibling tools like yuque_get_user or yuque_get_group_users, but the tool name and description together are unambiguous.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description offers no guidance on when to use this tool versus alternatives. It does not mention prerequisites, appropriate contexts, or exclusions, leaving the agent to infer usage from the name alone.

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