Repository navigation
docs(ai): refresh MCP Integration page for docs-mcp v0.1.6 and add AI-agent + Docs MCP sections to every UI Kit #530
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
ketanyekale
wants to merge
4
commits into
main
Choose a base branch
from
docs/mcp-server-page
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+526
−395
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
04aa7cf
docs(mcp-server): update MCP page for docs-mcp v0.1.6
ketanyekale c6d3a00
docs(ui-kit): add AI agent + Docs MCP sections to all platform overviews
ketanyekale 2669502
docs(ai): unify agent guidance across UI Kits, retire orphaned Kotlin…
ketanyekale 6a9ad53
docs(sdk/android): fix malformed url frontmatter on the Kotlin UI Kit…
ketanyekale File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -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. | ||
|
|
@@ -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 | ||
| offer the older SSE-only transport, so if your client asks for a transport | ||
| type, choose **HTTP** (Streamable HTTP). | ||
|
|
||
| ## 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 | ||
| 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). | ||
|
|
||
| 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 | ||
|
|
||
|
|
@@ -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."* | ||
| - *"Add presence indicators and typing dots to my conversation list."* | ||
|
|
||
| The agent will search the docs, pull the matching implementation bundle, | ||
|
|
@@ -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 | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
|
|
||
| | Bundle | What it covers | | ||
|
|
@@ -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 | ||
|
|
@@ -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) | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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." | ||
| --- |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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 addonly 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 ascometchat-docs(unless you passed--no-mcp)."