Skip to main content
Glama

yuque_create_doc

Create documents in Yuque knowledge bases with optional parent directory attachment for organized content management.

Instructions

Create a doc. If parentUuid is provided, the doc is attached under that TOC node.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
repoIdNoYuque repository ID.
repoNamespaceNoYuque repository namespace.
titleYesDoc title.
bodyNoMarkdown or lake body.
formatNoDoc format.
slugNoOptional slug.
parentUuidNoOptional TOC parent UUID.

Implementation Reference

  • Handler for yuque_create_doc that calls client.createDoc.
    yuque_create_doc: async (args, client) => jsonText(await client.createDoc(args)),
  • Registration and schema for yuque_create_doc.
    name: "yuque_create_doc",
    description: "Create a doc. If parentUuid is provided, the doc is attached under that TOC node.",
    inputSchema: {
      type: "object",
      properties: {
        ...repoRefSchema(),
        title: schemaProperty("string", "Doc title.", { minLength: 1 }),
        body: schemaProperty("string", "Markdown or lake body."),
        format: schemaProperty("string", "Doc format.", { enum: ["markdown", "lake", "html"] }),
        slug: schemaProperty("string", "Optional slug."),
        parentUuid: schemaProperty("string", "Optional TOC parent UUID.")
      },
      required: ["title"]
    }
Behavior2/5

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

With no annotations provided, the description carries full disclosure burden but only explains TOC attachment behavior. It fails to disclose that this is a mutating write operation, potential failure modes (duplicate titles, invalid repo), return value structure, or whether the operation is idempotent.

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 terse at two sentences with no waste, and properly front-loaded with the primary action. However, given the 7-parameter complexity, lack of annotations, and mutation nature, the description is undersized—failing to explain critical behavioral aspects that would guide proper invocation.

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?

Inadequate for a creation tool with no output schema and no annotations. Missing: return value documentation, repoId vs repoNamespace relationship (both optional in schema but likely one required), format default behavior, and confirmation that this performs a write operation.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

While schema coverage is 100% (baseline 3), the description adds valuable semantic context for parentUuid specifically—explaining that the doc attaches 'under that TOC node' rather than merely identifying it as a UUID, clarifying the hierarchical relationship implied by the parameter.

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 clear verb ('Create') and resource ('doc'), distinguishing from sibling tools like yuque_update_doc and yuque_delete_doc. However, it could explicitly identify this as a Yuque document versus generic documentation to further differentiate from repo/table of contents creation tools.

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?

Provides implicit guidance by explaining the parentUuid attachment behavior (when to use that parameter), but lacks explicit when-to-use guidance versus siblings like yuque_create_toc_node or prerequisites like requiring valid repo credentials.

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