CometChat Docs

---

CometChat 官方 MCP 服务。连接 Claude、Cursor、Windsurf、VS Code Copilot、Codex 或任何其他兼容 Model Context Protocol 的 Agent，即可通过自然语言提示词将 CometChat 集成到你的应用中。

向 Agent 提问：“添加一个聊天标签页，让用户可以互相发送私信”——它会阅读 CometChat 文档，为你的技术栈选择合适的组件，并编写集成代码。

只读。无需账号、API 密钥或身份验证。

---

演示

AI Agent 阅读 CometChat 文档，并根据一条提示词编写可运行的聊天集成。

---

快速安装

Agent	添加方法
Claude.ai / Claude Desktop	设置 → 连接器 → 添加自定义连接器 → URL：https://mcp.cometchat.com/mcp
Cursor	Cmd+Shift+P → 打开 MCP 设置 → 添加自定义 MCP → 粘贴下方配置
Windsurf	插件（锤子图标） → 管理插件 → 查看原始配置 → 粘贴下方配置
VS Code (Copilot Agent)	Cmd+Shift+P → MCP: 添加 MCP 服务 → URL：https://mcp.cometchat.com/mcp，传输方式：HTTP
Claude Code (CLI)	claude mcp add --transport http cometchat https://mcp.cometchat.com/mcp
Smithery	npx -y smithery mcp add cometchat/docs-mcp
Codex CLI	codex plugin marketplace add cometchat/docs-mcp

配置片段（Cursor / Windsurf / 通用 MCP 客户端）

{
  "mcpServers": {
    "cometchat": {
      "url": "https://mcp.cometchat.com/mcp"
    }
  }
}

---

用法

连接后，可以向 Agent 提出以下任意问题：

• “如何在我的 Vite 项目中安装 React UI Kit？”
• “请介绍如何为工作区相互隔离的 Next.js SaaS 实现多租户聊天。”
• “演示如何在我的 iOS 会话列表中添加在线状态指示器和输入提示点。”
• “设置内容审核，在消息送达前拦截违禁词。”
• “为我的 Webflow 网站构建一个免代码聊天小组件。”
• “发送消息的速率限制是多少？触发限制时会收到什么错误代码？”

Agent 会阅读 CometChat 文档，提取相关实现指南，并将集成代码写入你的项目。

---

工具

• search_cometchat_docs — 按主题、API 名称或错误消息搜索 SDK、UI Kit、Calls、REST API、AI Agent、通知和审核文档。返回按相关性排序的片段，并优先显示当前版本。可选的 version 筛选条件和 limit（最多 25 条）。
• fetch_cometchat_doc_page — 按 URL 或路径以 Markdown 格式完整获取一个文档页面，并跟进已迁移的页面。超过 50 KiB 的页面会被截断，并附上完整页面的链接。
• get_cometchat_implementation_bundle — 返回指定场景的实现包：将该场景当前的文档页面（对于 UI Kit，先是其集成指南，再是平台的 AI 参考页面）汇编成一份文档，并附上相关页面路径。
• list_cometchat_bundles — 列出所有可用的实现包（标识符、标题、框架、页面列表的审核日期），供发现使用。

这四个工具都带有 readOnlyHint: true、title 注解，以及声明了结构化结果的 outputSchema。名称不超过 64 个字符。每项描述都说明工具的作用、适用场景和限制（错误、速率限制）；只有在其他工具能满足特定需求时，才会提及本服务的其他工具（“标识符来自 list_cometchat_bundles”）。它们不包含给 Agent 的指令、不引用其他服务或产品，也不使用营销语言。tests/tools.test.ts 会根据禁用措辞列表检查工具、参数和输出字段的描述以及 initialize 指令，并检查该列表仍能拒绝其针对的文本形式；它是禁用列表，并非证明。

资源

