Search CometChat Documentation

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

Annotations already declare readOnlyHint=true, so description does not need to reiterate safety. The description adds that it returns ranked snippets with titles and direct links, which is useful but not rich behavioral context beyond what a search tool implies.

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: first captures purpose and scope, second describes output format, third mentions the optional version filter. No redundancies, well front-loaded, and every sentence serves a clear 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?

With 100% schema coverage and clear annotations, the description covers output format and the version filter. It does not explain pagination behavior for the `limit` parameter, but that is minimal. Overall sufficient for a search tool without output schema.

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 100% with descriptions for all parameters. The description adds value by listing the content domains searched (SDK guides, UI Kit, etc.), which clarifies what the query parameter targets. No additional semantics for `limit` or `version` beyond 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?

Clearly lists the verb 'searches' and the resource 'CometChat documentation' with an extensive enumeration of covered content types (SDK guides, UI Kit, REST API, etc.). Distinguishes from sibling tools implicitly by focusing on search vs. fetch or implementation retrieval.

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 explicit guidance on when to use this tool over siblings (fetch_cometchat_doc_page, get_cometchat_implementation_bundle). Does not mention when not to use it or provide context for alternative tools.

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