Skip to main content
Glama

yuque_list_docs

Retrieve documents from a Yuque knowledge base repository using repository ID or namespace, with pagination controls for managing content access.

Instructions

Alias of yuque_get_docs for compatibility with official naming.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
repoIdNoYuque repository ID.
repoNamespaceNoYuque repository namespace.
limitNoOptional page size.
offsetNoOptional offset.

Implementation Reference

  • Handler for yuque_get_docs, which yuque_list_docs aliases.
    yuque_get_docs: async (args, client) => jsonText(await client.getDocs(args, args)),
  • src/tools.js:484-488 (registration)
    Registration of yuque_list_docs as an alias for yuque_get_docs.
    {
      name: "yuque_list_docs",
      description: "Alias of yuque_get_docs for compatibility with official naming.",
      inputSchema: TOOL_DEFINITIONS.find((tool) => tool.name === "yuque_get_docs").inputSchema
    },
Behavior2/5

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

No annotations are provided, so the description must carry full behavioral disclosure burden. It states nothing about read/write status, return values, pagination behavior, or side effects, merely identifying the alias relationship.

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?

Single sentence with zero waste. Every word earns its place by conveying the alias relationship and the rationale ('compatibility'), appropriate for a tool that genuinely is just an alias.

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 4 parameters, no annotations, and no output schema, the description is insufficient. It identifies the alias but omits what the tool actually returns, what authentication is required, or how pagination behaves (despite limit/offset parameters).

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?

Input schema has 100% description coverage (repoId, repoNamespace, limit, offset all documented), establishing baseline 3. The description adds no parameter context beyond what the schema provides.

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 identifies this as an alias of yuque_get_docs but fails to specify what operation is actually performed (listing/retrieving documents). It relies on the reader inferring functionality from the sibling tool name rather than stating it directly.

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

Usage Guidelines5/5

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

Explicitly names the sibling tool (yuque_get_docs) and explains the specific condition for using this variant: 'for compatibility with official naming.' This provides clear guidance on when to use this tool versus its functional equivalent.

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