Skip to main content
Glama

yuque_batch_get_docs

Fetch details for up to 20 Yuque documents at once by IDs or slugs for a specified book. Read-only batch lookup.

Instructions

Batch get document details (concurrent GET, read-only, max 20). 详见 references/api/doc_api.md

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idsYesDocument IDs as array, e.g. [123,456] or ["slug-a","slug-b"] (required, max 20)
rawNoReturn raw full JSON (default false, returns trimmed fields)
book_idYesRepository ID (numeric) or namespace like group/book_slug (required, shared for all docs)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.2/5.0
Behavior3/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, and it does add real behavioral facts: concurrent execution, read-only nature, and a 20-item ceiling. However, it omits return shape (trimmed vs raw handling) and failure behavior for invalid IDs, and the reference to references/api/doc_api.md is not something an agent can dereference.

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?

Two compact clauses, front-loaded with the verb and the key constraints; almost nothing is wasted. The trailing markdown-file reference is the one element that does not earn its place for an agent.

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 read-only batch fetch with no output schema, the essentials (batch semantics, read-only, cap) are present, but the concurrency/return-format behavior and what happens on partial failures are left unspecified. Adequate but with clear gaps.

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 all three parameters are already documented in the schema, including the 'max 20' bound and the raw/trimmed toggle. The description adds no parameter meaning beyond what the schema provides, making the baseline 3 correct.

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 ('Batch get document details') and its scope via 'batch' and 'max 20', which lets an agent distinguish it from the single-doc sibling yuque_get_doc. It does not explicitly name that alternative, so it falls short of a 5.

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?

The description gives no when-to-use guidance, no conditions selecting it over yuque_get_doc or yuque_list_docs, and no exclusions. The 'max 20' cap is a constraint, not usage guidance, so an agent must infer the batching rationale on its own.

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