Skip to main content
Glama
MichealJou

yuque-mcp-plus

by MichealJou
OverviewSchemaRelated ServersScoreDiscussions
JavaScript
Remote

yuque_get_docs

Retrieve and list documents from a Yuque knowledge base repository to access and manage content structure.

Instructions

List docs in a repository.

Input Schema

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

Implementation Reference

  • src/tools.js:440-440 (handler)
    The handler function for the yuque_get_docs tool, which calls client.getDocs.
    yuque_get_docs: async (args, client) => jsonText(await client.getDocs(args, args)),
  • src/tools.js:142-153 (schema)
    The input schema definition for the yuque_get_docs tool.
    {
  name: "yuque_get_docs",
  description: "List docs in a repository.",
  inputSchema: {
    type: "object",
    properties: {
      ...repoRefSchema(),
      limit: schemaProperty("number", "Optional page size.", { minimum: 1, maximum: 100 }),
      offset: schemaProperty("number", "Optional offset.", { minimum: 0 })
    }
  }
},

Tool Definition Quality

C2.6/5.0
Behavior2/5

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

No annotations provided, yet the description adds no behavioral context: it doesn't confirm the read-only nature, mention return format, hint at pagination behavior, or disclose rate limits.

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 terse (5 words) and front-loaded with the verb, but underspecified rather than efficiently concise given the parameter complexity.

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?

Insufficient for a 4-parameter pagination tool with no output schema: lacks guidance on repository identification logic, pagination cursor behavior, and return structure.

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 has 100% description coverage, establishing baseline 3. The description adds no additional semantics (e.g., that repoId and repoNamespace are mutually exclusive options, or pagination defaults).

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?

States a clear verb ('List') and resource ('docs in a repository'), but fails to distinguish from sibling tools 'yuque_list_docs' and 'yuque_get_doc' (singular), leaving ambiguity about when to use each.

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?

Provides no guidance on which repository identifier to use (repoId vs repoNamespace, both optional in schema) or when to prefer this tool over 'yuque_list_docs' or 'yuque_get_doc'.

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