Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -10582,6 +10582,10 @@
{
"source": "/ui-kit/react/v7/troubleshooting",
"destination": "/ui-kit/react/troubleshooting"
},
{
"source": "/ui-kit/kotlin/overview",
"destination": "/ui-kit/android/getting-started-kotlin"
}
],
"seo": {
Expand Down
190 changes: 148 additions & 42 deletions mcp-server.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,12 @@
canonical: "https://www.cometchat.com/docs/mcp-server"
---

The **CometChat MCP server** lets Claude, Cursor, Windsurf, VS Code, and any
other Model Context Protocol–compatible agent integrate CometChat into your
app from natural-language prompts. Ask the agent to *"add a chat tab where
users can DM each other"* and it uses the MCP to read CometChat's docs,
pick the right components for your stack, and write the integration code.
The **CometChat MCP server** lets Claude, Claude Code, Cursor, VS Code, Codex,
Windsurf, and any other Model Context Protocol–compatible agent integrate
CometChat into your app from natural-language prompts. Ask the agent to
*"add a chat tab where users can DM each other"* and it uses the MCP to read
CometChat's docs, pick the right components for your stack, and write the
integration code.

The server is **read-only** and **needs no account or API key** — it surfaces
CometChat's public documentation and curated implementation recipes.
Expand All @@ -20,58 +21,144 @@
https://mcp.cometchat.com/mcp
```

Transport: HTTP with Server-Sent Events. No authentication required.
Transport: Streamable HTTP. No authentication required. The server does not

Check warning on line 24 in mcp-server.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

mcp-server.mdx#L24

Did you really mean 'Streamable'?
offer the older SSE-only transport, so if your client asks for a transport
type, choose **HTTP** (Streamable HTTP).

Check warning on line 26 in mcp-server.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

mcp-server.mdx#L26

Did you really mean 'Streamable'?

## One-click install

<CardGroup cols={3}>
<Card title="Claude" icon="plug" href="https://claude.com/connectors/cometchat">
Open CometChat in Claude's connector directory and click **Add to Claude**.
</Card>
<Card title="Cursor" icon="arrow-pointer" href="https://cursor.com/en/install-mcp?name=cometchat-docs&config=eyJ1cmwiOiJodHRwczovL21jcC5jb21ldGNoYXQuY29tL21jcCJ9">
Opens Cursor and asks you to confirm the install.
</Card>
<Card title="VS Code" icon="code" href="https://insiders.vscode.dev/redirect/mcp/install?name=cometchat-docs&config=%7B%22type%22%3A%22http%22%2C%22url%22%3A%22https%3A%2F%2Fmcp.cometchat.com%2Fmcp%22%7D">
Opens VS Code and asks you to confirm the install.
</Card>
</CardGroup>

## Connect from your agent

### Claude (Desktop or claude.ai)
<Note>
If you installed [CometChat Agent Skills](/agent-skills), the installer already

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This reads as if any Agent Skills install already connected the server. npx @cometchat/skills add only writes the cometchat-docs entry for Claude Code, Cursor, Gemini and Codex, and not when --no-mcp is passed. Suggest: "If you installed Agent Skills for Claude Code, Cursor, Gemini or Codex, the installer already added this server as cometchat-docs (unless you passed --no-mcp)."

connected this server to your agent as `cometchat-docs`. You don't need to add
it again — skip to [Example prompts](#example-prompts).
</Note>

### Claude (claude.ai and Claude Desktop)

CometChat is listed in Claude's connector directory.

1. Open [CometChat in the connector directory](https://claude.com/connectors/cometchat)
and click **Add to Claude**. Or, in Claude, go to **Customize → Connectors**,
click **+**, choose **Browse connectors**, find **CometChat**, and click
**Connect**.
2. In a conversation, click **+** in the lower left, hover over **Connectors**,
and turn on **CometChat**.

On Team and Enterprise plans, an Owner first adds the connector from
**Organization settings → Connectors → Browse connectors**.

**Fallback: add it as a custom connector.** If the directory isn't available
to you, go to **Customize → Connectors**, click **+**, choose
**Add custom connector**, paste `https://mcp.cometchat.com/mcp` as the remote
MCP server URL, and click **Add**. Free plans allow one custom connector. See
Anthropic's [custom connector guide](https://support.claude.com/en/articles/11175166-get-started-with-custom-connectors-using-remote-mcp).

Check warning on line 68 in mcp-server.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

mcp-server.mdx#L68

Did you really mean 'Anthropic's'?

1. Open **Settings → Connectors**.
2. Click **Add custom connector**.
3. Name it `CometChat`, paste the URL `https://mcp.cometchat.com/mcp`, and click **Add**.
4. In a new conversation, attach **CometChat** from the connectors picker and prompt away.
### Claude Code

Run:

```bash
claude mcp add --transport http cometchat-docs https://mcp.cometchat.com/mcp
```

The server is added for the current project. Add `--scope user` to make it
available in every project. Check the connection with `claude mcp list`, or
run `/mcp` inside Claude Code.

### Cursor

1. `Cmd+Shift+P` (macOS) / `Ctrl+Shift+P` (Windows) → **Open MCP settings**.
2. Click **Add custom MCP** and paste:
1. Use the [one-click install link](https://cursor.com/en/install-mcp?name=cometchat-docs&config=eyJ1cmwiOiJodHRwczovL21jcC5jb21ldGNoYXQuY29tL21jcCJ9),
or add this to `~/.cursor/mcp.json` (every project) or `.cursor/mcp.json`
(one project):

```json
{
"mcpServers": {
"cometchat": {
"cometchat-docs": {
"url": "https://mcp.cometchat.com/mcp"
}
}
}
```

### Windsurf
2. Turn the server on or off from **Customize** in the sidebar.

### Visual Studio Code (Copilot Agent)

1. Click the **Plugins** (hammer) icon → **Manage plugins** → **View raw config**.
2. Paste:
1. Use the [one-click install link](https://insiders.vscode.dev/redirect/mcp/install?name=cometchat-docs&config=%7B%22type%22%3A%22http%22%2C%22url%22%3A%22https%3A%2F%2Fmcp.cometchat.com%2Fmcp%22%7D)
([VS Code Insiders](https://insiders.vscode.dev/redirect/mcp/install?name=cometchat-docs&config=%7B%22type%22%3A%22http%22%2C%22url%22%3A%22https%3A%2F%2Fmcp.cometchat.com%2Fmcp%22%7D&quality=insiders)),
or search for `@mcp cometchat` in the Extensions view and click **Install**.
2. To add it by hand instead, run **MCP: Add Server** from the Command Palette
(`Cmd+Shift+P` / `Ctrl+Shift+P`), choose **HTTP**, and enter
`https://mcp.cometchat.com/mcp`. Or add this to `.vscode/mcp.json`:

```json
{
"mcpServers": {
"cometchat": {
"type": "sse",
"serverUrl": "https://mcp.cometchat.com/mcp"
"servers": {
"cometchat-docs": {
"type": "http",
"url": "https://mcp.cometchat.com/mcp"
}
}
}
```

3. Save and click **Refresh**.
3. When VS Code asks, confirm that you trust the server.

### Visual Studio Code (Copilot Agent)
### Codex

1. `Cmd+Shift+P` / `Ctrl+Shift+P` → **MCP: Add MCP Server**.
2. Enter:
- **Server Name:** `CometChat`
- **Server URL:** `https://mcp.cometchat.com/mcp`
- **Transport:** SSE
3. Confirm.
Run:

```bash
codex mcp add cometchat-docs --url https://mcp.cometchat.com/mcp
```

Or add this to `~/.codex/config.toml`:

```toml
[mcp_servers.cometchat-docs]
url = "https://mcp.cometchat.com/mcp"
```

The Codex CLI, the IDE extension, and the ChatGPT desktop app share this
configuration. Check the connection with `codex mcp list`, or run `/mcp` in
the Codex TUI.

### Windsurf (Devin Desktop)

Windsurf is now Devin Desktop.

1. Open your MCP config file. With the Cascade agent, click the `...` (Actions)
menu at the top right of the Cascade panel, then **Open MCP config file**.
With the Devin Local agent, edit the config file described in
[Devin's MCP configuration docs](https://docs.devin.ai/cli/extensibility/mcp/configuration).
2. Add CometChat under `mcpServers`:

```json
{
"mcpServers": {
"cometchat-docs": {
"url": "https://mcp.cometchat.com/mcp"
}
}
}
```

3. Save the file.

## Example prompts

Expand All @@ -81,7 +168,7 @@
- *"Let project members talk in a group chat with file sharing."*
- *"Add video calling between two users with a click-to-call button."*
- *"Set up content moderation so banned words are blocked before delivery."*
- *"Build a multi-tenant SaaS chat where each workspace's users are isolated."*

Check warning on line 171 in mcp-server.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

mcp-server.mdx#L171

Did you really mean 'workspace's'?
- *"Add presence indicators and typing dots to my conversation list."*

The agent will search the docs, pull the matching implementation bundle,
Expand All @@ -89,23 +176,34 @@

## What the connector exposes

### Three tools (all read-only)
### Four tools (all read-only)

<CardGroup cols={3}>
<CardGroup cols={2}>
<Card title="search_cometchat_docs" icon="magnifying-glass">
Search SDK guides, UI Kit references, REST API docs, and OpenAPI
specs. Returns ranked snippets with direct links.
Search SDK guides, UI Kit references, REST API docs, integration
tutorials, and OpenAPI specs. Returns ranked snippets with titles and
direct links. Pages for the current version of each SDK and UI Kit are
preferred, and each result says whether it is current. Pass `version`
(for example `v5`) to search older docs.
</Card>
<Card title="fetch_cometchat_doc_page" icon="file-lines">
Fetch the full content of any documentation page as markdown by URL
or relative path.
Fetch one documentation page as markdown, with its title and section,
by full URL or relative path such as `/sdk/javascript/overview`. Moved
pages are followed to their new location.
</Card>
<Card title="get_cometchat_implementation_bundle" icon="box-open">
Return a curated implementation recipe — prerequisites, install,
configuration, working code — for a named scenario.
Return a curated implementation recipe by name — prerequisites, install
commands, configuration, working code, and common pitfalls — with the
date it was last verified.
</Card>
<Card title="list_cometchat_bundles" icon="list">
List every available implementation bundle with its identifier, title,
target framework, and last-verified date.
</Card>
</CardGroup>

Every tool returns structured results that match a declared output schema.

### Ten curated implementation bundles

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

#568 rewrites this section to say bundles are compiled from current doc pages, and it adds angular-uikit-quickstart. The live 0.1.6 server still returns 10 bundles with last_verified dates, so this text is accurate today. Please coordinate with #568 so the two don't land contradicting each other.


| Bundle | What it covers |
Expand All @@ -121,6 +219,9 @@
| `multi-tenant-chat` | Multi-tenant SaaS chat — auth, isolation, tenant-scoped users |
| `presence-and-typing` | Online presence, typing indicators, read receipts |

Each bundle is also available as an MCP resource at
`cometchat://bundles/<bundle-name>`.

### Orientation skill resource

The MCP also exposes a `cometchat://skills/overview` resource — a structured
Expand All @@ -129,12 +230,17 @@

## Source

The MCP server is open-source at
[`github.com/cometchat/cometchat-mcp`](https://github.com/cometchat/docs-mcp).
Built from this very documentation repository, so the content it surfaces
is always in sync with what you see on the docs site.
The MCP server is open source (Apache-2.0) at
[`github.com/cometchat/docs-mcp`](https://github.com/cometchat/docs-mcp).

Search runs on an index built from the
[CometChat docs repository](https://github.com/cometchat/docs). The server
rebuilds the index when the docs change, so a new or edited page can take a
few minutes to show up in search results. `fetch_cometchat_doc_page` reads
pages directly from this site. The implementation bundles are curated
separately, and each one records the date it was last verified.

## Support

Questions, feedback, or feature requests: open an issue on the
[GitHub repository](https://github.com/cometchat/docs-mcp/issues)
[GitHub repository](https://github.com/cometchat/docs-mcp/issues)
2 changes: 1 addition & 1 deletion sdk/android/3.0/kotlin-overview.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Android Kotlin UI Kit"
url: /docs/ui-kit/kotlin/overview"
url: "/ui-kit/android/getting-started-kotlin"
description: "Overview of Android Kotlin UI Kit in CometChat."
---
65 changes: 65 additions & 0 deletions ui-kit/android/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Android UI Kit"
sidebarTitle: "Overview"
description: "Prebuilt, customizable UI components for chat & messaging, voice & video calling — for both Jetpack Compose and Kotlin XML Views."

Check warning on line 4 in ui-kit/android/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/android/overview.mdx#L4

Did you really mean 'Jetpack'?
---

<Accordion title="AI Integration Quick Reference">
Expand All @@ -9,11 +9,12 @@
| Field | Value |
| --- | --- |
| Kotlin (XML Views) | `com.cometchat:chatuikit-kotlin-android` v6.x |
| Jetpack Compose | `com.cometchat:chatuikit-compose-android` v6.x |

Check warning on line 12 in ui-kit/android/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/android/overview.mdx#L12

Did you really mean 'Jetpack'?
| Shared core | `chatuikit-core` (ViewModels, repositories, data sources, events) |
| Peer deps | `com.cometchat:chat-sdk-android` >=4.x, `minSdk` 28 |

Check warning on line 14 in ui-kit/android/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/android/overview.mdx#L14

Did you really mean 'deps'?
| Calling | Optional — `com.cometchat:calls-sdk-android` |
| Source | [GitHub](https://github.com/cometchat/cometchat-uikit-android) |
| AI Skills | `npx @cometchat/skills add` — [Agent Skills](/agent-skills) |

</Accordion>

Expand All @@ -21,7 +22,7 @@

It ships in two flavors that share the same core (ViewModels, repositories, events), so you get identical behavior whichever you choose:

- **Jetpack Compose** — native Material 3 composables for modern, Compose-first apps.

Check warning on line 25 in ui-kit/android/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/android/overview.mdx#L25

Did you really mean 'Jetpack'?

Check warning on line 25 in ui-kit/android/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/android/overview.mdx#L25

Did you really mean 'composables'?
- **Kotlin (XML Views)** — drop-in Views for existing XML layout–based apps.

<Frame>
Expand All @@ -30,17 +31,81 @@

---

## Integrate with AI Coding Agents

Use [CometChat Agent Skills](/agent-skills) to add chat to any Android project through your AI coding agent. The skills take an AI-first approach — your agent has a short conversation with you to understand your project and chat requirements, then writes production-grade integration code tailored to the files you already have. The Android skills target **Android UI Kit v6** and cover both Jetpack Compose and Kotlin (XML Views).

Check warning on line 36 in ui-kit/android/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/android/overview.mdx#L36

Did you really mean 'Jetpack'?

Works with Claude Code, Cursor, Codex, GitHub Copilot, Kiro, Replit Agent, Gemini, Windsurf, Cline, Continue, and Aider — see the [full list](/agent-skills#supported-agents).

Check warning on line 38 in ui-kit/android/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/android/overview.mdx#L38

Did you really mean 'Kiro'?

Check warning on line 38 in ui-kit/android/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/android/overview.mdx#L38

Did you really mean 'Replit'?

```bash
npx @cometchat/skills add
```

Use `--ide <name>` to target a specific agent (e.g. `--ide cursor`), or `--ide all` to install for every supported agent.

Then in your agent:

```
/cometchat add chat to my app
```

The skills detect your toolkit (Compose or XML Views), Gradle setup, navigation pattern, and existing auth system. They onboard you to CometChat directly in the terminal — signup, login, and app creation all via the CLI. They read your activities, navigation graph, and layouts before proposing a placement, show the plan (which files they will create, modify, and leave untouched), and wait for your approval before writing code. Credentials land in `app/src/main/assets/cometchat-settings.json`.

Check warning on line 52 in ui-kit/android/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/android/overview.mdx#L52

Did you really mean 'Gradle'?

Check warning on line 52 in ui-kit/android/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/android/overview.mdx#L52

Did you really mean 'signup'?

After the first integration, re-run `/cometchat` anytime to pick from the iteration menu:

- **Customize look & feel** — theme presets (slack / whatsapp / imessage / discord / notion) or your own brand color

Check warning on line 56 in ui-kit/android/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/android/overview.mdx#L56

Did you really mean 'whatsapp'?

Check warning on line 56 in ui-kit/android/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/android/overview.mdx#L56

Did you really mean 'imessage'?
- **Add a feature** — 40+ features including calls, reactions, polls, AI smart replies, file sharing, presence
- **Customize a component** — custom message bubbles, headers, composer actions, empty/loading states
- **Set up production auth** — replace the dev Auth Key with a server-side token endpoint
- **Set up user management** — server endpoints for creating/updating/deleting CometChat users
- **Set up push notifications** — FCM end-to-end
- **Run diagnostics** — verify, drift detection, symptom-to-cause lookup

<Accordion title="Recommended: CometChat Docs MCP">

For deeper component customization (custom views, SDK events, request builders), connect the **CometChat Docs MCP** so your agent reads the current docs instead of guessing at APIs:

**Claude Code:**
```bash
claude mcp add --transport http cometchat-docs https://mcp.cometchat.com/mcp
```

**Cursor** (`.cursor/mcp.json`):
```json
{ "mcpServers": { "cometchat-docs": { "url": "https://mcp.cometchat.com/mcp" } } }
```

**Windsurf (Devin Desktop):**
```json
{ "mcpServers": { "cometchat-docs": { "url": "https://mcp.cometchat.com/mcp" } } }
```

No authentication required. `npx @cometchat/skills add` wires this up automatically for Claude Code, Cursor, Gemini, and Codex (pass `--no-mcp` to skip it) — add it by hand only for the other agents. For Claude Desktop, VS Code, and Codex, see [MCP Integration](/mcp-server).

</Accordion>

<CardGroup cols={2}>
<Card title="Agent Skills" icon="wand-magic-sparkles" href="/agent-skills">
Install, supported platforms, credentials, and the full skill list
</Card>
<Card title="MCP Integration" icon="plug" href="/mcp-server">
Connect the Docs MCP to Claude, Cursor, VS Code, Codex, and Windsurf
</Card>
</CardGroup>

---

## Get Started

Every integration starts the same way — install the SDK, initialize, and log in — then you build the UI with your chosen toolkit. Start with the prerequisites, then pick a path:

<Card title="Prerequisites & Setup" icon="key" href="/ui-kit/android/getting-started">
App credentials, Gradle install, `init()`, and `login()` — shared by both toolkits

Check warning on line 103 in ui-kit/android/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/android/overview.mdx#L103

Did you really mean 'Gradle'?

Check warning on line 103 in ui-kit/android/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/android/overview.mdx#L103

Did you really mean 'toolkits'?
</Card>

<CardGroup cols={2}>
<Card title="Jetpack Compose" icon="layer-group" href="/ui-kit/android/getting-started-jetpack">
Build your chat UI with native Material 3 composables

Check warning on line 108 in ui-kit/android/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/android/overview.mdx#L108

Did you really mean 'composables'?
</Card>
<Card title="Kotlin (XML Views)" icon="file-code" href="/ui-kit/android/getting-started-kotlin">
Build your chat UI with drop-in XML Views
Expand Down
2 changes: 1 addition & 1 deletion ui-kit/android/v5/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -44,11 +44,11 @@
/cometchat add chat to my app
```

The skill detects your Android project structure, build system (Gradle/Kotlin DSL), and existing auth system. It onboards you to CometChat directly in the terminal — signup, login, and app creation all via the CLI. It reads your Activities, Fragments, and navigation before proposing a placement, shows the plan, and waits for your approval before writing code. Credentials are saved to `local.properties` and accessed via `BuildConfig`.

Check warning on line 47 in ui-kit/android/v5/getting-started.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/android/v5/getting-started.mdx#L47

Did you really mean 'onboards'?

Check warning on line 47 in ui-kit/android/v5/getting-started.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/android/v5/getting-started.mdx#L47

Did you really mean 'signup'?

After the first integration, re-run `/cometchat` to access the iteration menu: theme presets, 40+ features, component customization, production auth, user management, and diagnostics.

Works with Claude Code, Cursor, Codex, VS Code Copilot, Windsurf, Cline, Kiro, and [30+ more agents](https://github.com/cometchat/cometchat-skills).
Works with Claude Code, Cursor, Codex, GitHub Copilot, Kiro, Replit Agent, Gemini, Windsurf, Cline, Continue, and Aider — see the [full list](/agent-skills#supported-agents).

Check warning on line 51 in ui-kit/android/v5/getting-started.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/android/v5/getting-started.mdx#L51

Did you really mean 'Kiro'?

Check warning on line 51 in ui-kit/android/v5/getting-started.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/android/v5/getting-started.mdx#L51

Did you really mean 'Replit'?

---

Expand All @@ -66,7 +66,7 @@
- Android Studio installed
- An Android emulator or physical device running Android 7.0 (API 24) or higher
- Java 8 or higher
- Gradle plugin 4.0.1 or later

Check warning on line 69 in ui-kit/android/v5/getting-started.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/android/v5/getting-started.mdx#L69

Did you really mean 'Gradle'?

<Warning>
Auth Key is for development only. In production, generate Auth Tokens server-side via the [REST API](/rest-api/chat-apis) and use [`loginWithAuthToken()`](/ui-kit/android/v5/methods#login-using-auth-token). Never ship Auth Keys in client code.
Expand All @@ -85,7 +85,7 @@

## Step 2 — Install Dependencies

Add the CometChat repository and dependencies to your Gradle configuration.

Check warning on line 88 in ui-kit/android/v5/getting-started.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/android/v5/getting-started.mdx#L88

Did you really mean 'Gradle'?

### Add the CometChat Repository

Expand Down Expand Up @@ -146,7 +146,7 @@
cometchat-calls-sdk = { module = "com.cometchat:calls-sdk-android", version.ref = "cometchat-calls-sdk" }
```

Now, in your app-level `build.gradle.kts` file, add the dependency using libs from Version Catalogs:

Check warning on line 149 in ui-kit/android/v5/getting-started.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/android/v5/getting-started.mdx#L149

Did you really mean 'libs'?

```gradle build.gradle.kts lines
dependencies {
Expand Down Expand Up @@ -178,7 +178,7 @@

### Add AndroidX Support

The Jetifier tool helps migrate legacy support libraries to AndroidX. Open `gradle.properties` and verify this line is present:

Check warning on line 181 in ui-kit/android/v5/getting-started.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/android/v5/getting-started.mdx#L181

Did you really mean 'Jetifier'?

```gradle gradle.properties lines
android.enableJetifier=true
Expand All @@ -190,7 +190,7 @@

To authenticate a user, you need a UID. You can either create users on the [CometChat Dashboard](https://app.cometchat.com), via the [SDK method](/ui-kit/android/v5/methods#create-user), or through the [REST API](/rest-api/chat-apis).

For development, use one of the pre-created test UIDs:

Check warning on line 193 in ui-kit/android/v5/getting-started.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/android/v5/getting-started.mdx#L193

Did you really mean 'UIDs'?

`cometchat-uid-1` · `cometchat-uid-2` · `cometchat-uid-3` · `cometchat-uid-4` · `cometchat-uid-5`

Expand Down
2 changes: 1 addition & 1 deletion ui-kit/android/v5/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Android UI Kit"
sidebarTitle: "Overview"
description: "Prebuilt Android Views for chat, voice, and video calling. Supports Kotlin and Java with XML and Jetpack Compose compatibility."

Check warning on line 4 in ui-kit/android/v5/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/android/v5/overview.mdx#L4

Did you really mean 'Jetpack'?
---

<Note>
Expand All @@ -13,7 +13,7 @@
| Field | Value |
| --- | --- |
| Package | `com.cometchat:chat-uikit-android` v5.x |
| Peer deps | `com.cometchat:chat-sdk-android` >=4.x, `minSdk` 24 |

Check warning on line 16 in ui-kit/android/v5/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/android/v5/overview.mdx#L16

Did you really mean 'deps'?
| Calling | Optional — `com.cometchat:calls-sdk-android` |
| Localization | 19 languages built-in |
| Source | [GitHub](https://github.com/cometchat/cometchat-uikit-android) |
Expand All @@ -33,7 +33,7 @@

Use [CometChat Skills](https://github.com/cometchat/cometchat-skills) to add chat to any Android project through your AI coding agent. The skill takes an AI-first approach — your agent has a short conversation with you to understand your project and chat requirements, then writes production-grade integration code tailored to the files you already have.

Works with Claude Code, Cursor, Codex, VS Code Copilot, Windsurf, Cline, Kiro, and [30+ more agents](https://github.com/cometchat/cometchat-skills).
Works with Claude Code, Cursor, Codex, GitHub Copilot, Kiro, Replit Agent, Gemini, Windsurf, Cline, Continue, and Aider — see the [full list](/agent-skills#supported-agents).

Check warning on line 36 in ui-kit/android/v5/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/android/v5/overview.mdx#L36

Did you really mean 'Kiro'?

Check warning on line 36 in ui-kit/android/v5/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/android/v5/overview.mdx#L36

Did you really mean 'Replit'?

```bash
npx @cometchat/skills add
Expand All @@ -47,11 +47,11 @@
/cometchat add chat to my app
```

The skill detects your project structure, build system, and existing auth system. It onboards you to CometChat directly in the terminal — signup, login, and app creation all via the CLI. It reads your Activities, Fragments, and navigation before proposing a placement, shows the plan (which files it will create, modify, and leave untouched), and waits for your approval before writing code. Credentials are saved to `local.properties` and accessed via `BuildConfig`.

Check warning on line 50 in ui-kit/android/v5/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/android/v5/overview.mdx#L50

Did you really mean 'onboards'?

Check warning on line 50 in ui-kit/android/v5/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/android/v5/overview.mdx#L50

Did you really mean 'signup'?

After the first integration, re-run `/cometchat` anytime to pick from the iteration menu:

- **Customize look & feel** — theme presets (slack / whatsapp / imessage / discord / notion) or your own brand color

Check warning on line 54 in ui-kit/android/v5/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/android/v5/overview.mdx#L54

Did you really mean 'whatsapp'?

Check warning on line 54 in ui-kit/android/v5/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/android/v5/overview.mdx#L54

Did you really mean 'imessage'?
- **Add a feature** — 40+ features including calls, reactions, polls, AI smart replies, file sharing, presence
- **Customize a component** — custom message bubbles, headers, composer actions, empty/loading states
- **Set up production auth** — replace the dev Auth Key with a server-side token endpoint
Expand Down
Loading
Loading