akshare_discover

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

No annotations provided, so description carries full burden. It states 'Returns matching functions grouped by tool name' and that empty query returns full index. Does not mention side effects, auth, or limits, but for a search tool, the disclosed behavior is adequate.

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?

Three concise sentences, each with clear purpose: purpose, usage guidance, empty query behavior. No wasted words; front-loaded with the core function.

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?

For a simple discovery tool with one optional parameter and an existing output schema, the description covers all essential aspects: what it does, when to use, output format, and special case (empty query). No gaps identified.

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 description must compensate. It explains that the query parameter is a keyword for search and that an empty query returns the full index. Provides useful context beyond schema, though could elaborate on match rules (e.g., case sensitivity).

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?

Description clearly states purpose: 'Search for akshare functions by keyword across all data categories.' It specifies the verb (search), resource (akshare functions), and scope (all categories), effectively distinguishing from sibling tools that cover specific categories.

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?

Explicitly advises when to use: 'Use this to find the right function and its parent tool before making a data request.' Also describes behavior with empty query to see full index. Implies alternatives (the specific category tools) but does not explicitly state when not to use.

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