logo
0
1
WeChat Login
chore: initial commit

腾讯云日志服务 (CLS) MCP Server

npm version license

English | 中文

腾讯云日志服务(CLS)MCP Server,基于 Model Context Protocol 实现,让大语言模型能够直接访问腾讯云 CLS 的日志检索、指标查询、告警管理等能力,无需编写代码即可完成日志分析。

📖 腾讯云官方文档 | 🚀 SSE 托管服务 - MCP 市场(免费使用)

核心能力

日志检索

工具名称描述
SearchLog根据查询条件搜索日志(CQL 语法)
DescribeLogContext获取指定日志的上下文(前后 N 条日志)
TextToSearchLogQuery将自然语言描述转换为 CLS 查询语句(CQL 专家)
DescribeLogHistogram获取指定时间范围内的日志分布直方图数据
DescribeIndex获取日志主题的索引配置信息(字段索引、全文索引等)

指标查询

工具名称描述
QueryMetric查询指标主题的实时值(PromQL 语法)
QueryRangeMetric查询指标主题在时间范围内的数据趋势

告警管理

工具名称描述
DescribeAlarms获取告警策略列表,支持按条件过滤
DescribeAlertRecordHistory查询告警触发/恢复历史记录
GetAlarmLog查询告警执行详情日志
DescribeAlarmNotices获取通知渠道组列表(邮件、短信、企业微信等)
DescribeAlarmShields获取指定通知渠道组的告警屏蔽规则列表
DescribeNoticeContents获取通知内容模板列表
DescribeWebCallbacks获取告警 Webhook 回调配置列表
GetAlarmDetail通过告警通知 URL 获取告警详细信息(支持短链接/长链接)

辅助工具

工具名称描述
GetTopicInfoByName按名称搜索日志主题或指标主题
GetRegionCodeByName按地区名称获取腾讯云区域代码
ConvertTimeStringToTimestamp时间字符串转换为时间戳
ConvertTimestampToTimeString时间戳转换为时间字符串

使用场景

  • 自然语言日志查询 — 使用自然语言查询日志,无需掌握复杂的查询语法,大幅降低日志分析门槛。
  • 智能运维排障 — 整合至运维排障流程中,智能分析系统异常,快速定位问题根因。
  • 自动生成查询语句 — 通过 TextToSearchLogQuery 将自然语言自动转换为 CLS 查询语句,实现更精准高效的日志检索。
  • 业务指标监控 — 查询并监控指标主题的实时值与历史趋势,及时掌握系统运行状态。
  • 告警管理与分析 — 查看告警策略、查询告警触发/恢复历史记录、分析告警执行详情,快速了解告警状态。

配置参数说明

参数必填默认值说明
TRANSPORTstdioMCP 传输方式,可选 stdiosse
TENCENTCLOUD_SECRET_ID-腾讯云 API 密钥 SecretId
TENCENTCLOUD_SECRET_KEY-腾讯云 API 密钥 SecretKey
TENCENTCLOUD_API_BASE_HOSTtencentcloudapi.com腾讯云 API 基础域名。在腾讯云 VPC 内网环境中应配置为 internal.tencentcloudapi.com
MAX_LENGTH不限制返回内容最大长度,用于适配模型 Token 限制
PORT3000SSE 模式下的服务端口
TZ系统时区时区设置,如 Asia/Shanghai。在时间转换工具(ConvertTimeStringToTimestampConvertTimestampToTimeString)中使用

快速开始

方式一:腾讯云 SSE 托管服务(无需本地环境)

使用腾讯云 MCP 市场提供的 SSE 托管服务,无需安装 Node.js 或任何本地依赖。前往 MCP 市场 获取 SSE 端点地址,然后配置 MCP 客户端:

{ "mcpServers": { "cls-mcp-server": { "name": "cls-mcp-server", "type": "sse", "isActive": true, "baseUrl": "<从MCP市场获取的SSE端点地址>" } } }

方式二:NPX 启动(推荐的本地部署方式)

在 MCP 客户端的 mcpServers 配置中添加:

前置条件:安装 Node.js(推荐 LTS 版本),准备腾讯云 SecretId 和 SecretKey

