Skip to main content
Glama
MichealJou

yuque-mcp-plus

by MichealJou
OverviewSchemaRelated ServersScoreDiscussions
JavaScript
Remote

yuque_update_doc

Modify existing documents in Yuque knowledge bases by updating titles, content, or formats to maintain current information.

Instructions

Update an existing doc.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
docIdYesYuque doc ID.
repoIdNoYuque repository ID.
repoNamespaceNoYuque repository namespace.
titleNoOptional new title.
bodyNoOptional new body.
formatNoOptional new format.

Implementation Reference

  • src/tools.js:443-443 (handler)
    The handler function that executes the yuque_update_doc tool logic.
    yuque_update_doc: async (args, client) => jsonText(await client.updateDoc(args.docId, args)),
  • src/tools.js:182-196 (schema)
    The schema definition and registration for the yuque_update_doc tool.
    {
  name: "yuque_update_doc",
  description: "Update an existing doc.",
  inputSchema: {
    type: "object",
    properties: {
      docId: schemaProperty("number", "Yuque doc ID."),
      ...repoRefSchema(),
      title: schemaProperty("string", "Optional new title."),
      body: schemaProperty("string", "Optional new body."),
      format: schemaProperty("string", "Optional new format.", { enum: ["markdown", "lake", "html"] })
    },
    required: ["docId"]
  }
},

Tool Definition Quality

C2.3/5.0
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 yet fails to specify partial update semantics (whether omitted optional fields like title/body/format preserve existing values or are cleared), versioning behavior, or what response is returned.

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?

The single sentence is appropriately brief and front-loaded, but suffers from under-specification rather than efficient information delivery given the tool's complexity.

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?

For a 6-parameter mutation operation with no output schema or annotations, the description is inadequate. It lacks context about the Yuque platform, error conditions, field mutability rules, or the interaction between docId and repository identifiers.

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%, providing the baseline score. The description adds no parameter relationships (e.g., whether repoId and repoNamespace are mutually exclusive options) or semantic constraints beyond what the schema already documents.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose2/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description "Update an existing doc" merely expands the camelCase tool name into a sentence without adding specificity. It fails to distinguish from siblings like yuque_create_doc or indicate which document attributes can be modified.

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?

No guidance provided on when to use this tool versus yuque_create_doc (create vs update) or yuque_get_doc (read vs mutate), nor any mention of prerequisites like authentication or repository membership requirements.

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