search_docs

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

With no annotations provided, the description carries the full burden. It discloses that the search covers function names, Chinese names, descriptions, and call signatures, and supports both languages. This adds meaningful behavioral context beyond a generic 'search docs', though it doesn't mention any limits or output details.

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 concise and front-loaded with the core purpose, followed by a short bilingual repetition and an Args section. Every sentence earns its place without unnecessary fluff, making it easy to parse quickly.

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 (one parameter, output schema present), the description covers the essential purpose, search scope, and parameter semantics. It lacks explicit guidance on when to use sibling tools, but overall it is adequate for an agent to select and invoke the tool correctly.

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 provides no description for the single 'keyword' parameter (0% coverage). The description compensates by explaining 'keyword' is a search term in English or Chinese and that it matches specific doc fields, adding value beyond the bare 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?

The description clearly states the tool 'Search JoinQuant API docs by keyword', with a specific verb and resource. It also specifies scope (English/Chinese, matching function names, descriptions, signatures), distinguishing it from sibling tools like lookup_function which likely target exact lookups.

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 usage for keyword-based search across docs, and the mention of English/Chinese and searchable fields gives context. However, it does not explicitly state when to prefer this over alternatives like lookup_function or list_by_section, nor provide exclusions.

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