docs-mcp

center"> # CometChat MCP 服务器 **通过 AI 编为您的应用添加实时聊天、语音、视频和审核功能。** [](https://smithery.ai/server/@cometchat/docs-mcp) [](www.claudepluginhub.com/plugins/cometchat-cometchat?ref=badge) [](LICENSE) [](https://modelcontextprotocol[](https://mcp.cometchat.com/health) [**文档**](https://www.cometchat.com/docs/mcp-server) • [**CometChat**](https://etchat.com) • [**获取账户（免费 MAU）**](https.cometchat.com) </div> --- CometChat 的一级 MCP 服务器。连接 Claude、Cursor、Windsurf、VS Code Copilot、Codex 或任何其他与 Model Context Protocol 兼容的代理，并将 CometChat 集成到您的应用中，通过自然语言提示。 询问代理： *"添加一个聊天选项卡，用户可以在其中相互发送消息"* — 它会读取 CometChat 的文档，选择适合您技术的正确组件，并编写集成代码。 **只读。无需账户，无需 API 密钥，无需身份验证。** --- ## 快速安装 | 代理 | 添加方法 | || **Claude.ai / Claude Desktop** | 设置 → 连接器 → 添加自定义连接器 → URL： `https://metchat.com/mcp` | | **Cursor** |+Shift+P` → 打开 MCP 设置 → 添加自定义 MCP → 粘贴以下配置 | |indsurf** | 插件（锤子图标）→ 管理插件 → 查看原始配置 → 粘贴以下配置 | | **VS Code (Copilot Agent)** | `Cmd+Shift+P` → MCP：添加 MCP 服务器 → URL： `https://mcp.cometchat.com/mcp`，传输：SSE | | **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 客户端） ```json { "mcpServers": { "cometchat": { "url": "https://mcp.cometchat.com/mcp" } } } ``` --- ## 用法 连接后，使用以下任意一个提示您的代理： - *"如何在我的 Vite 项目中安装 React UI Kit - *"为 Next.js SaaS 讲解多租，其中工作区是隔离的。* - *"如何在我的 iOS 会话列表中添加在线状态指示器和打字点。* - *"设置内容审核，以便在传递前阻止违规词。* - *"为我的 Webflow 站点构建无代码聊天小部件。* - *"发送消息的速率限制是多少，当我达到限制时会收到什么错误代码？* 代理会读取 CometChat 的文档，提取相关的实现包，并将集成代码写入您的项目。 --- ## 工具 | 名称 | 用途 | |---|---| | `search_cometchat_docs` | 在 SDK 指南、UI Kit 参考、REST API 文档和 OpenAPI 规范中搜索。返回带有标题和直接链接的排名片段。可选的 `version` 过滤器。 | | `fetch_cometchat_doc_page` | 通过 URL 或相对路径获取任何文档页面的完整内容作为 markdown。 | | `get_cometchat_implementation_bundle` | 为命名场景返回精选的实现包 — 先决条件、安装命令、配置、有效代码。 | 所有三个工具都带有 `readOnlyHint: true` 和 `title` 注解。名称长度 ≤ 64 个字符。描述仅描述合约 — 不向代理提供行为指令、不进行跨工具路由、不包含营销语言。 ## 资源 | URI | 用途 | |---|---| | `cometchat://skills/overview` | 代理定位技能 — 产品摘要、决策指导、工作流程、常见问题、验证检查清单 | | `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-ustart` | iOS UI Kit (SwiftUI) 安装 + 聊天视图 | | `cometchat://bundles/android-uikit-quickstart` | Android UI Kit (Jetpack Compose) 聊天屏幕 | | `cometchat://bundles-messaging-basics` | Vanilla JS SDK — 发送文本和媒体消息 | | `cometchat://bundles/widget-embed` | HTML、Squarespace、Webflow、Wix、WordPress、Shopify 的无代码小部件嵌入 | | `cometchat://bundles/moderation-setup` | AI 审核规则、图像审核、Webhook | | `cometchat://bundles/multi-tenant-chat` | 多租户 SaaS 聊天 — 租户隔离、服务器颁发的 Auth Tokens | | `cometchat://bundles/presence-and-typing` | 在线状态、打字指示器、已读回执 | --- ## 工作原理 1. **您用自然语言提示您的代理**。 2. **代理读取定位技能** (`cometchat://skills/overview`) 以了解哪个工具/包适合您的请求。 3. **对于热门场景**，代理会提取一个精选的实现包 — 具有先决条件、安装命令、配置和工作示例的即用代码。 4. **对于长尾问题**，代理会搜索 CometChat 的文档并读取特定的参考页面。 5. **代理将代码写入您的项目**，使用包作为真实来源和您的项目结构作为约束。 --- ## 30 秒了解 CometChat CometChat 是一个实时通信平台，用于为 Web 和移动应用添加聊天、语音和视频通话。已在 SaaS、市场、医疗保健、教育和创作者平台的生产环境- **免费层 前 100 名月活跃用户，无需信用卡。 SDK：** JavaScript、React Native、iOS、Android、Flutter。 - **UI Kits：** React、React Native、iOS、Android、Flutter、Angular、Vue。 - **无代码：** 适用于任何 HTML 站点的聊天小部件。 - **注册：** [`app.cometchat.com`](https://app.cometchat.com) — 您需要一个 App ID、Auth Key 和 Region 来使用代理编写的代码进行构建。 --- ## 服务器身份 | 字段 | 值 | |---|---| | 显示名称 | CometChat 文档 | | 版本 | 0.1.3 | | 协议 | MCP `2025-06-18` | | 传输 | 可流式 HTTP（带有 SSE） | | 身份验证 | 无（仅限公共文档） | | 功能 | `tools`、`resources` | | 健康检查端点 | `GET https://mcp.cometchat.com/health` | --- ## 架构 ``` 您的代理（Claude / Cursor / Windsurf / …） ↓ 通过 Streamable HTTP 的 MCP ↓ mcp.cometchat.com/mcp （此服务器） ↓ ├── search_cometchat_docs → cometchat/docs 的 SQLite FTS5 索引 ├── fetch_cometchat_doc_page → cometchat.com/docs/*.md（第一方） └── get_cometchat_implementation_bundle → 的 markdown 配方 ``` - 无状态服务器，单个通用端点，无用户特定状态。 - 搜索索引从 `github.com/cometchat/docs` 的 `main` 分支的每次推送中重建。 - 实现包带有 `last_verified` 日期，每季度会根据实时 SDK 版本重新检查。 --- ## 本地开发 ```bash # 克隆文档仓库（用于构建搜索索引） git clone --depth 1 https://github.com/cometchat/docs.git ../cometchat-docs-repo # 安装 + 构建 FTS 索引 + 运行服务器 npm install DOCS_REPO=../cometchat-docs-repo npm run build:index npm run dev # 运行测试套件（跨验证、截断、包、工具、资源、获取的 36 个测试） npm test ``` 服务器默认监听 `http://0.0.0.0:3000`。健康检查探针位于 `GET /health`，MCP 端点位于 `POST /mcp`。 ### 使用 MCP Inspector 进行检查 ```bash npx @modelcontextprotocol/inspector # 添加服务器：http://localhost:3000/mcp ``` 您应该会看到所有 3 个工具，带有 `readOnlyHint: true` 和所有 11 个资源。 ### 仓库布局 ``` docs-mcp/ ├── src/ │ server.ts # MCP 服务器入口、传输、工具│ ├── tools/{search,fetch,bundle}.ts │ ├── search/sqlite.ts #TS5 客户端 │ ├── bundles/loader.ts # markdown 包存储 │ ├── resources/registry.ts # 技能 + 包资源 │ └── lib/{errors,truncate,validation,logger}.ts ├── scripts/build-index.ts # 从 cometchat/docs 构建 SQLite FTS索引 / # 10 个精选的实现包 ├── skills/overview.md # 代理定位技能 ├── tests/ # vitest 套件 ├── .claude-plugin/ │ ├── plugin.json # Claude Code 插件清单 │ └── marketplace.json # Claude Code 市场清单 ├── .codex-plugin/plugin.json # Codex 插件清单 ├── .cursor-plugin/plugin.json # Cursor Marketplace 清单 ├── .mcp.json # MCP 配置（Claude Code 自动发现） ├── mcp.json # Open Plugins 标准清单 └── assets/logo.svg # CometChat 标志 ``` --- ## 配置 | 环境变量 | 默认值 | 备注 | |---|---|---| | `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`。 | | `BUNDLES_DIR` | `./bundles` | Markdown 包目录 | | `SK` | `./skills 定位技能（`overview.md`）目录 | | `FETCH_TIMEOUT_MS `5000` | 每个获取的 HTTP 超| `LOG_LEVEL `info` |` / `info` / `warn` / `error` | | `NODE_ENV` | `development`production` 使包加载 格式错误的包在启动时中止，而不是被跳过 | | `ALLOWED | `<HOST>:>,localhost:<PORT>,127.0.0:<PORT>` | 用于 DNS 绑定保护的分隔 `Host` 头部允许列表 | | `ALLOWED_ORIGINS` | _unset_ | 逗号分隔的 CORS 源允许列表 | | `DNS_REBINDING_PROTECTION` |` | 仅当上游已经验证 `Host` 时，设置为 `false` | | `RATE_LIMIT_ENABLED` | `true` | 在 `/mcp` 上禁用每个 IP 的速率限制，设置为 `false` | | `RATE_LIMIT_MAX` | `120` | 每个窗口每个 IP 的最大请求数 | | `RATE_LIMIT_WINDOW_MS` | `60000` | 毫秒为单位的速率限制窗口 | --- ## 部署 参见 [`DEPLOY.md`](./DEPLOY.md) 获取容器构建、环境和平台说明。 --- ## 市场 同一个服务器 URL 被列在多个代理市场中： | 市场 | 列表 | |---|---| | Smithery | [`smithery.ai/server/@cometchat/docs-mcp`](https://smithery.ai/server/@cometchat/docs-mcp) | | `cursor.complace` | | Cursor 目录 | `cursor.directory` | | Anthropic 连接器目录 | `claude.com/connectors` | | Code | `codex-marketplace.com` | --- ## 支持 - **问题/反馈：** 在此打开问题。 -etChat 支持：**@cometchat.com`](mailto:supportat.com)。 MCP 状态：** `curl https://metchat.com/health健康时返回 `":"ok"}`## 贡献 — 尤其是： - **新的实现包适用于服务不足的场景（在 `bundles/` 中添加带有必要前置 文件）。 - ****，当 SDK 版本更改时（包中的 `last_verified` 日期在 个月后触发告）。 - ****，在现有的只读合约下。 超出范围： - 编写客户 CometChat 应用的工具（单独的身份验证连接器，正在规划中 混合读写工具（Anthropic 自动拒绝规则--- ## 隐私 CometChat MCP 服务器是**只读**需账户、API 身份验证。它仅提供 CometChat 的公共请求、存储或传输您的代码、提示或。标准请求元数据（例如 IP 地址）可能会以进行速率限制和滥用预防详细信息，请参阅 CometChat 的隐私政策：[`cometchat.com/legal-privacy-policy`](https://www.cometchat.com/legal-privacy-policy)。 --- ## 许可证 Apache-2.0。参见 [LICENSE](LICENSE)。