Skip to main content
Glama

yuque_get_toc

Retrieve the table of contents for a Yuque repository to navigate document hierarchies and manage content structure.

Instructions

Alias of yuque_get_repository_toc_tree for compatibility with official naming.

Input Schema

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

Implementation Reference

  • The handler for the tool logic, which routes to the yuque-client implementation.
    yuque_get_repository_toc_tree: async (args, client) => jsonText(await client.getRepositoryTocTree(args)),
  • The schema definition for the underlying tool 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.")
        }
      }
    },
  • src/tools.js:490-493 (registration)
    Registration of yuque_get_toc as an alias for yuque_get_repository_toc_tree.
      name: "yuque_get_toc",
      description: "Alias of yuque_get_repository_toc_tree for compatibility with official naming.",
      inputSchema: TOOL_DEFINITIONS.find((tool) => tool.name === "yuque_get_repository_toc_tree").inputSchema
    },
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 provides minimal behavioral context. It states the alias relationship but does not clarify that this is a read-only operation, what data structure it returns, error conditions, or whether it requires authentication/authorization.

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 single-sentence description is efficiently structured and front-loaded with the essential alias information. Every word serves a purpose, though extreme brevity is insufficient given the lack of supporting annotations or output schema.

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?

Without annotations or output schema, the description should explain return values and operational behavior. Merely stating 'alias' leaves critical gaps in the agent's understanding of what invoking this tool actually accomplishes or returns.

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 and repoNamespace are fully documented). The description adds no parameter-specific context (e.g., mutual exclusivity rules, namespace format examples), warranting the baseline score of 3 for high-coverage schemas.

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 the tool as an alias of 'yuque_get_repository_toc_tree' and mentions 'official naming' compatibility, which provides relational context. However, it fails to state what the tool actually does (retrieves table of contents), relying entirely on the tool name and the referenced sibling tool's presumed functionality.

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

Usage Guidelines3/5

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

The phrase 'for compatibility with official naming' weakly implies when this variant might be preferred over the sibling tool. However, there is no explicit guidance on when to use this versus yuque_get_repository_toc_tree, or whether there are behavioral differences between the two.

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