{ "mcpServers": { "cls-mcp-server": { "isActive": true, "name": "cls-mcp-server", "type": "stdio", "command": "npx", "args": [ "-y", "cls-mcp-server@latest" ], "env": { "TRANSPORT": "stdio", "TENCENTCLOUD_SECRET_ID": "<YOUR_SECRET_ID>", "TENCENTCLOUD_SECRET_KEY": "<YOUR_SECRET_KEY>", "TZ": "Asia/Shanghai" } } } }

如在腾讯云 VPC 内网环境中部署,可在 env 中添加 "TENCENTCLOUD_API_BASE_HOST": "internal.tencentcloudapi.com"

方式三:自建 SSE 模式

前置条件:安装 Node.js(推荐 LTS 版本),准备腾讯云 SecretId 和 SecretKey

  1. 在当前目录创建 .env 文件:
TRANSPORT=sse TENCENTCLOUD_SECRET_ID=<YOUR_SECRET_ID> TENCENTCLOUD_SECRET_KEY=<YOUR_SECRET_KEY> # 如在腾讯云 VPC 内网环境中部署,取消下行注释 # TENCENTCLOUD_API_BASE_HOST=internal.tencentcloudapi.com PORT=3000 TZ=Asia/Shanghai
  1. 启动 SSE 服务:
npx -y cls-mcp-server@latest
  1. 在 MCP 客户端中配置:
{ "mcpServers": { "cls-mcp-server": { "name": "cls-mcp-server", "type": "sse", "isActive": true, "baseUrl": "http://localhost:3000/sse" } } }

方式四:源码安装

前置条件:安装 Node.js(推荐 LTS 版本),准备腾讯云 SecretId 和 SecretKey

  1. 克隆仓库并构建:
git clone <repository-url> cd cls-mcp-server npm install npm run build
  1. Stdio 模式 — 在 MCP 客户端的 mcpServers 配置中添加:
{ "mcpServers": { "cls-mcp-server": { "isActive": true, "name": "cls-mcp-server", "type": "stdio", "command": "node", "args": [ "/ABSOLUTE/PATH/TO/cls-mcp-server/dist/index.js" ], "env": { "TRANSPORT": "stdio", "TENCENTCLOUD_SECRET_ID": "<YOUR_SECRET_ID>", "TENCENTCLOUD_SECRET_KEY": "<YOUR_SECRET_KEY>", "TZ": "Asia/Shanghai" } } } }

如在腾讯云 VPC 内网环境中部署,可在 env 中添加 "TENCENTCLOUD_API_BASE_HOST": "internal.tencentcloudapi.com"

  1. SSE 模式 — 在项目根目录创建 .env 文件:
TRANSPORT=sse TENCENTCLOUD_SECRET_ID=<YOUR_SECRET_ID> TENCENTCLOUD_SECRET_KEY=<YOUR_SECRET_KEY> # 如在腾讯云 VPC 内网环境中部署,取消下行注释 # TENCENTCLOUD_API_BASE_HOST=internal.tencentcloudapi.com PORT=3000 TZ=Asia/Shanghai

启动 SSE 服务:

npm run start:sse

然后在 MCP 客户端中配置:

{ "mcpServers": { "cls-mcp-server": { "name": "cls-mcp-server", "type": "sse", "isActive": true, "baseUrl": "http://localhost:3000/sse" } } }

方式五:Docker 部署

前置条件:安装 Docker,准备腾讯云 SecretId 和 SecretKey

  1. 构建 Docker 镜像:
docker build -t cls-mcp-server .
  1. 启动容器(SSE 模式):

如在腾讯云 VPC 内网环境中部署,可添加 -e TENCENTCLOUD_API_BASE_HOST=internal.tencentcloudapi.com

docker run -d -p 3000:3000 \ -e TENCENTCLOUD_SECRET_ID=<YOUR_SECRET_ID> \ -e TENCENTCLOUD_SECRET_KEY=<YOUR_SECRET_KEY> \ -e TZ=Asia/Shanghai \ --name cls-mcp-server \ cls-mcp-server
  1. 在 MCP 客户端中配置:
{ "mcpServers": { "cls-mcp-server": { "name": "cls-mcp-server", "type": "sse", "isActive": true, "baseUrl": "http://localhost:3000/sse" } } }

License

Apache License 2.0