Skip to main content
Glama

yuque_search

Search Yuque docs and repositories by keyword and type, with filters for scope, author, and page to locate content quickly.

Instructions

General search across Yuque docs and repos. GET /search?q=:q&type=:type. 详见 references/api/search_api.md

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
qYesSearch keyword (required, max 200 chars)
pageNoPage number (1-100)
typeYesSearch type: doc (document) / repo (repository)
scopeNoSearch scope (max 400 chars), e.g. group or group/book_slug
creatorNoFilter by author login

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

C2.9/5.0
Behavior2/5

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

No annotations are provided, so the description carries the full load. It mentions the HTTP GET method, implying a safe read, but omits any details about authentication, rate limits, pagination behavior, or result format. For a search tool with no annotations, this is insufficient.

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?

The description is very concise and front-loads the purpose. The endpoint template and the reference to an external file add minor value but are compact and do not bloat the text. A slight deduction for the potentially unhelpful external reference.

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?

With no annotations and no output schema, the description should compensate by explaining when to use this tool and what to expect from the search. It lacks usage differentiation from sibling search tools and omits any return behavior or pagination context, leaving significant gaps for an agent.

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 the schema already documents all five parameters thoroughly. The description repeats only q and type in an endpoint template and adds no meaning beyond what the schema provides. Baseline 3 is appropriate.

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 (search) and resource (Yuque docs and repos), which is clear. However, it does not differentiate itself from sibling search tools like yuque_rag_search or yuque_web_search, so an agent cannot tell them apart without opening schemas.

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 offers no guidance on when to use this tool versus alternatives such as yuque_rag_search, yuque_web_search, or yuque_list_docs. There are no exclusions or context cues beyond the word 'General'.

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