yuque-mcp-plus

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

No annotations are provided, so the description carries the full burden. While 'Get' implies a read-only operation, the description lacks disclosure about error handling (e.g., 404 behavior), response format (Markdown vs HTML), or authentication requirements.

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

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

Extremely brief single sentence with no redundancy or wasted words. However, maximizing conciseness sacrifices necessary context, making it too minimal rather than appropriately sized for the tool's complexity.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With 3 parameters (2 optional), no annotations, and no output schema, the description is insufficient. It fails to explain the relationship between the required docId and optional repo parameters, nor does it hint at the return structure for this document retrieval operation.

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

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

The input schema has 100% description coverage, establishing a baseline of 3. The description adds no parameter-specific context (e.g., explaining that repoId and repoNamespace are mutually exclusive optional scoping parameters), but does not need to compensate given the complete schema.

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

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

States the basic action (Get) and resource (doc detail) plus the key identifier (doc ID), which minimally distinguishes it from sibling list operations like 'yuque_get_docs'. However, it does not clarify what 'detail' encompasses compared to 'yuque_get_doc_version' or other retrieval tools, and largely restates the tool name.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Does the description explain when to use this tool, when not to, or what alternatives exist?

Provides no guidance on when to use this versus 'yuque_get_docs' or 'yuque_list_docs', nor does it explain when the optional repoId or repoNamespace parameters are required (e.g., for private repositories vs public access).

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