URI	用途
cometchat://skills/overview	Agent 入门技能 — 产品简介、决策指导、工作流、常见陷阱、验证清单
cometchat://bundles/react-uikit-quickstart	React UI Kit 安装 + 初始化 + 登录 + 聊天界面
cometchat://bundles/react-native-uikit-quickstart	带导航和聊天屏幕的 React Native UI Kit
cometchat://bundles/flutter-uikit-quickstart	Flutter UI Kit 安装 + 初始化 + 基本聊天
cometchat://bundles/ios-uikit-quickstart	iOS UI Kit 安装 + 聊天视图
cometchat://bundles/android-uikit-quickstart	Android UI Kit 安装 + 聊天屏幕
cometchat://bundles/angular-uikit-quickstart	Angular UI Kit 安装 + 初始化 + 登录 + 聊天界面
cometchat://bundles/js-sdk-messaging-basics	Vanilla JS SDK — 发送和接收文本及媒体消息
cometchat://bundles/widget-embed	适用于 HTML 的无代码小组件嵌入，并提供 WordPress、Webflow 和 Squarespace 的相关指引
cometchat://bundles/moderation-setup	审核入门，并提供规则、列表和已标记消息的相关指引
cometchat://bundles/multi-tenant-chat	多租户 — 在一个套餐下运行相互隔离的应用、App Management API
cometchat://bundles/presence-and-typing	在线状态、输入指示器、已读回执

---

工作原理

1. 你用自然语言向 Agent 提示需求。
2. Agent 阅读入门技能（cometchat://skills/overview），了解哪种工具或实现包适合你的请求。
3. 对于常见场景，Agent 会获取一个实现包 — 将该集成的当前文档页面汇编成一份文档。
4. 对于较少见的问题，Agent 会搜索 CometChat 文档并阅读具体的参考页面。
5. Agent 将代码写入你的项目，以实现包作为事实依据，并遵循你的项目结构。

---

30 秒了解 CometChat

CometChat 是一个实时通信平台，可为 Web 和移动应用添加聊天、语音和视频通话功能。已用于 SaaS、市场平台、游戏、医疗保健、教育和创作者平台等领域的生产环境。

• **免费套餐：**每月前 100 位活跃用户，无需信用卡。
• **SDK：**JavaScript、React Native、iOS、Android、Flutter。
• **UI 套件：**React、React Native、iOS、Android、Flutter、Angular、Vue。
• **无代码：**适用于任何 HTML 网站的聊天小组件。
• 注册：app.cometchat.com — 使用 Agent 编写的代码进行开发时，需要 App ID、Auth Key 和 Region。

---

服务身份

字段	值
显示名称	CometChat Docs
版本	0.1.7
协议	MCP 2025-06-18
传输方式	Streamable HTTP（含 SSE）
身份验证	无（仅限公开文档）
能力	tools、resources
健康检查端点	GET https://mcp.cometchat.com/health

---

架构

