agentbay_knowledge_query

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

The description states it performs a search and supports semantic search, indicating read-only behavior. However, with no annotations, the description should disclose more traits like side effects (none assumed) or data freshness. It is minimally transparent but not misleading.

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?

Two sentences with no extraneous words. The action verb 'Search' is front-loaded, and information is presented directly.

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 has 6 parameters, including enums, and no output schema, the description is too brief. It lacks details on pagination, result format, or how to refine searches. More coverage is needed for a tool of this complexity.

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 coverage is only 33% (2 out of 6 parameters have descriptions). The description hints at searching for patterns and pitfalls (mapping to the 'type' parameter) and semantic search (query), but ignores tags, limit, and scope. It partially compensates but falls short of fully explaining parameters.

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?

Clearly states the tool searches project knowledge for patterns, pitfalls, and learnings with semantic search. While the purpose is specific and the tool name is descriptive, the description does not explicitly differentiate it from sibling tools like agentbay_knowledge_export or agentbay_knowledge_record, though the distinction is implicit.

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?

No guidance on when to use this tool versus alternatives like agentbay_knowledge_manage or agentbay_brain_setup. The description does not mention prerequisites, typical use cases, or when not to use this tool.

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