Skip to main content
Glama

yuque_get_user

Retrieve current user profile and account details from the Yuque knowledge base platform to identify active users and access permissions.

Instructions

获取当前用户信息 (Get current user information)

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Implementation Reference

  • The core handler function for the 'yuque_get_user' tool. It fetches the current user information using the YuqueClient and returns it as a JSON-formatted text content block.
    async function handleGetUser(client: YuqueClient) {
      const user = await client.getUser();
      return {
        content: [
          {
            type: 'text',
            text: JSON.stringify(user, null, 2),
          },
        ],
      };
    }
  • The schema/definition for the 'yuque_get_user' tool, specifying its name, description, and empty input schema (no parameters required).
    {
      name: 'yuque_get_user',
      description: '获取当前用户信息 (Get current user information)',
      inputSchema: {
        type: 'object',
        properties: {},
      },
    },
  • Dispatch/registration case in the main handleTool switch statement that routes calls to the specific handler.
    case 'yuque_get_user':
      return await handleGetUser(client);
  • src/server.ts:46-50 (registration)
    Server registration for listing tools, which includes 'yuque_get_user' via the YUQUE_TOOLS array.
    server.setRequestHandler(ListToolsRequestSchema, async () => {
      return {
        tools: YUQUE_TOOLS,
      };
    });
  • src/server.ts:52-67 (registration)
    Server registration for tool execution requests, delegating to handleTool which dispatches to yuque_get_user handler.
    // Handle tool execution requests
    server.setRequestHandler(CallToolRequestSchema, async (request) => {
      try {
        return await handleTool(request, { client: yuqueClient });
      } catch (error) {
        if (error instanceof McpError) {
          throw error;
        }
    
        const errorMessage = error instanceof Error ? error.message : String(error);
        throw new McpError(
          ErrorCode.InternalError,
          `Error executing tool: ${errorMessage}`
        );
      }
    });
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 states the action ('get current user information') but doesn't describe traits like authentication requirements, rate limits, error handling, or response format. For a tool with zero annotation coverage, this is a significant gap, as agents need more context to invoke it correctly.

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

Conciseness4/5

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

The description is a single, efficient sentence in both Chinese and English, front-loading the core purpose with no wasted words. It could be slightly improved by integrating the bilingual elements more seamlessly, but it's appropriately sized and clear.

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

Completeness2/5

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

Given the tool's simplicity (0 params, no output schema) and lack of annotations, the description is incomplete. It doesn't explain what 'current user information' includes (e.g., ID, name, email) or behavioral aspects like auth needs. For a tool that likely requires authentication to fetch user data, more context is needed to ensure reliable use by an agent.

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

Parameters4/5

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

The input schema has 0 parameters with 100% coverage, so no parameter documentation is needed. The description doesn't add param details, which is appropriate. Baseline is 4 for zero parameters, as the schema fully covers the absence of inputs, and the description doesn't need to compensate.

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 clearly states the tool's purpose as '获取当前用户信息 (Get current user information)', which specifies the verb ('get') and resource ('current user information'). It distinguishes from siblings like yuque_get_doc or yuque_get_repos by focusing on user data rather than documents or repositories. However, it doesn't explicitly contrast with other user-related tools (none listed), keeping it at 4 instead of 5.

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 provides no guidance on when to use this tool versus alternatives. It doesn't mention prerequisites (e.g., authentication state), use cases (e.g., retrieving user profile for personalization), or exclusions (e.g., not for fetching other users' data). With siblings like yuque_get_docs for document lists, there's no explicit differentiation, leaving usage unclear.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/tanis2010/yuque-mcp-server'

If you have feedback or need assistance with the MCP directory API, please join our Discord server