Skip to main content
Glama

yuque_delete_doc

Remove documents from Yuque knowledge base by specifying document ID, repository ID, or namespace to manage content hierarchies and maintain organized repositories.

Instructions

Delete a doc by ID.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
docIdYesYuque doc ID.
repoIdNoYuque repository ID.
repoNamespaceNoYuque repository namespace.

Implementation Reference

  • The handler function for the yuque_delete_doc tool, which executes the delete operation via the client.
    yuque_delete_doc: async (args, client) => {
      await client.deleteDoc(args.docId, args);
      return jsonText({ ok: true, docId: args.docId });
    },
  • The schema registration for the yuque_delete_doc tool, defining its input parameters and description.
    name: "yuque_delete_doc",
    description: "Delete a doc by ID.",
    inputSchema: {
      type: "object",
      properties: {
        docId: schemaProperty("number", "Yuque doc ID."),
        ...repoRefSchema()
      },
      required: ["docId"]
Behavior2/5

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

No annotations provided, so description carries full burden. 'Delete' implies destruction but lacks critical disclosure: permanence vs soft-delete, authentication requirements, cascading effects (TOC removal), or error handling for non-existent IDs.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Extremely brief (3 words) with no redundancy, but underspecified rather than optimally concise. Given destructive nature and unexplained optional parameters, the brevity leaves critical gaps rather than earning efficiency points.

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 destructive 3-parameter tool with no annotations or output schema. Missing: behavioral safety details, optional parameter rationale, return value description, and sibling differentiation expected for deletion operations.

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%, establishing baseline 3. Mentions 'by ID' hinting at docId, but adds no semantic value for the optional repoId/repoNamespace parameters (why they exist, validation rules, or when to include them).

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 (Delete) + resource (doc) + identifier method (by ID). Specifies 'doc' distinguishing from sibling tools yuque_delete_repo and yuque_delete_toc_node. Could be 5 if it explicitly contrasted with repo/toc deletion or clarified Yuque-specific behavior.

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 versus alternatives (e.g., yuque_update_doc for archiving), nor does it explain the optional repoId/repoNamespace parameters or why only docId is required.

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