Skip to content

Commit 8a6f4bb

Browse files
author
Kiro Agent
committed
Update mcp-server.mdx
1 parent 6ca67ed commit 8a6f4bb

1 file changed

Lines changed: 130 additions & 78 deletions

File tree

‎mcp-server.mdx‎

Lines changed: 130 additions & 78 deletions
Original file line numberDiff line numberDiff line change
@@ -1,89 +1,141 @@
11
---
2-
title: "MCP Server"
3-
description: "Connect AI tools like Claude and Cursor to CometChat documentation with the MCP server to improve integration speed and developer productivity."
4-
canonical: "https://www.cometchat.com/docs/mcp"
2+
title: "Use CometChat with AI Coding Agents (MCP)"
3+
sidebarTitle: "MCP Integration"
4+
description: "Connect CometChat to Claude, Cursor, Windsurf, VS Code, and any other Model Context Protocol–compatible agent. Search docs, fetch reference pages, and pull implementation bundles from inside the conversation."
5+
canonical: "https://www.cometchat.com/docs/mcp-server"
56
---
67

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

9-
### Claude
14+
The server is **read-only** and **needs no account or API key** — it surfaces
15+
CometChat's public documentation and curated implementation recipes.
1016

11-
1. **Add MCP server to Claude**
12-
1. Navigate to the [Connectors](https://claude.ai) page in Claude’s settings.
13-
2. Select **Add custom connector**, name it e.g. `CometChat Docs`, and enter the URL:
14-
```
15-
https://www.cometchat.com/docs/mcp
16-
```
17-
3. Click **Add**.
18-
2. **Query with context**
19-
1. In Claude, click the attachments (➕) button.
20-
2. Select **CometChat Docs**.
21-
3. Ask your questions—Claude will use your CometChat docs as context.
17+
## Connector URL
18+
19+
```
20+
https://mcp.cometchat.com/mcp
21+
```
22+
23+
Transport: HTTP with Server-Sent Events. No authentication required.
24+
25+
## Connect from your agent
26+
27+
### Claude (Desktop or claude.ai)
28+
29+
1. Open **Settings → Connectors**.
30+
2. Click **Add custom connector**.
31+
3. Name it `CometChat`, paste the URL `https://mcp.cometchat.com/mcp`, and click **Add**.
32+
4. In a new conversation, attach **CometChat** from the connectors picker and prompt away.
2233

2334
### Cursor
2435

25-
1. **Open MCP settings**
26-
- Press `Cmd+Shift+P` (macOS) / `Ctrl+Shift+P` (Windows) → **Open MCP settings**.
27-
- Select **Add custom MCP** to open your `mcp.json`.
28-
2. **Configure**
29-
```json
30-
{
31-
"mcpServers": {
32-
"cometchat-docs": {
33-
"url": "https://www.cometchat.com/docs/mcp"
34-
}
35-
}
36-
}
37-
```
38-
3. **Verify**
39-
- In Cursor’s chat, ask:
40-
> “How do I integrate CometChat in my React app?”
41-
42-
{/* ### Lovable.dev
43-
44-
1. **Open your Lovable project**
45-
- Log in at [Lovable.dev](https://lovable.dev) and select your project.
46-
2. **Add a custom MCP server**
47-
- Go to **Settings** → **Developer Tools** → **MCP Servers**.
48-
- Click **Add custom server**, then:
49-
- **Name:** `CometChat Docs`
50-
- **URL:** `https://www.cometchat.com/docs/mcp`
51-
- Click **Save**.
52-
3. **Use the tools**
53-
- Invoke the CometChat tools in your conversations with Lovable’s AI assistant. */}
36+
1. `Cmd+Shift+P` (macOS) / `Ctrl+Shift+P` (Windows) → **Open MCP settings**.
37+
2. Click **Add custom MCP** and paste:
38+
39+
```json
40+
{
41+
"mcpServers": {
42+
"cometchat": {
43+
"url": "https://mcp.cometchat.com/mcp"
44+
}
45+
}
46+
}
47+
```
5448

5549
### Windsurf
5650

57-
1. **Open Windsurf**
58-
- Launch Windsurf and click the **Plugins** (hammer) icon.
59-
2. **Add or configure**
60-
- In **Manage plugins**, click **Add Custom Server +** or **View raw config**.
61-
- Paste the following into your `mcp_config.json`:
62-
```json
63-
{
64-
"mcpServers": {
65-
"cometchat-docs": {
66-
"type": "sse",
67-
"serverUrl": "https://www.cometchat.com/docs/mcp"
68-
}
69-
}
70-
}
71-
```
72-
- Save and click **Refresh**.
73-
3. **Invoke within Windsurf**
74-
- In the Composer, ask prompts like:
75-
> “Show me how to use CometChat in my app.”
76-
77-
### Visual Studio Code
78-
79-
1. **Prerequisites**
80-
- Latest VS Code with Copilot (agent mode) enabled.
81-
2. **Add the server**
82-
- `Cmd+Shift+P` (macOS) / `Ctrl+Shift+P` (Windows) → **MCP: Add MCP Server**.
83-
- Enter:
84-
- **Server Name:** `CometChat Docs`
85-
- **Server URL:** `https://www.cometchat.com/docs/mcp`
86-
- **Transport:** `SSE` (or HTTP stream)
87-
- Confirm.
88-
3. **Use in Copilot agent**
89-
- In a Copilot chat session, your CometChat tools will now be listed and available.
51+
1. Click the **Plugins** (hammer) icon → **Manage plugins** → **View raw config**.
52+
2. Paste:
53+
54+
```json
55+
{
56+
"mcpServers": {
57+
"cometchat": {
58+
"type": "sse",
59+
"serverUrl": "https://mcp.cometchat.com/mcp"
60+
}
61+
}
62+
}
63+
```
64+
65+
3. Save and click **Refresh**.
66+
67+
### Visual Studio Code (Copilot Agent)
68+
69+
1. `Cmd+Shift+P` / `Ctrl+Shift+P` → **MCP: Add MCP Server**.
70+
2. Enter:
71+
- **Server Name:** `CometChat`
72+
- **Server URL:** `https://mcp.cometchat.com/mcp`
73+
- **Transport:** SSE
74+
3. Confirm.
75+
76+
## Example prompts
77+
78+
Once connected, try these in a fresh agent conversation:
79+
80+
- *"Add a chat tab where users can DM each other in my React app."*
81+
- *"Let project members talk in a group chat with file sharing."*
82+
- *"Add video calling between two users with a click-to-call button."*
83+
- *"Set up content moderation so banned words are blocked before delivery."*
84+
- *"Build a multi-tenant SaaS chat where each workspace's users are isolated."*
85+
- *"Add presence indicators and typing dots to my conversation list."*
86+
87+
The agent will search the docs, pull the matching implementation bundle,
88+
and write the code into your project.
89+
90+
## What the connector exposes
91+
92+
### Three tools (all read-only)
93+
94+
<CardGroup cols={3}>
95+
<Card title="search_cometchat_docs" icon="magnifying-glass">
96+
Search SDK guides, UI Kit references, REST API docs, and OpenAPI
97+
specs. Returns ranked snippets with direct links.
98+
</Card>
99+
<Card title="fetch_cometchat_doc_page" icon="file-lines">
100+
Fetch the full content of any documentation page as markdown by URL
101+
or relative path.
102+
</Card>
103+
<Card title="get_cometchat_implementation_bundle" icon="box-open">
104+
Return a curated implementation recipe — prerequisites, install,
105+
configuration, working code — for a named scenario.
106+
</Card>
107+
</CardGroup>
108+
109+
### Ten curated implementation bundles
110+
111+
| Bundle | What it covers |
112+
| --- | --- |
113+
| `react-uikit-quickstart` | React UI Kit install, init, login, conversations list, chat window |
114+
| `react-native-uikit-quickstart` | React Native UI Kit install, navigation, basic chat screen |
115+
| `flutter-uikit-quickstart` | Flutter UI Kit install, init, login, basic chat |
116+
| `ios-uikit-quickstart` | iOS UI Kit (SwiftUI) install, init, login, chat view |
117+
| `android-uikit-quickstart` | Android UI Kit (Compose) install, init, login, chat screen |
118+
| `js-sdk-messaging-basics` | Vanilla JS SDK install, send/receive text and media messages |
119+
| `widget-embed` | No-code widget embed for an existing site |
120+
| `moderation-setup` | AI moderation, profanity filter, image moderation, webhooks |
121+
| `multi-tenant-chat` | Multi-tenant SaaS chat — auth, isolation, tenant-scoped users |
122+
| `presence-and-typing` | Online presence, typing indicators, read receipts |
123+
124+
### Orientation skill resource
125+
126+
The MCP also exposes a `cometchat://skills/overview` resource — a structured
127+
markdown document the agent reads once to orient itself on CometChat's
128+
products, decision tree, and common pitfalls.
129+
130+
## Source
131+
132+
The MCP server is open-source at
133+
[`github.com/cometchat/cometchat-mcp`](https://github.com/cometchat/docs-mcp).
134+
Built from this very documentation repository, so the content it surfaces
135+
is always in sync with what you see on the docs site.
136+
137+
## Support
138+
139+
Questions, feedback, or feature requests: open an issue on the
140+
[GitHub repository](https://github.com/cometchat/docs-mcp/issues)
141+
or contact the team at <support@cometchat.com>.

0 commit comments

Comments
 (0)