Your agent (Claude / Cursor / Windsurf / …)
        ↓ MCP over Streamable HTTP
        ↓
  mcp.cometchat.com/mcp  (this server)
        ↓
  ├── search_cometchat_docs     → SQLite FTS5 index of cometchat/docs
  ├── fetch_cometchat_doc_page  → cometchat.com/docs/*.md (first-party)
  └── get_cometchat_implementation_bundle → live docs pages listed in src/bundles/manifest.ts

• 无状态服务，单一通用端点，不保存特定用户的状态。
• 每次向该仓库的 main 分支推送时，都会根据 github.com/cometchat/docs 重建搜索索引。
• 实现包本身不包含任何内容。每个包都是一个文档页面列表（src/bundles/manifest.ts），收到请求时从实时文档中读取，因此修复文档无需更改 MCP 即可同步到对应的包。构建好的包会提供 10 分钟；之后，调用仍会立即获取该包，同时启动一次后台重建。遇到超时或 5xx 的重建不会替换缓存中的包，并会按退避策略重试（从 30 秒开始，每次加倍，最长 10 分钟），因此文档站点故障既不会导致包丢失，也不会给文档站点造成请求洪泛。页面已删除（404）时，会以文档站点的实际状态为准：连续两次构建结果一致后，保留该次重建并标明缺失页面。npm run verify:bundles 会在以下情况失败：列表中的页面已迁移、已消失、不再适合放入其包中、不再是 docs.json 中的当前版本，或要求用户安装未发布、属于较旧主版本，或精确锁定到落后一个次版本的包版本（通过 npm、pub.dev、CometChat 的 Maven 仓库、CocoaPods trunk 和 GitHub 检查）；维护者每天运行此命令。

---

本地开发

# Clone the docs repo (used to build the search index)
git clone --depth 1 https://github.com/cometchat/docs.git ../cometchat-docs-repo

# Install + build the FTS index + run the server
npm install
DOCS_REPO=../cometchat-docs-repo npm run build:index
npm run dev

# Run the test suite (vitest: validation, truncation, bundles, tools, resources, fetch,
#  search ranking and the index builder)
npm test

# Score search ranking on the index you built (CI pins the docs commit: see DEPLOY.md)
DOCS_REPO=../cometchat-docs-repo npm run eval:search

# Check every docs page a bundle lists still exists and is current (network)
npm run verify:bundles

服务默认监听 http://0.0.0.0:3000。健康检查地址为 GET /health，MCP 端点为 POST /mcp。

使用 MCP Inspector 检查

npx @modelcontextprotocol/inspector
# add server: http://localhost:3000/mcp

你应该能看到全部 4 个工具，它们的 readOnlyHint: true，以及全部 11 个资源。

仓库布局

docs-mcp/
├── src/
│   ├── server.ts                  # MCP server entry, transport, tool dispatch
│   ├── tools/{search,fetch,bundle}.ts
│   ├── search/sqlite.ts           # SQLite FTS5 client
│   ├── bundles/manifest.ts        # each bundle's docs pages
│   ├── bundles/loader.ts          # compiles bundles from live docs pages
│   ├── resources/registry.ts      # skill + bundle resources
│   └── lib/{errors,truncate,validation,logger}.ts
├── scripts/build-index.ts         # builds SQLite FTS5 index from cometchat/docs
├── skills/overview.md             # agent orientation skill
├── tests/                         # vitest suite
├── .claude-plugin/
│   ├── plugin.json                # Claude Code plugin manifest
│   └── marketplace.json           # Claude Code marketplace manifest
├── .codex-plugin/plugin.json      # Codex plugin manifest
├── .cursor-plugin/plugin.json     # Cursor Marketplace manifest
├── .mcp.json                      # MCP config (Claude Code auto-discovery)
├── mcp.json                       # Open Plugins standard manifest
└── assets/logo.svg                # CometChat logo

---

配置

环境变量	默认值	说明
PORT	3000	HTTP 端口
HOST	0.0.0.0	绑定的主机
DOCS_BASE_URL	https://www.cometchat.com/docs	用于响应中的 URL，以及 .md 获取回退机制
INDEX_PATH	./data/index.sqlite	SQLite FTS5 索引位置。即使索引缺失，服务仍会启动；搜索会返回 backend_unavailable，且 /health 返回 503。
SKILLS_DIR	./skills	方向指引技能（overview.md）目录
FETCH_TIMEOUT_MS	5000	每次 HTTP 获取的超时时间
LOG_LEVEL	info	debug / info / warn / error
NODE_ENV	development	Node.js 标准设置（Express 以生产模式运行）；在容器中设为 production
ALLOWED_HOSTS	<HOST>:<PORT>,localhost:<PORT>,127.0.0.1:<PORT>	以逗号分隔的 Host 请求头允许列表，用于防止 DNS 重绑定
ALLOWED_ORIGINS	未设置	以逗号分隔的 /mcp 浏览器 Origin 允许列表。未设置表示不允许任何来源：带有 Origin 的请求会收到 403。不发送 Origin 的客户端（IDE、CLI、托管连接器）不受影响
DNS_REBINDING_PROTECTION	true	仅当上游已验证 Host 时才设为 false
RATE_LIMIT_ENABLED	true	设为 false 可禁用 /mcp 上按 IP 限制速率的功能。只能是 true 或 false；其他值会导致启动失败
RATE_LIMIT_MAX	120	每个 IP 在每个时间窗口内的最大请求数。必须为正整数；0 会导致启动失败（请通过 RATE_LIMIT_ENABLED=false 禁用）
RATE_LIMIT_WINDOW_MS	60000	限速时间窗口，单位为毫秒。必须为正整数
INDEX_AUTO_REFRESH	false	设为 true 可在容器内 cometchat/docs 发生变化时重建搜索索引。需要镜像中包含 git，且 INDEX_WORK_DIR 可写。
INDEX_POLL_INTERVAL_MS	600000	检查文档仓库是否有新提交的频率（执行一次 git ls-remote，约需 1 秒）
INDEX_WORK_DIR	./data/generations	重建后的索引版本的写入位置（生产环境中使用 tmpfs）
INDEX_KEEP_GENERATIONS	2	在磁盘上保留的旧索引版本数量，以便即时回退
INDEX_MIN_PAGES	2000	绝对下限：页数少于此值的候选索引会被拒绝
INDEX_MAX_DROP_RATIO	0.2	相对下限：如果候选索引的页面数量相比当前提供的页面数量，或版本来自 docs.json 导航的当前提供页面数量，减少比例超过此值，则拒绝该候选索引
DOCS_REPO_URL	https://github.com/cometchat/docs.git	公开文档仓库；匿名克隆，无需凭据
DOCS_REF	main	要跟踪的分支
DOCS_COMMIT_PIN	未设置	固定到某个提交并停止跟踪 HEAD（事故应急选项）
POSTHOG_KEY	未设置	PostHog 项目 API 密钥。未设置 = 完全禁用使用情况分析（无操作）
POSTHOG_HOST	https://us.i.posthog.com	PostHog 实例主机
ANALYTICS_SALT	未设置	设置 POSTHOG_KEY 时必需（未设置时分析功能保持关闭）。对客户端指纹和 IP 哈希进行加盐；轮换此值会重置所有指纹

---

部署

容器构建、环境和平台说明请参阅 DEPLOY.md。

---

市场平台

同一服务 URL 已发布在多个 Agent 市场平台：

市场平台	列表
Smithery	smithery.ai/servers/cometchat/docs-mcp
Glama	glama.ai/mcp/servers/cometchat/docs-mcp
Cursor Marketplace	cursor.com/marketplace
Cursor Directory	cursor.directory
Anthropic Connector Directory	claude.com/connectors
Codex Marketplace	codex-marketplace.com

---

支持

• 问题 / 反馈： 在此仓库中提交 issue。
• CometChat 支持： [email protected]。
• MCP 实时状态： 健康时，curl https://mcp.cometchat.com/health 会返回 {"status":"ok"}。

---

贡献

欢迎提交 PR，尤其是：

• 新的实现方案包：在 src/bundles/manifest.ts 中添加条目，列出已有的文档页面。如果没有页面涵盖相关场景，请先在 cometchat/docs 中编写页面；方案包内容始终来自文档。
• 改进工具，但须遵守现有的只读约定。

目前不在范围内：

• 会写入客户 CometChat 应用的工具（独立的认证连接器，已列入路线图）。
• 混合读写工具（Anthropic 的自动拒绝规则）。

---

隐私

CometChat MCP 服务为只读，无需账户、API 密钥或身份验证。它仅提供 CometChat 的公开文档，不会请求、存储或传输你的代码、提示词或个人数据。标准请求元数据（例如 IP 地址）可能会被临时处理，用于速率限制和防止滥用。

完整详情请参阅 CometChat 的隐私政策：cometchat.com/legal-privacy-policy。

---

许可证

Apache-2.0。请参阅 LICENSE。