即时通信智能客服文档知识库服务

腾讯云即时通信IM智能客服文档知识库MCP服务,通过MCP协议提供文档搜索、智能问答和知识库管理功能,适用于AI助手查询腾讯云IM/Desk产品文档。

  • by Ethanwithtech
  • TypeScript
  • 混合部署
  • 更新于
在 GitHub 查看 Ethanwithtech/im-desk-mcp

使用说明

IM Desk MCP Server

腾讯云即时通信 IM 智能客服 (Desk) 文档知识库 MCP 服务。

让 OpenClaw、Claude Desktop、CodeBuddy、Cursor 等 AI 助手通过 MCP 协议 直接查询腾讯云 IM/Desk 产品文档,智能回答相关问题并协助开发。

MCP Tools

Tool 说明
search_im_docs 语义搜索知识库,查找功能、API、配置说明
ask_im_question RAG 智能问答,检索文档后生成回答
crawl_im_page 实时爬取腾讯云 IM 文档页面
manage_knowledge_base 知识库管理(导入/统计/清空)

快速接入

方式 1:连接公共服务(零部署,推荐)

直接连接已部署的服务,无需部署任何东西。

CodeBuddy(腾讯云代码助手):

在 CodeBuddy 的 MCP 配置中添加:

{
  "im-desk-mcp": {
    "type": "sse",
    "url": "http://122.51.140.224:3000/sse",
    "description": "腾讯云 IM 智能客服 Desk 文档知识库"
  }
}

Claude Desktop / Cursor:

{
  "mcpServers": {
    "im-desk-mcp": {
      "transport": "sse",
      "url": "http://122.51.140.224:3000/sse"
    }
  }
}

配置后即可在对话中使用文档搜索和智能问答功能。

方式 2:OpenClaw Skill(不支持 MCP 的客户端)

OpenClaw 用户可以通过安装 Skill 的方式使用:

# 方法 A:从 ClawHub 安装(推荐)
clawhub install im-desk-mcp

# 方法 B:手动安装
git clone https://github.com/Ethanwithtech/im-desk-mcp.git
cp -r im-desk-mcp/openclaw-skill ~/.openclaw/skills/im-desk-mcp-skill

安装后直接对 OpenClaw 说"搜索 IM 文档:会话转接怎么配置"即可使用。

方式 3:本地 stdio 运行

git clone https://github.com/Ethanwithtech/im-desk-mcp.git
cd im-desk-mcp
npm install && npm run build

# 配置
cp .env.example .env
# 编辑 .env 填入 SiliconFlow API key(免费注册:https://cloud.siliconflow.cn)

# 启动 ChromaDB
docker run -d --name chroma -p 8000:8000 -v chroma_data:/chroma/chroma -e IS_PERSISTENT=TRUE chromadb/chroma:latest

# 导入知识库
npm run ingest -- --web

然后在 MCP 客户端配置:

{
  "mcpServers": {
    "im-desk-mcp": {
      "command": "node",
      "args": ["你的路径/im-desk-mcp/dist/index.js"]
    }
  }
}

方式 4:Docker Compose 一键部署

git clone https://github.com/Ethanwithtech/im-desk-mcp.git
cd im-desk-mcp
cp .env.example .env
# 编辑 .env 填入 SiliconFlow API key

docker compose up -d

服务启动后:

  • 健康检查:http://localhost:3000/health
  • SSE 端点:http://localhost:3000/sse

两种运行模式

stdio 模式 HTTP/SSE 模式
启动 node dist/index.js node dist/server-http.js
谁能用 本机的 MCP 客户端 任何有网络的 MCP 客户端
适合 个人使用 分享给团队/公开服务

环境要求

  • Node.js >= 18
  • Docker(运行 ChromaDB)
  • SiliconFlow API Key(免费注册,Embedding 永久免费)

环境变量

变量 必须 说明 默认值
CHROMA_URL 是 ChromaDB 地址 http://localhost:8000
EMBEDDING_PROVIDER 是 openai openai
EMBEDDING_BASE_URL 是 Embedding API 地址 SiliconFlow
EMBEDDING_API_KEY 是 Embedding API 密钥 -
EMBEDDING_MODEL 是 Embedding 模型 BAAI/bge-m3
MCP_PORT HTTP 模式 HTTP 服务端口 3000
MCP_API_KEY 可选 HTTP 鉴权 token 不鉴权
LLM_BASE_URL 可选 LLM API 地址 -
LLM_API_KEY 可选 LLM API 密钥 -
LLM_MODEL 可选 LLM 模型 -

导入知识库

# 导入 docx 文档
npm run ingest -- --docx ./data/docs/你的文档.docx

# 爬取腾讯云 IM 官网文档(预定义 16 个核心页面)
npm run ingest -- --web

# 导入预处理好的 JSON(大文档用 Python 脚本解析后导入)
npx tsx src/scripts/import-json.ts ./chunks.json

# 大文档本地预处理(95MB+ docx)
python3 scripts/parse-big-docx.py 你的大文档.docx ./output.json

知识库内容

当前知识库包含 892 个文档块:

来源 块数 内容
Desk 完整产品文档 (95MB) 328 API、SDK、功能说明、错误码等
会话转接文档 ~100 会话转接配置和使用
腾讯云官网 16 个页面 464 开发指引、接入文档、REST API

项目结构

im-desk-mcp/
├── src/
│   ├── index.ts              # MCP Server 入口 (stdio)
│   ├── server-http.ts        # MCP Server 入口 (HTTP/SSE)
│   ├── tools/                # MCP Tools 实现
│   ├── utils/                # 工具函数
│   └── scripts/              # 导入/解析脚本
├── openclaw-skill/           # OpenClaw Skill(不支持 MCP 的客户端用)
│   ├── SKILL.md
│   └── scripts/
├── scripts/
│   ├── deploy-lighthouse.sh  # 服务器部署脚本
│   ├── parse-big-docx.py     # 大文档 Python 解析
│   └── im-desk-mcp.service   # systemd 服务文件
├── docker-compose.yml        # Docker 一键部署
├── Dockerfile
└── .env.example

License

MIT