Skip to main content
Glama
Sign In

CometChat Docs

by io.github.cometchat
OverviewDiscussionsAdmin

Get a CometChat Implementation Bundle

get_cometchat_implementation_bundle
Read-only

Returns one CometChat implementation bundle: the scenario's current documentation pages (for a UI Kit, its integration guide, then the platform's AI reference page) compiled into one markdown document, each headed by its source URL, plus paths of related pages, the prerequisites, and a last_verified date.

Eleven bundles cover UI Kit quickstarts (React, Angular, React Native, Flutter, iOS, Android), JavaScript SDK messaging, the no-code widget, moderation setup, multi-tenant chat, and presence and typing. list_cometchat_bundles names them all; for a topic no bundle covers, or for one reference page rather than a setup's pages, search_cometchat_docs searches the documentation.

bundle is an identifier, not a title and not a framework: 'react-uikit-quickstart', rather than 'React UI Kit' or 'react'. One that is well-formed but names no bundle returns unknown_bundle listing every valid one; anything else, invalid_input. Pages are included whole, in order, while the document fits in 60 KiB; a page that does not fit is listed by path under More pages rather than cut, except a first page too big on its own, which is cut at a paragraph and ends with a link to the full page. Pages are read from the live docs site; no key or account is needed. A built bundle is served for 10 minutes, then refreshed in the background. A page that cannot be loaded does not fail the call: the previous bundle, or a partial one naming the pages it lacks, is served instead, and backend_unavailable is returned only when no page loads and nothing is cached yet.

Input Schema

NameRequiredDescriptionDefault
bundleYesBundle identifier as list_cometchat_bundles returns it, e.g. 'react-uikit-quickstart': lowercase letters, digits and hyphens, opening with a letter or digit, up to 100 characters.

Output Schema

NameRequiredDescriptionDefault
titleYesHuman-readable bundle title.
bundleYesBundle identifier, as passed in.
contentYesThe bundle's documentation pages as markdown, each headed by its source URL, followed by the paths of related pages and of any page that did not fit or could not be loaded.
frameworkYesFramework or platform the bundle targets; 'any' when platform-neutral.
last_verifiedYesISO date this bundle's list of documentation pages was last reviewed. The page content itself is read from the live documentation.
prerequisitesYesWhat must be in place before following the bundle's pages, such as a runtime version or CometChat app credentials.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed6 schema fields changed
    • changedInput schema / properties / bundle / description
      Previous value: -"Bundle name in lowercase kebab-case, e.g. 'react-uikit-quickstart'."New value: +"Bundle identifier as list_cometchat_bundles returns it, e.g. 'react-uikit-quickstart': lowercase letters, digits and hyphens, opening with a letter or digit, up to 100 characters."
    • changedOutput schema / properties / bundle / description
      Previous value: -"Bundle identifier."New value: +"Bundle identifier, as passed in."
    • changedOutput schema / properties / content / description
      Previous value: -"The full implementation recipe as markdown."New value: +"The bundle's documentation pages as markdown, each headed by its source URL, followed by the paths of related pages and of any page that did not fit or could not be loaded."
    • changedOutput schema / properties / framework / description
      Previous value: -"Target framework/platform."New value: +"Framework or platform the bundle targets; 'any' when platform-neutral."
    • changedOutput schema / properties / last_verified / description
      Previous value: -"Date the bundle was last verified against live SDK versions."New value: +"ISO date this bundle's list of documentation pages was last reviewed. The page content itself is read from the live documentation."
    • changedOutput schema / properties / prerequisites / description
      Previous value: -"Prerequisites before applying the bundle."New value: +"What must be in place before following the bundle's pages, such as a runtime version or CometChat app credentials."
  2. Changed1 schema field changed
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
+  "additionalProperties": false,
+  "properties": {
+    "bundle": {
+      "description": "Bundle identifier.",
+      "type": "string"
+    },
+    "content": {
+      "description": "The full implementation recipe as markdown.",
+      "type": "string"
+    },
+    "framework": {
+      "description": "Target framework/platform.",
+      "type": "string"
+    },
+    "last_verified": {
+      "description": "Date the bundle was last verified against live SDK versions.",
+      "type": "string"
+    },
+    "prerequisites": {
+      "description": "Prerequisites before applying the bundle.",
+      "items": {
+        "type": "string"
+      },
+      "type": "array"
+    },
+    "title": {
+      "description": "Human-readable bundle title.",
+      "type": "string"
+    }
+  },
+  "required": [
+    "bundle",
+    "title",
+    "framework",
+    "prerequisites",
+    "last_verified",
+    "content"
+  ],
+  "type": "object"
+}
  3. First observed

TDQS

A4.8/5.0
Behavior5/5

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

Annotations only declare read-only and non-destructive; the description adds substantial context beyond them: whole pages in order, a 60 KiB document budget, oversized pages listed under 'More pages' rather than truncated (with a paragraph-level cut exception for an oversized first page), a 10-minute serve window with background refresh, graceful degradation via the previous or partial bundle, and backend_unavailable only when nothing loads and nothing is cached. No key or account required is also stated, which annotations cannot express.

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

Conciseness4/5

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

Front-loaded with what is returned, then alternatives, then the parameter trap, then operational behavior — a sensible order. The prose is dense with semicolon-linked clauses and a long final sentence about failure modes, which costs a little readability, but every sentence carries information an agent needs to call the tool correctly.

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?

An output schema exists, so return shape need not be restated, and the description still covers the operational envelope an agent must anticipate: content ordering, size limits and truncation, caching staleness, and degraded/error responses. Nothing material for correct invocation is missing given a single required parameter.

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% and already documents the identifier's format, so the baseline is 3; the description earns an extra point by clarifying that the value is an identifier, not a title or framework ('react-uikit-quickstart', not 'React UI Kit' or 'react'), and by mapping the two distinct error outcomes (unknown_bundle with the valid list versus invalid_input) to the kinds of wrong input. It does not add syntax beyond the schema, so it stops short of 5.

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?

Names a specific verb and resource ('Returns one CometChat implementation bundle') and immediately defines the artifact: the scenario's documentation pages compiled into one markdown document, each headed by its source URL, plus related paths, prerequisites, and a last_verified date. The following sentence enumerates the eleven covered scenarios, so an agent knows exactly what content surface this tool owns versus its siblings.

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

Usage Guidelines5/5

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

Explicitly routes between siblings: list_cometchat_bundles names the bundles, search_cometchat_docs is the fallback for a topic no bundle covers or for a single reference page, and fetch_cometchat_doc_page covers the single-page case. Both the when and the when-not conditions are stated, not implied.

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

All CometChat Docs toolsInspect
Try in Browser
Claude Code, inside the Godot 4 editorFlockbay puts an AI agent in the real Godot 4 editor: it writes GDScript, runs your game and fixes what breaks. Free, or bring your own Claude Code or Codex.flockbay.comAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources