Fetches the signed-in user's Yuque profile - id, login, name, avatar URL, books count, description, created at - giving applications verified identity and personalization context.
Get current user profile (id,login,name,avatar_url,books_count,description,created_at). GET /user. 详见 references/api/user_api.md
| Name | Required | Description | Default |
|---|---|---|---|
| raw | No | Return raw full JSON (default false, returns trimmed fields) |
Changes observed during successful MCP inspections.
v0.1.0Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries the full burden. It discloses the HTTP method (GET /user), implying a read-only operation, and lists returned fields, but it does not cover authentication requirements, rate limits, error behavior, or the exact effect of the raw flag beyond what the schema already states.
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?
Front-loaded with the purpose, then the returned fields, endpoint, and a reference pointer. Two compact sentences with no wasted text.
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?
With no output schema and no annotations, the description helpfully names the returned profile fields and points to an API reference. It is nearly complete for a simple current-user read, though it could state authentication expectations or clarify the raw flag's output shape in prose.
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 description coverage is 100%, so the schema already explains the raw parameter. The description does not add input-parameter semantics beyond the schema, though it does list return fields, which is useful return-value context rather than parameter context.
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?
States a specific verb and resource: get the current user profile, and lists the returned fields. It is easily distinguishable from sibling tools such as get_user_groups because it targets the authenticated user rather than group membership.
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 no explicit when-to-use guidance or alternatives. The agent can infer this is for the current user, but there is no statement about when to prefer this over related user/group tools.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.