kb2_search

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

With no annotations, the description carries the full burden. It discloses pagination behavior (first page only, hasMore flag) and the auth scope 'note', which are important operational details. It does not mention return format or explicitly state read-only behavior, but search semantics imply no mutation.

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 Russian sentences, each delivering distinct information: purpose, pagination caveat, and scope requirement. No filler or redundant text.

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 search tool with full schema coverage and no output schema, the description covers purpose, search fields, pagination, and auth. It lacks return format and error handling details, but these are less critical for a search operation. The guidance to 'refine the query' when hasMore=true is somewhat vague but acceptable.

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 already covers both parameters with descriptions, so baseline is 3. The description adds meaning by specifying that the query searches by title and content and that limit pertains to the first page size, going beyond the schema's generic wording.

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's function: 'Поиск документов базы знаний 2.0 по заголовку и содержимому' (Search of knowledge base 2.0 documents by title and content). This provides a specific verb, resource, and scope, and the '2.0' label distinguishes it from sibling tools like kb_search and kb2_list.

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 gives practical context: it searches KB 2.0 by title/content, warns that Bitrix24 returns only the first page, advises refining the query when hasMore=true, and specifies the required scope 'note'. It does not explicitly name alternative tools, but the '2.0' designation and search fields imply the intended use case.

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