yuque_search_and_read

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It states the tool searches and optionally reads the first hit, which implies a read-only operation, but it does not disclose what the return value looks like (e.g., whether read_first=true returns the full document content or just a summary), how results are ordered, or behavior when no hits are found. It adds some context but lacks richer behavioral detail.

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?

The description is a single sentence of 12 words, front-loading the core action ('Search docs') and adding the optional behavior ('read the first hit in one call'). Every word earns its place; there is no redundancy or verbosity.

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?

Given the tool's simplicity, the description covers the basic purpose but is incomplete. There is no output schema and no annotations, so the description should clarify the return format (e.g., whether it returns a list of hits or the full document when read_first is true). It also does not mention pagination, sorting, or error behavior. While the tool is not highly complex, the lack of these details makes the description only minimally sufficient.

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?

Schema description coverage is 0%, so the description must compensate for the missing parameter docs. The description mentions 'search docs' and 'read the first hit,' which loosely maps to 'query' and 'read_first,' but it does not explain 'namespace' or 'limit.' The parameter names are partially self-explanatory, but the description adds minimal value beyond the schema, leaving meaning of 'namespace' ambiguous and not clarifying the role of 'limit' in the combined operation.

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?

The description uses a specific verb+resource: 'Search docs' and clearly states the optional action 'read the first hit in one call.' This distinguishes it from sibling tools like yuque_search_docs (search only) and yuque_get_doc (read a specific doc), making the combined functionality immediately clear.

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?

The description implies the tool combines searching and reading, but it does not explicitly state when to use this tool versus alternatives, nor does it mention conditions like 'use this when you need both search and read in one call' or 'if you only need search results, use yuque_search_docs.' It provides context but no exclusions or alternatives.

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