Skip to main content
Glama
cometchat

CometChat

Official
by cometchat
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Remote

Search CometChat Documentation

search_cometchat_docs
Read-only

Find CometChat documentation for SDKs, UI Kits, REST API, tutorials, and OpenAPI specs. Receive ranked snippets with direct links and version labels, preferring current docs. Optionally filter by version.

Instructions

Searches CometChat documentation including SDK guides (JavaScript, React, iOS, Android, Flutter, React Native), UI Kit references, REST API documentation, integration tutorials, and OpenAPI specs. Returns ranked snippets with titles and direct links to source pages. Pages for the current version of each SDK and UI Kit are preferred over older versions, and each result reports its version label and whether it is current. To reach older docs, pass the version filter with that version's label.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNoMaximum number of results to return. Default 10, maximum 25.
queryYesSearch query. 1–500 characters.
versionNoOptional version label from the docs version picker, e.g. 'v7' or 'v5'. Each SDK and UI Kit numbers its versions independently, so a label matches every product that uses it. Omit to search all versions, with current versions preferred.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultsYesRanked search results.
totalAvailableYesTotal matching pages available (may exceed the returned count).

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv0.1.6
    • changedInput schema / properties / version / description
      Previous value: -"Optional documentation version filter, e.g. 'v4' or 'v3'."New value: +"Optional version label from the docs version picker, e.g. 'v7' or 'v5'. Each SDK and UI Kit numbers its versions independently, so a label matches every product that uses it. Omit to search all versions, with current versions preferred."
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
+  "additionalProperties": false,
+  "properties": {
+    "results": {
+      "description": "Ranked search results.",
+      "items": {
+        "additionalProperties": false,
+        "properties": {
+          "isCurrent": {
+            "description": "False when the page documents an older version of its SDK or UI Kit.",
+            "type": "boolean"
+          },
+          "section": {
+            "description": "Documentation section the page belongs to.",
+            "type": "string"
+          },
+          "snippet": {
+            "description": "Matched excerpt with context.",
+            "type": "string"
+          },
+          "title": {
+            "description": "Page title.",
+            "type": "string"
+          },
+          "url": {
+            "description": "Direct link to the source page.",
+            "type": "string"
+          },
+          "version": {
+            "description": "Version label of the page's SDK or UI Kit, e.g. 'v7'. Omitted for pages that are not versioned.",
+            "type": "string"
+          }
+        },
+        "required": [
+          "title",
+          "url",
+          "snippet",
+          "section",
+          "isCurrent"
+        ],
+        "type": "object"
+      },
+      "type": "array"
+    },
+    "totalAvailable": {
+      "description": "Total matching pages available (may exceed the returned count).",
+      "type": "number"
+    }
+  },
+  "required": [
+    "results",
+    "totalAvailable"
+  ],
+  "type": "object"
+}
  2. First observedv0.1.5

TDQS

A4.3/5.0
Behavior4/5

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

Beyond the readOnlyHint annotation, the description discloses meaningful behaviors: results are ranked snippets, pages carry titles and direct links, current versions are preferred, and each result reports a version label and currency. This adds actionable behavioral detail that annotations alone do not provide.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is compact and front-loaded: the first sentence defines scope and output, the second explains version behavior and usage. Every sentence earns its place with no redundant filler.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a search tool with an output schema and readOnlyHint annotation, the description covers what the tool returns, what it searches, version handling, and how to access older content. Nothing essential for selecting or invoking it is missing.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the baseline is 3. The description adds value by explaining the version preference behavior and how the version filter interacts with it ('To reach older docs, pass the version filter'). This goes beyond the schema's dry parameter description.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a specific verb and resource ('Searches CometChat documentation') and enumerates the content scope (SDK guides, UI Kit references, REST API, tutorials, OpenAPI specs). It also differentiates itself from sibling tools like fetch_cometchat_doc_page by emphasizing ranked snippets, titles, and direct links rather than page retrieval or bundle listing.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides useful context on version behavior: current versions are preferred, and older docs require a version filter with the correct label. However, it does not explicitly say when to choose this tool over siblings like fetch_cometchat_doc_page, nor does it state exclusions or alternative conditions.

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

Deploy Server

Other Tools