Skip to main content
Glama

yuque_get_doc

Retrieve a Yuque document's details (body/body_html) by ID or slug. Use raw=true for Sheet/Table docs and body_lake/body_draft content.

Instructions

Get document detail (body/body_html). Sheet/Table docs and body_lake/body_draft need raw=true. Supports id or slug. GET /repos/docs/:id. 详见 references/api/doc_api.md

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "id": "<id>"
    },
    "name": "yuque_get_doc"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYesDocument ID (numeric) or slug (required)
rawNoReturn raw full JSON (default false, returns trimmed fields)
pageNoTable page number, ≥1, default 1
book_idNoRepository ID or namespace (optional; required when id is a slug)
page_sizeNoTable page size, 1-200, default 100

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv4.0.0
    • addedInput schema / properties / book_id
      Added value: +{
      +  "description": "Repository ID or namespace (optional; required when id is a slug)",
      +  "type": "string"
      +}
    • changedInput schema / properties / id / description
      Previous value: -"Document ID or slug (required)"New value: +"Document ID (numeric) or slug (required)"
  2. First observedv0.1.0

TDQS

A3.5/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 does disclose the default trimmed-field behavior versus raw full JSON and the doc types that force raw=true, which is real behavioral context. It omits permissions/auth requirements, error behavior, and what the trimmed payload actually contains, so the disclosure is partial.

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?

Four compact clauses, front-loaded with purpose and followed by the raw=true gotcha and the endpoint, with no filler. The trailing pointer to references/api/doc_api.md is opaque to an agent that cannot resolve the path, so it is borderline waste.

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 5-parameter read tool with no annotations and no output schema, the description covers the critical gotchas (raw for table/lake docs, slug needs book_id per schema) but says nothing about the response shape or failure modes. Adequate to call correctly, thinner than ideal for interpreting results.

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?

Schema coverage is 100%, so the baseline would be 3, but the description adds meaning the schema lacks: that raw=true is mandatory for Sheet/Table docs and body_lake/body_draft documents, which prevents a silently wrong call. It adds nothing for page/page_size beyond the schema, keeping it short of a 5.

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?

The description states a specific verb and resource ("Get document detail (body/body_html)") and names the concrete return fields, so the agent knows exactly what it retrieves. It does not, however, distinguish itself from near siblings such as yuque_web_get_doc or yuque_batch_get_docs, so differentiation is left implicit.

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?

It gives conditional guidance for the raw flag ("Sheet/Table docs and body_lake/body_draft need raw=true") and notes id-or-slug support, which is genuinely useful. It offers no guidance on when to prefer this tool over web_get_doc or batch_get_docs, and no note on when slug usage requires book_id beyond what the schema already says.

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