Skip to main content
Glama

yuque_get_repository_toc_tree

Retrieve the complete table of contents structure for a Yuque repository, showing nested directories and documents to navigate content hierarchies.

Instructions

Get the full repository TOC tree, including nested directories and docs.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
repoIdNoYuque repository ID.
repoNamespaceNoYuque repository namespace, for example user/repo.

Implementation Reference

  • The handler implementation for yuque_get_repository_toc_tree.
    yuque_get_repository_toc_tree: async (args, client) => jsonText(await client.getRepositoryTocTree(args)),
  • The definition and schema for yuque_get_repository_toc_tree.
    {
      name: "yuque_get_repository_toc_tree",
      description: "Get the full repository TOC tree, including nested directories and docs.",
      inputSchema: {
        type: "object",
        properties: {
          ...repoRefSchema(),
          repoNamespace: schemaProperty("string", "Yuque repository namespace, for example user/repo.")
        }
      }
    },
Behavior3/5

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

No annotations provided, so description carries full burden. Successfully conveys this returns a hierarchical structure ('tree', 'nested') and is comprehensive ('full'). Missing behavioral details like performance characteristics, rate limits, or whether this is an expensive operation compared to flat TOC retrieval.

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, front-loaded with the action, zero redundancy. Every phrase earns its place: 'full' signals completeness, 'tree' signals hierarchy, 'nested directories and docs' specifies scope.

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?

Adequate for a 2-parameter read operation without output schema. Covers core purpose but has gaps regarding sibling tool relationships and parameter usage logic. Should explain how this differs from 'yuque_get_toc' (likely flat vs hierarchical) to ensure correct agent selection.

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 coverage is 100% with clear descriptions for repoId and repoNamespace. Description adds no parameter-specific details, meeting baseline 3. Does not compensate for the schema's lack of guidance on parameter mutual exclusivity (which identifier to use when).

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?

Clear verb (Get) and resource (repository TOC tree) with scope details (full, nested directories and docs). However, lacks explicit differentiation from sibling tool 'yuque_get_toc', leaving ambiguity about which TOC retrieval tool to select.

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 when to use this versus 'yuque_get_toc' or other repository navigation tools. Also fails to clarify that while both repoId and repoNamespace are optional in schema, at least one is required to identify the target repository.

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