Skip to main content
Glama

yuque_hello

Test connectivity and verify authentication with the Yuque knowledge base API to ensure proper setup before performing document management operations.

Instructions

Call the Yuque hello endpoint.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Implementation Reference

  • The handler implementation for the yuque_hello tool.
    yuque_hello: async (_args, client) => jsonText(await client.hello()),
  • src/tools.js:86-90 (registration)
    The tool registration definition for yuque_hello.
    {
      name: "yuque_hello",
      description: "Call the Yuque hello endpoint.",
      inputSchema: { type: "object", properties: {} }
    },
Behavior2/5

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

With no annotations provided, the description carries the full disclosure burden but offers minimal behavioral context. It does not explain what the endpoint returns, whether it has side effects, rate limits, or if it requires authentication to succeed.

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?

Extremely concise at six words. While not wasteful, it is under-specified for the behavioral transparency needed. A brief addition about the endpoint's purpose would improve this without sacrificing structure.

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?

Given zero parameters and likely simple health-check semantics, the description is minimally sufficient. However, with many sibling tools available, clarifying this tool's specific role (e.g., 'auth/connection test') would improve completeness.

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?

Input schema contains zero parameters, triggering the baseline score of 4. The description appropriately implies no configuration is needed for this endpoint call.

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

Purpose3/5

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

The description states it calls the Yuque hello endpoint, identifying the service and specific endpoint. However, it fails to explain what the hello endpoint actually does (e.g., connectivity test, auth verification) or why an agent would invoke it versus alternatives like yuque_request.

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?

No guidance provided on when to use this tool versus the generic yuque_request tool or other alternatives. No mention of prerequisites, typical use cases (e.g., testing credentials), or when to avoid using it.

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/MichealJou/yuque-mcp-plus'

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