Skip to main content
Glama

yuque_update_toc

Create, move, edit, or delete nodes in a Yuque repository's table of contents. Deletion requires confirm='DELETE'.

Instructions

Update repo TOC (create/move/edit/delete nodes). ⚠️ Deleting requires confirm='DELETE'. PUT /repos/:id/toc. 详见 references/api/toc_api.md

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
urlNoNode URL (required for creating link, optional for edit)
typeNoNode type: DOC, LINK, TITLE (required for create, optional for edit)
titleNoNode title (required for creating group/link, optional for edit)
actionYesAction type (required): appendNode, prependNode, editNode, removeNode
book_idYesRepository ID or namespace (required)
confirmNoConfirmation token. Must be set to the exact string 'DELETE' to proceed. This is a safety guard against accidental deletion.
doc_idsNoDocument ID array, e.g. [123,456] (required for creating doc nodes)
visibleNoVisible: 0=hidden, 1=visible (default 1)
node_uuidNoTarget node UUID (required for move/edit/delete)
action_modeYesAction mode (required): sibling, child
open_windowNoOpen in new window: 0=same page, 1=new window (optional for links, default 0)
target_uuidNoTarget node UUID, defaults to root if omitted

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.3/5.0
Behavior3/5

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

With no annotations, the description carries the full burden. It usefully discloses the critical destructive-op guard ('Deleting requires confirm=DELETE'), which is the most important behavioral trait for a mutation tool. However, it omits auth/permission requirements, whether the update replaces the whole TOC or is incremental, and any response behavior.

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?

Three compact clauses, front-loaded with purpose, then the safety-critical warning, then the endpoint and reference pointer. Every element earns its place with no filler.

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?

For a 12-parameter mutation tool with no annotations and no output schema, the description is thin. It covers the delete guard and the action set, but leaves the semantics of moves (node_uuid vs target_uuid), permission needs, and return behavior to the schema alone.

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 description coverage is 100%, so the schema already documents all 12 parameters. The description only restates the confirm='DELETE' rule that the schema itself explains, adding no new syntax or format detail beyond the structured fields. Baseline 3 applies.

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?

States a specific verb+resource ('Update repo TOC') and enumerates the sub-operations it performs (create/move/edit/delete nodes). This is clear enough to distinguish it from read-only siblings like yuque_get_toc, though it does not explicitly call out yuque_batch_update_toc, the closest sibling.

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?

There is no explicit when-to-use guidance or reference to alternatives. The parenthetical action list hints at scope, but nothing tells the agent when to prefer this over yuque_batch_update_toc or the web catalog-move tools.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.