Skip to main content
Glama

CLS MCP Server

腾讯云日志服务(Cloud Log Service)MCP Server —— 从可观测性视角为 AI 助手提供全方位日志服务能力。

功能特性

  • 日志查询分析:CQL 检索 + SQL 管道分析、上下文查看、直方图、日志计数

  • 指标查询:PromQL 兼容的单时间点/时间范围指标查询

  • 告警管理:告警策略/通知渠道/告警记录查询与管理

  • 资源管理:日志集、日志主题、索引、机器组、仪表盘的增删改查

  • 数据加工 & 定时 SQL:数据加工任务和定时 SQL 任务管理

  • 三级权限控制:READ(默认)/ WRITE / DANGER 分级保护

37 个工具,覆盖 CLS 日志服务的完整能力。

Related MCP server: Alibaba Cloud Observability MCP Server

工具清单

日志检索(5 个)

工具名称

功能说明

权限

cls_search_log

检索分析 CLS 日志,支持 CQL 语法检索和 SQL 管道分析

只读

cls_get_log_context

获取日志上下文,查看目标日志前后的记录

只读

cls_get_log_histogram

获取日志数量直方图,观察日志量随时间的分布

只读

cls_get_log_count

快速获取日志数量,比 search_log 更快

只读

cls_describe_search_syntax

获取 CLS 日志检索语法参考和常用查询模板

只读

指标查询(3 个)

工具名称

功能说明

权限

cls_query_metric

查询指标数据(单时间点),支持 PromQL 语法

只读

cls_query_range_metric

查询指标数据(时间范围),获取指标变化趋势

只读

cls_list_metrics

列出指标主题下的所有可用指标名称

只读

告警管理(8 个)

工具名称

功能说明

权限

cls_describe_alarms

查询告警策略列表,支持分页和过滤

只读

cls_describe_alarm_detail

根据告警策略 ID 获取完整告警配置

只读

cls_describe_alarm_notices

查询告警通知渠道列表(邮件、短信、回调等)

只读

cls_describe_alarm_records

查询告警历史触发记录

只读

cls_get_alarm_detail

通过告警详情 URL 获取告警详细信息

只读

cls_create_alarm

创建告警策略

⚠️ 写入

cls_modify_alarm

修改告警策略配置

⚠️ 写入

cls_delete_alarm

删除告警策略(不可恢复)

🚨 危险

资源管理(14 个)

工具名称

功能说明

权限

cls_describe_logsets

查询日志集列表

只读

cls_describe_topics

查询日志主题列表

只读

cls_describe_topic_detail

获取日志主题详细配置

只读

cls_describe_index

查询日志主题的索引配置

只读

cls_describe_machine_groups

查询机器组列表

只读

cls_describe_machine_group_detail

获取机器组详情和机器在线状态

只读

cls_describe_dashboards

查询仪表盘列表

只读

cls_describe_regions

查询 CLS 支持的地域列表

只读

cls_create_logset

创建日志集

⚠️ 写入

cls_create_topic

创建日志主题

⚠️ 写入

cls_modify_topic

修改日志主题配置

⚠️ 写入

cls_modify_index

修改日志主题的索引配置

⚠️ 写入

cls_delete_logset

删除日志集(不可恢复)

🚨 危险

cls_delete_topic

删除日志主题及所有日志数据(不可恢复)

🚨 危险

数据加工(3 个)

工具名称

功能说明

权限

cls_describe_data_transform_tasks

查询数据加工任务列表

只读

cls_create_data_transform

创建数据加工任务

⚠️ 写入

cls_delete_data_transform

删除数据加工任务

🚨 危险

定时 SQL(3 个)

工具名称

功能说明

权限

cls_describe_scheduled_sql_tasks

查询定时 SQL 任务列表

只读

cls_create_scheduled_sql

创建定时 SQL 分析任务

⚠️ 写入

cls_delete_scheduled_sql

删除定时 SQL 任务

🚨 危险

时间工具(1 个)

工具名称

功能说明

权限

cls_convert_time

时间与时间戳互转,避免手动计算出错

只读

权限说明:只读工具默认启用;⚠️ 写入工具需设置 CLS_ENABLE_WRITE=true;🚨 危险工具需同时设置 CLS_ENABLE_WRITE=trueCLS_ENABLE_DANGEROUS=true

快速开始

先确认你的使用场景,选择对应章节:

场景

说明

跳转

本地使用

在自己电脑上配合 Claude Desktop / Cursor / VS Code 等 IDE 使用

场景一:本地 stdio 模式

远程服务

部署到服务器,团队共用或远程访问

场景二:远程服务模式


环境准备

1. 安装 uv(Python 包管理器)

uv 是一个极快的 Python 包管理器,本项目推荐使用。如已安装可跳过。

# macOS / Linux
curl -LsSf https://astral.sh/uv/install.sh | sh

# 安装完成后,让命令生效(二选一):
source $HOME/.local/bin/env    # 立即生效
# 或者关闭终端重新打开          # 重启终端也行
# Windows (PowerShell)
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"

验证安装成功:

uv --version
# 预期输出: uv 0.11.x(版本号可能不同)

没有 uv? 也可以用 pip install cls-mcp-server 安装,但 uv 更快且能自动管理 Python 版本。

2. 获取腾讯云密钥

访问 腾讯云控制台 - API 密钥管理,获取 SecretIdSecretKey


场景一:本地 stdio 模式

适合在自己电脑上使用,MCP 客户端(Claude Desktop / Cursor 等)自动拉起 Server 进程,无需手动启动服务。

第一步:配置 MCP 客户端

选择你使用的客户端,将以下配置写入对应的配置文件:

配置文件位置:

  • macOS: ~/Library/Application Support/Claude/claude_desktop_config.json

  • Windows: %APPDATA%\Claude\claude_desktop_config.json

{
  "mcpServers": {
    "cls": {
      "command": "uvx",
      "args": ["cls-mcp-server"],
      "env": {
        "CLS_SECRET_ID": "替换为你的SecretId",
        "CLS_SECRET_KEY": "替换为你的SecretKey",
        "CLS_REGION": "ap-guangzhou"
      }
    }
  }
}

配置文件位置:~/.cursor/mcp.json

{
  "mcpServers": {
    "cls": {
      "command": "uvx",
      "args": ["cls-mcp-server"],
      "env": {
        "CLS_SECRET_ID": "替换为你的SecretId",
        "CLS_SECRET_KEY": "替换为你的SecretKey",
        "CLS_REGION": "ap-guangzhou"
      }
    }
  }
}

在 VS Code 的 settings.json 中添加:

{
  "mcp": {
    "servers": {
      "cls": {
        "command": "uvx",
        "args": ["cls-mcp-server"],
        "env": {
          "CLS_SECRET_ID": "替换为你的SecretId",
          "CLS_SECRET_KEY": "替换为你的SecretKey",
          "CLS_REGION": "ap-guangzhou"
        }
      }
    }
  }
}

说明uvx 会自动从 PyPI 下载并运行 cls-mcp-server,无需手动 pip installCLS_REGION 改为你的日志所在地域(如 ap-shanghaiap-beijing)。

第二步:重启客户端

保存配置后,重启 Claude Desktop / Cursor / VS Code,客户端会自动拉起 CLS MCP Server。

第三步:验证

在客户端中发送一条消息测试:

帮我查看 CLS 支持哪些地域

如果返回了地域列表(广州、上海、北京等),说明连接成功。

其他安装方式

如果不想用 uvx,也可以手动安装后在配置中使用 cls-mcp-server 命令:

# 方式一:pip 安装(适合已有 pip 工作流的用户)
pip install cls-mcp-server

# 方式二:源码安装(适合需要修改源码的开发者)
git clone https://github.com/Tinker-LGD2026/cls-mcp-server.git
cd cls-mcp-server
uv sync
# 验证: uv run cls-mcp-server --help

使用 pip install 安装后,客户端配置中把 "command": "uvx" 改为 "command": "cls-mcp-server""args" 改为 [] 即可。


场景二:远程服务模式

适合将 Server 部署到服务器上,作为独立 HTTP 服务运行,供远程 MCP 客户端连接。

方式一:Docker 部署(推荐,最简单)

一条命令即可启动,无需安装 Python 或任何依赖:

docker run -d \
  --name cls-mcp-server \
  -p 8000:8000 \
  -e CLS_SECRET_ID=替换为你的SecretId \
  -e CLS_SECRET_KEY=替换为你的SecretKey \
  -e CLS_REGION=ap-guangzhou \
  ghcr.io/tinker-lgd2026/cls-mcp-server:latest

验证服务是否启动成功:

curl http://localhost:8000/health
# 预期输出: {"status":"ok","version":"0.3.0","transport":"streamable-http"}

方式二:一键部署脚本(适合无 Docker 的虚拟机)

支持 CentOS 7+、Ubuntu 18.04+、Debian 10+,脚本自动安装 uv + Python 3.12 + 依赖 + 注册 systemd 服务,零前置依赖

# 1. 将源码上传到服务器(git clone 或 tar.gz 打包上传)
git clone https://github.com/Tinker-LGD2026/cls-mcp-server.git
cd cls-mcp-server

# 2. 运行一键部署脚本
sudo bash deploy/systemd/install.sh

# 3. 编辑配置文件,填入真实密钥
sudo vim /opt/cls-mcp-server/.env

# 4. 启动服务
sudo systemctl start cls-mcp-server

# 5. 验证
curl http://127.0.0.1:8000/health

CentOS 7 用户:不用担心 Python 版本问题,脚本通过 uv 自动下载 Python 3.12,不影响系统自带 Python。如果 git clone 太慢,可以在本地打包后 scp 上传,详见 部署手册 - systemd 部署

客户端连接远程服务

服务启动后,在 MCP 客户端中配置远程连接:

{
  "mcpServers": {
    "cls": {
      "url": "http://你的服务器IP:8000/mcp"
    }
  }
}

如需 SSE 模式(兼容旧版客户端),端点改为 /sse。如已设置 Bearer Token 认证,需添加 "headers": {"Authorization": "Bearer 你的token"}


配置参考

环境变量

变量

必填

默认值

说明

CLS_SECRET_ID

腾讯云 API SecretId

CLS_SECRET_KEY

腾讯云 API SecretKey

CLS_REGION

ap-guangzhou

地域(如 ap-shanghaiap-beijing

CLS_TRANSPORT

stdio

传输方式:stdio / sse / streamable-http

CLS_HOST

0.0.0.0

HTTP 监听地址(远程模式)

CLS_PORT

8000

HTTP 监听端口(远程模式)

MCP_AUTH_TOKEN

HTTP Bearer Token 认证(远程模式,建议开启)

CLS_ENABLE_WRITE

false

启用写操作工具(创建/修改)

CLS_ENABLE_DANGEROUS

false

启用危险操作工具(删除,需同时开启写操作)

CLS_LOG_LEVEL

INFO

日志级别:DEBUG / INFO / WARNING / ERROR

CLS_REQUEST_TIMEOUT

60

SDK 请求超时时间(秒)

CLS_RETRY_MAX_ATTEMPTS

3

失败重试最大尝试次数(含首次调用)

CLS_RETRY_BASE_DELAY

1.0

重试基础退避延迟(秒),实际延迟会指数递增

CLS_CB_FAILURE_THRESHOLD

5

熔断器触发阈值:连续失败多少次后熔断

CLS_CB_RECOVERY_TIMEOUT

30

熔断恢复超时(秒):熔断后多久尝试恢复

CLS_ENABLED_TOOLS

工具白名单(逗号分隔),未设置则注册全部工具,详见下方说明

工具白名单(CLS_ENABLED_TOOLS)

默认情况下,Server 会注册所有符合权限等级的工具。如果你只需要部分功能,可以通过 CLS_ENABLED_TOOLS 精确控制注册哪些工具,未列出的工具不会注册,AI 助手也无法调用

配置格式:工具名用英文逗号分隔,名称必须与上方"工具清单"中的工具名完全一致。

# 只注册日志查询相关工具
CLS_ENABLED_TOOLS="cls_search_log,cls_get_log_context,cls_get_log_histogram,cls_get_log_count,cls_describe_search_syntax,cls_convert_time"

# 只注册告警管理相关工具
CLS_ENABLED_TOOLS="cls_describe_alarms,cls_describe_alarm_detail,cls_describe_alarm_notices,cls_describe_alarm_records,cls_get_alarm_detail"

# CLI 方式
cls-mcp-server --enabled-tools "cls_search_log,cls_get_log_context,cls_describe_topics,cls_describe_index"

常见场景示例

场景

推荐配置

只做日志查询分析

cls_search_log,cls_get_log_context,cls_get_log_histogram,cls_get_log_count,cls_describe_search_syntax,cls_convert_time

只做告警监控

cls_describe_alarms,cls_describe_alarm_detail,cls_describe_alarm_notices,cls_describe_alarm_records,cls_get_alarm_detail

日志查询 + 资源浏览

cls_search_log,cls_get_log_context,cls_get_log_count,cls_describe_topics,cls_describe_logsets,cls_describe_index,cls_convert_time

不设置(默认)

注册全部工具

提示:白名单与权限控制(CLS_ENABLE_WRITE / CLS_ENABLE_DANGEROUS)是 AND 关系,两者同时满足才会注册。填写了不存在的工具名会在启动日志中输出警告,不会影响其他工具注册。


部署指南

除了上面"快速开始"中的 Docker 和一键脚本,还支持更多部署方式:

方式

适用场景

文档

Docker / Docker Compose

远程服务,生产环境推荐

详细说明

systemd + 一键脚本

传统虚拟机(CentOS/Ubuntu)

详细说明

Kubernetes / Helm

容器编排,多副本水平扩展

详细说明

Nginx 反向代理 + HTTPS

生产环境 TLS 终结

详细说明

HTTP Bearer Token 认证

远程服务访问控制

详细说明

完整部署手册请参考 docs/deployment-guide.md


国内环境加速

如果 pip / Docker / uv 下载速度慢:

# pip 使用清华源
pip install cls-mcp-server -i https://pypi.tuna.tsinghua.edu.cn/simple

# uv 使用国内源
UV_INDEX_URL=https://pypi.tuna.tsinghua.edu.cn/simple uvx cls-mcp-server --help

更多加速方案(Docker 镜像加速、uv 离线安装、GitHub 代理等)请参考 部署手册 - 国内环境加速

许可证

Apache-2.0

Available Tools

24 tools
cls_convert_timeA

时间与时间戳转换工具。在调用需要时间戳参数的 CLS 工具前,请先使用此工具进行精确转换,避免手动计算时间戳出错。

功能

  • 可读时间 → 时间戳:传入 human_readable 参数,返回对应的 Unix 毫秒时间戳和秒级时间戳

  • 时间戳 → 可读时间:传入 timestamp 参数(毫秒级),返回对应的可读时间字符串

  • 同时返回毫秒和秒级时间戳,方便直接用于日志查询(毫秒)或指标查询(秒)

参数说明

  • timestamp: Unix 毫秒时间戳(整数),与 human_readable 二选一

  • human_readable: 人类可读时间表达式(字符串),与 timestamp 二选一,支持以下格式:

    • 绝对时间: 2026-03-25 14:30:002026-03-25 14:30:00.1232026-03-25 14:302026-03-25

    • 相对时间: nowtodayyesterdaytomorrow

    • 组合格式: yesterday 12:00:00today 09:30tomorrow 08:00

    • 相对偏移: 3 hours ago1 day ago30 minutes ago2 weeks ago

  • timezone: 时区名称,默认 Asia/Shanghai

使用示例

  • 查询昨天12:00到13:00: 分别调用 human_readable="yesterday 12:00:00"human_readable="yesterday 13:00:00"

  • 查询最近1小时: 调用 human_readable="1 hour ago" 获取 start_time,human_readable="now" 获取 end_time

  • 转换时间戳: 调用 timestamp=1774396800000 查看对应的可读时间

返回格式

返回包含毫秒时间戳(用于 cls_search_log 等)、秒级时间戳(用于 cls_query_metric 等)和可读时间字符串。

ParametersJSON Schema
NameRequiredDescriptionDefault
timestampNo
human_readableNo
timezone_nameNoAsia/Shanghai

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

A4.7/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries the full burden of behavioral disclosure. It effectively describes the tool's behavior: it performs bidirectional conversion, returns both millisecond and second timestamps, supports multiple time formats, and has a default timezone. However, it doesn't mention error handling, rate limits, or authentication requirements, which keeps it from a perfect score.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is well-structured with clear sections (功能, 参数说明, 使用示例, 返回格式) and uses bullet points effectively. While comprehensive, it could be slightly more concise by integrating some of the usage examples into the functional description rather than having a separate section.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's complexity (bidirectional conversion with multiple parameter formats) and the presence of an output schema, the description is complete. It explains what the tool does, how to use it, parameter details, practical examples, and what to expect in the return values, making it fully self-contained despite the lack of annotations and schema descriptions.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

With 0% schema description coverage, the description fully compensates by providing detailed parameter semantics. It explains that timestamp and human_readable are mutually exclusive parameters, documents the exact formats supported for human_readable (absolute time, relative time, combinations, offsets), and clarifies the purpose of the timezone parameter with its default value.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool's purpose as a time and timestamp conversion utility for CLS tools, specifying it converts between human-readable time and Unix timestamps. It distinguishes itself from sibling tools by explicitly mentioning its role in preparing parameters for tools like cls_search_log and cls_query_metric, which none of the other tools do.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides explicit guidance on when to use this tool ('before calling CLS tools that require timestamp parameters') and includes practical examples showing how to use it for specific scenarios like querying yesterday's data or recent time ranges. It also mentions which sibling tools benefit from its output (cls_search_log for milliseconds, cls_query_metric for seconds).

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

cls_describe_alarm_detailA

获取告警策略详情。根据告警策略 ID 查看完整的告警配置信息。

参数说明

  • alarm_id: 告警策略 ID(必填)

  • region: 地域(可选),如 ap-guangzhou、na-ashburn,不传则使用默认地域,可通过 cls_describe_regions 查询所有可用地域

返回信息

  • 完整的告警配置:名称、监控条件、触发规则

  • 通知渠道配置、告警周期

  • 关联的日志主题和查询条件

ParametersJSON Schema
NameRequiredDescriptionDefault
alarm_idYes
regionNo

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

A3.6/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description carries the full burden. It describes what information is returned (e.g., configuration, notification channels, associated topics) but lacks behavioral details such as error handling, permissions required, rate limits, or whether it's a read-only operation. The description doesn't contradict annotations (none exist), but it's insufficient for a mutation-sensitive context.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is well-structured with a clear purpose statement, parameter explanations in a bulleted list, and return information details. It's appropriately sized—every sentence adds value, such as clarifying parameter usage and output content. Minor room for improvement in flow, but it's efficient and front-loaded.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool has an output schema (implied by 'Has output schema: true'), the description doesn't need to detail return values, and it appropriately summarizes them. With no annotations and 0% schema coverage, the description compensates well by explaining parameters and purpose. It's complete enough for a read operation, though more behavioral context would enhance it.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0%, so the description must compensate fully. It provides detailed semantics for both parameters: 'alarm_id' is required and explained as the alarm policy ID, and 'region' is optional with examples (ap-guangzhou, na-ashburn), default behavior (uses default if not provided), and a reference to another tool for querying regions. This adds significant value beyond the bare schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool's purpose: '获取告警策略详情' (get alarm policy details) and specifies it retrieves complete alarm configuration information based on an alarm ID. It distinguishes from siblings like 'cls_describe_alarms' (likely lists alarms) and 'cls_get_alarm_detail' (similar but not identical naming), though the distinction isn't explicitly stated. The verb '获取' (get) and resource '告警策略详情' (alarm policy details) are specific.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implies usage when needing full alarm configuration details for a specific alarm ID, as opposed to listing alarms or other alarm-related operations. It mentions an alternative tool 'cls_describe_regions' for querying available regions, but doesn't explicitly state when to use this tool versus siblings like 'cls_describe_alarms' or 'cls_get_alarm_detail'. Guidelines are present but not comprehensive.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

cls_describe_alarm_noticesB

查询告警通知渠道列表。获取当前账号配置的告警通知方式(如邮件、短信、回调等)。

参数说明

  • offset: 分页偏移量,默认 0

  • limit: 每页条数,默认 20

  • name: 按通知名称过滤(可选)

  • region: 地域(可选),如 ap-guangzhou、na-ashburn,不传则使用默认地域,可通过 cls_describe_regions 查询所有可用地域

ParametersJSON Schema
NameRequiredDescriptionDefault
offsetNo
limitNo
nameNo
regionNo

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

B3.4/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description carries full burden. It states this is a query/list operation, implying it's likely read-only and non-destructive, but doesn't explicitly confirm safety aspects like permissions required, rate limits, or whether it modifies data. The description adds some context about default region behavior and references another tool for region info, but lacks details on response format, pagination behavior beyond offset/limit, or error conditions.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is well-structured with a clear purpose statement followed by a parameter section. It's front-loaded with the main functionality. Sentences are efficient: the first sentence states the action and resource, the second elaborates on what's retrieved. The parameter explanations are brief but informative. Minor improvements could include merging the two initial sentences or adding bullet points for clarity, but overall it's concise with minimal waste.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool has an output schema (which handles return values), 4 parameters with 0% schema coverage but good description compensation, and no annotations, the description is reasonably complete. It covers purpose, parameters with semantics, and hints at usage context. It could be more complete by explicitly stating behavioral traits (e.g., read-only, pagination details) and differentiating from siblings, but for a query tool with output schema, it provides adequate context for basic use.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0%, so the description must compensate. It provides a parameter section explaining all 4 parameters: offset (pagination offset, default 0), limit (items per page, default 20), name (filter by notification name, optional), and region (region like ap-guangzhou, optional, defaults to default region). This adds meaningful semantics beyond the schema's basic titles and types, covering defaults, optionality, and examples. However, it doesn't detail format constraints (e.g., region string patterns) or interactions between parameters.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool's purpose: '查询告警通知渠道列表' (query alarm notification channel list) and '获取当前账号配置的告警通知方式' (get the current account's configured alarm notification methods). It specifies the resource (alarm notification channels/methods) and action (query/list/get). However, it doesn't explicitly differentiate from sibling tools like cls_describe_alarms or cls_describe_alarm_records, which also deal with alarms but focus on different aspects.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implies usage context by mentioning it retrieves notification methods for alarms, suggesting it should be used when needing to know how alarms are delivered. It provides one explicit alternative: '可通过 cls_describe_regions 查询所有可用地域' (can use cls_describe_regions to query all available regions) for the region parameter. However, it lacks broader guidance on when to use this tool versus other alarm-related siblings like cls_describe_alarms, and doesn't specify prerequisites or exclusions.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

cls_describe_alarm_recordsA

查询告警历史记录。查看最近的告警触发记录,了解告警发生的时间、原因和处理状态。

参数说明

  • start_time: 起始时间,Unix 时间戳(毫秒),如 1700000000000(必填)

  • end_time: 结束时间,Unix 时间戳(毫秒)(必填)

  • offset: 分页偏移量,默认 0

  • limit: 每页条数,默认 20

  • alarm_id: 按告警策略 ID 过滤(可选)

  • topic_id: 按监控对象(日志主题)ID 过滤(可选)。如不确定 ID,可先通过 cls_describe_topics 按名称搜索

  • status: 按告警状态过滤(可选):0=未恢复,1=已恢复,2=已失效

  • alarm_level: 按告警等级过滤(可选):0=警告,1=提醒,2=紧急

适用场景

  • 排查某个告警策略的历史触发情况

  • 查看某个日志主题关联的所有告警记录

  • 按状态或等级筛选告警记录

  • 了解最近告警的总体趋势

注意事项

  • start_time/end_time 为毫秒时间戳,请先调用 cls_convert_time 工具转换,不要手动计算

  • region: 地域(可选),如 ap-guangzhou、na-ashburn,不传则使用默认地域,可通过 cls_describe_regions 查询所有可用地域

ParametersJSON Schema
NameRequiredDescriptionDefault
start_timeYes
end_timeYes
offsetNo
limitNo
alarm_idNo
topic_idNo
statusNo
alarm_levelNo
regionNo

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

A4.6/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries full burden and adds valuable behavioral context. It explains pagination behavior (offset/limit defaults), time format requirements (Unix timestamp in milliseconds), region handling (optional with default), and references other tools for conversions. However, it doesn't mention rate limits, authentication needs, or whether this is a read-only operation (though implied by '查询').

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Well-structured with clear sections (description, parameter说明, 适用场景, 注意事项), each sentence adds value. The description is appropriately sized for a 9-parameter tool with no schema documentation, front-loading the core purpose while organizing details logically. No wasted text.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the complexity (9 parameters, 0% schema coverage, no annotations) and presence of an output schema (which handles return values), the description is remarkably complete. It covers purpose, parameters, usage scenarios, prerequisites (time conversion tool), and regional considerations. The only minor gap is lack of explicit read/write classification, but the output schema likely addresses response format.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0%, so the description fully compensates with detailed parameter documentation. The '参数说明' section explains all 9 parameters with clear semantics: required vs optional, data types (Unix timestamps, integers, strings), defaults, filtering purposes, and enum mappings for status (0-2) and alarm_level (0-2). It adds crucial context beyond the bare schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool's purpose: '查询告警历史记录' (query alarm history records) with specific details about viewing recent alarm triggers, time, cause, and status. It distinguishes from siblings like cls_describe_alarms (likely for alarm policies) and cls_describe_alarm_detail (likely for single alarm details), but doesn't explicitly name these alternatives. The purpose is clear but lacks explicit sibling differentiation.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The '适用场景' (applicable scenarios) section provides explicit guidance on when to use this tool: for investigating alarm policy history, viewing all alarm records for a log topic, filtering by status/level, and understanding recent alarm trends. It also references sibling tools (cls_describe_topics, cls_convert_time, cls_describe_regions) for related operations, offering clear alternatives and prerequisites.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

cls_describe_alarmsA

查询告警策略列表。获取当前账号下的告警策略信息,支持分页和过滤。

参数说明

  • offset: 分页偏移量,默认 0

  • limit: 每页条数,默认 20,最大 100

  • name: 按告警策略名称过滤(可选,模糊匹配)

  • topic_id: 按关联日志主题 ID 过滤(可选)。如不确定 ID,可先通过 cls_describe_topics 按名称搜索

  • region: 地域(可选),如 ap-guangzhou、na-ashburn,不传则使用默认地域,可通过 cls_describe_regions 查询所有可用地域

返回信息

  • 告警策略 ID、名称、状态(开启/关闭)

  • 监控条件、触发规则、通知渠道

  • 创建和最近修改时间

ParametersJSON Schema
NameRequiredDescriptionDefault
offsetNo
limitNo
nameNo
topic_idNo
regionNo

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

A4.2/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries the full burden. It effectively discloses key behavioral traits: it's a read operation (implied by '查询'), supports pagination (offset/limit with defaults and max limit), filtering options (name, topic_id, region), and default region behavior. It also hints at authentication context ('当前账号下') and mentions the response format. However, it doesn't cover rate limits, error conditions, or exact permission requirements.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is well-structured with a clear purpose statement followed by organized sections for parameters and return information. Every sentence adds value: the opening defines scope, parameter details are essential for understanding, and return info clarifies output. It could be slightly more front-loaded by moving key behavioral notes (e.g., pagination defaults) earlier, but overall it's efficient and informative.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's moderate complexity (5 parameters, filtering, pagination), no annotations, but with an output schema (implied by '返回信息'), the description is quite complete. It covers purpose, usage context, parameter semantics, and output structure. The output schema existence means the description doesn't need to detail return values exhaustively. Minor gaps include lack of error handling or authentication specifics, but it's sufficient for effective use.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0%, so the description must fully compensate. It does this excellently by providing detailed parameter semantics in the '参数说明' section: explaining each parameter's purpose (e.g., offset for pagination, limit with max value, name for fuzzy matching), optionality, defaults, and practical usage notes (e.g., using cls_describe_topics if topic_id is unknown). This adds significant value beyond the bare schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool's purpose as '查询告警策略列表' (query alarm policy list) and specifies it retrieves alarm policy information for the current account. It distinguishes from siblings like cls_describe_alarm_detail (detail view) and cls_describe_alarm_records (records) by focusing on listing policies with filtering capabilities. However, it doesn't explicitly contrast with all similar tools like cls_get_alarm_detail.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides clear context for when to use this tool: to list alarm policies with pagination and filtering. It offers guidance on alternatives for related tasks, such as using cls_describe_topics to search by name if topic_id is uncertain, and cls_describe_regions to query available regions. However, it doesn't explicitly state when NOT to use it (e.g., vs. cls_describe_alarm_detail for detailed info).

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

cls_describe_dashboardsA

查询仪表盘列表。获取当前账号下的 CLS 仪表盘。

参数说明

  • offset: 分页偏移量,默认 0

  • limit: 每页条数,默认 20

  • dashboard_name: 按仪表盘名称过滤(可选)

  • region: 地域(可选),如 ap-guangzhou、na-ashburn,不传则使用默认地域,可通过 cls_describe_regions 查询所有可用地域

ParametersJSON Schema
NameRequiredDescriptionDefault
offsetNo
limitNo
dashboard_nameNo
regionNo

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

A3.6/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description carries the full burden. It mentions pagination (offset/limit) and optional filtering, but doesn't disclose critical behavioral traits: whether this is a read-only operation, potential rate limits, authentication requirements, error conditions, or what happens if no dashboards exist. For a list tool with zero annotation coverage, this leaves significant gaps.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is well-structured and appropriately sized. It starts with a clear purpose statement, followed by a parameter section with bullet points. Every sentence earns its place, though it could be slightly more front-loaded by integrating parameter hints into the initial summary. No wasted text.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's moderate complexity (list operation with filtering/pagination), no annotations, but with an output schema (which handles return values), the description is fairly complete. It covers all parameters thoroughly and references related tools. However, it lacks behavioral context (e.g., safety, limits), which is a minor gap since the output schema exists.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The schema description coverage is 0%, so the description must compensate fully. It does so excellently: it explains all 4 parameters with clear semantics—offset as pagination offset, limit as items per page, dashboard_name for filtering, and region with examples and a reference to another tool for valid values. This adds substantial meaning beyond the bare schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool's purpose: '查询仪表盘列表。获取当前账号下的 CLS 仪表盘。' (Query dashboard list. Get CLS dashboards under the current account.) This specifies the verb ('query/list') and resource ('CLS dashboards'), making the purpose unambiguous. However, it doesn't explicitly differentiate from sibling tools like 'cls_describe_regions' or 'cls_describe_topics', which describe other resources.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides some implied usage context: it mentions filtering by dashboard name and region, and references 'cls_describe_regions' for available regions. However, it lacks explicit guidance on when to use this tool versus alternatives (e.g., no comparison to other 'describe' tools for dashboards or search functions). The context is clear but not comprehensive.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

cls_describe_data_transform_tasksA

查询数据加工任务列表。数据加工用于对日志数据进行清洗、转换、分发等处理。

参数说明

  • offset: 分页偏移量,默认 0

  • limit: 每页条数,默认 20

  • task_name: 按任务名称过滤(可选)

  • topic_id: 按源日志主题 ID 过滤(可选)。如不确定 ID,可先通过 cls_describe_topics 按名称搜索

  • region: 地域(可选),如 ap-guangzhou、na-ashburn,不传则使用默认地域,可通过 cls_describe_regions 查询所有可用地域

返回信息

  • 任务 ID、名称、状态(运行中/已停止/异常等)

  • 源主题和目标主题

  • 加工语句和创建时间

ParametersJSON Schema
NameRequiredDescriptionDefault
offsetNo
limitNo
task_nameNo
topic_idNo
regionNo

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

A4.2/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries full burden. It describes what the tool returns (task list with IDs, names, statuses, source/destination topics, processing statements, creation times) and mentions pagination behavior through offset/limit parameters. However, it doesn't disclose important behavioral traits like whether this is a read-only operation (implied but not stated), rate limits, authentication requirements, or error conditions. The description adds useful context about what 'data processing' means but lacks comprehensive behavioral disclosure.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is well-structured with clear sections: purpose statement, parameter explanations, and return information. Each sentence earns its place by providing necessary information. The front-loaded purpose statement is clear, though the Chinese formatting with markdown headers might be slightly less accessible than plain text. It's appropriately sized for a tool with 5 parameters and detailed return expectations.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's complexity (5 parameters, no annotations, but has output schema), the description provides good coverage. It explains all parameters thoroughly, describes what the tool returns, and provides context about data processing. The existence of an output schema means the description doesn't need to exhaustively document return values. However, it could better address when to use this versus similar tools and provide more behavioral context given the lack of annotations.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

With 0% schema description coverage (titles only provide parameter names without meaning), the description fully compensates by explaining all 5 parameters in detail. It provides: 1) offset as pagination offset with default 0, 2) limit as items per page with default 20, 3) task_name as optional filter by task name, 4) topic_id as optional filter by source log topic ID with guidance on how to find IDs, 5) region as optional region parameter with examples and guidance on how to query available regions. This adds significant value beyond the bare schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool's purpose: '查询数据加工任务列表' (query data processing task list) with specific context about what data processing entails ('数据加工用于对日志数据进行清洗、转换、分发等处理' - data processing is used for cleaning, transforming, and distributing log data). It distinguishes itself from siblings like cls_describe_topics by focusing specifically on data transform tasks rather than general topics or other resources.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides clear context for when to use certain parameters (e.g., '如不确定 ID,可先通过 cls_describe_topics 按名称搜索' - if unsure about ID, first search by name using cls_describe_topics; '可通过 cls_describe_regions 查询所有可用地域' - can query all available regions using cls_describe_regions). However, it doesn't explicitly state when to use this tool versus alternatives like cls_describe_scheduled_sql_tasks or other describe_* siblings, missing explicit comparison guidance.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

cls_describe_indexA

查询日志主题的索引配置。索引决定了哪些字段可被检索和分析。

参数说明

  • topic_id: 日志主题 ID(必填)

  • region: 地域(可选),如 ap-guangzhou、na-ashburn,不传则使用默认地域,可通过 cls_describe_regions 查询所有可用地域

返回信息

  • 全文索引配置(是否开启、分词符等)

  • 键值索引配置(字段名、类型、是否开启统计)

  • 索引状态

ParametersJSON Schema
NameRequiredDescriptionDefault
topic_idYes
regionNo

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

A4.3/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries the full burden of behavioral disclosure. It does well by explaining what information is returned (full-text index configuration, key-value index configuration, index status), which helps the agent understand the output. However, it doesn't mention important behavioral aspects like whether this is a read-only operation (implied but not stated), error conditions, rate limits, or authentication requirements.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is well-structured with clear sections (purpose, parameter explanation, return information). It's appropriately sized - every sentence adds value. The only minor issue is some redundancy between the opening statement and the parameter/return sections, but overall it's efficient and front-loaded with the core purpose.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given that there's an output schema (which handles return values), no annotations, and good parameter coverage in the description, this description is complete enough. It explains the purpose, parameters, and what information will be returned at a high level. The output schema will provide the detailed structure, so the description doesn't need to duplicate that information.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The schema description coverage is 0%, so the description must fully compensate. It provides excellent parameter semantics: clearly explains topic_id is required and what it represents, explains region is optional with examples of valid values (ap-guangzhou, na-ashburn), describes the default behavior when region is not provided, and references another tool (cls_describe_regions) for getting all available regions. This adds substantial value beyond the bare schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool's purpose as '查询日志主题的索引配置' (query log topic index configuration), specifying both the verb (query) and resource (log topic index configuration). It distinguishes from siblings like cls_describe_topic_detail (which likely describes general topic details) and cls_describe_regions (which lists regions) by focusing specifically on index configuration.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides clear context for when to use this tool: to query index configuration for log topics. It mentions an alternative tool (cls_describe_regions) for getting available regions, which helps differentiate usage. However, it doesn't explicitly state when NOT to use this tool or compare it to other similar describe tools like cls_describe_topic_detail.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

cls_describe_logsetsA

查询日志集列表。日志集是 CLS 的项目管理单元,包含多个日志主题。

参数说明

  • offset: 分页偏移量,默认 0

  • limit: 每页条数,默认 20

  • logset_name: 按日志集名称过滤(可选,模糊匹配)

  • region: 地域(可选),如 ap-guangzhou、na-ashburn,不传则使用默认地域,可通过 cls_describe_regions 查询所有可用地域

返回信息

  • 日志集 ID、名称、标签

  • 保存周期、创建时间

  • 包含的日志主题数量

ParametersJSON Schema
NameRequiredDescriptionDefault
offsetNo
limitNo
logset_nameNo
regionNo

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

A4.3/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries full burden. It describes the tool as a query operation (consistent with read-only behavior) and mentions pagination behavior (offset/limit defaults). However, it doesn't disclose important behavioral traits like authentication requirements, rate limits, error conditions, or whether this is a safe read operation versus a mutation.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is well-structured with clear sections (purpose, parameters, return information). Every sentence earns its place by providing essential information. The Chinese text is efficient with no redundant phrases. The structure helps users quickly find what they need.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool has an output schema (true), the description appropriately focuses on explaining what the tool does rather than detailing return values. It covers parameters comprehensively and provides context about logsets. For a read-only list tool, this is mostly complete, though it could benefit from more behavioral context given the lack of annotations.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

With 0% schema description coverage, the description fully compensates by providing detailed parameter explanations. Each of the 4 parameters gets clear semantic meaning: offset as pagination offset, limit as page size, logset_name as fuzzy match filter, and region with examples and reference to another tool. The description adds significant value beyond the bare schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool's purpose with specific verb ('查询' - query) and resource ('日志集列表' - logsets list). It distinguishes from siblings by focusing on logsets rather than topics, alarms, or other CLS resources. The explanation that logsets are project management units containing multiple log topics provides helpful context.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides clear context for when to use this tool (to list logsets with optional filtering). It mentions that region can be obtained via 'cls_describe_regions', which is a helpful alternative reference. However, it doesn't explicitly state when NOT to use this tool or compare it directly with similar sibling tools like 'cls_describe_topics'.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

cls_describe_machine_group_detailA

获取机器组详情和机器状态。查看机器组的配置信息和组内机器的在线状态。

参数说明

  • group_id: 机器组 ID(必填)

  • region: 地域(可选),如 ap-guangzhou、na-ashburn,不传则使用默认地域,可通过 cls_describe_regions 查询所有可用地域

ParametersJSON Schema
NameRequiredDescriptionDefault
group_idYes
regionNo

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

A3.9/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description carries full burden. It describes what information is retrieved (configuration and online status) but lacks behavioral details such as whether this is a read-only operation, potential rate limits, authentication requirements, error conditions, or response format. The description doesn't contradict annotations (none exist), but provides minimal behavioral context.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is appropriately sized with two clear sections: a purpose statement followed by parameter explanations. Every sentence adds value, though the structure could be slightly more front-loaded by integrating parameter hints into the main description. No wasted text.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool has an output schema (which handles return values), 2 parameters with good semantic coverage in the description, and no annotations, the description is reasonably complete. It covers purpose, usage context, and parameter meanings adequately, though more behavioral transparency would improve completeness for a tool with no annotations.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

With 0% schema description coverage, the description compensates well by explaining both parameters: 'group_id' is required and identifies the machine group, and 'region' is optional with examples (ap-guangzhou, na-ashburn), default behavior (uses default if not provided), and how to find available values (via cls_describe_regions). This adds significant meaning beyond the bare schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the specific action ('获取机器组详情和机器状态' - get machine group details and machine status) and resource ('机器组' - machine group). It distinguishes from sibling tools like 'cls_describe_machine_groups' (which likely lists groups) by focusing on details and status of a specific group.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides clear context for when to use this tool: to view configuration information and online status of machines within a group. It mentions an alternative tool ('cls_describe_regions') for querying available regions, but doesn't explicitly state when NOT to use this tool or compare it to all relevant siblings like 'cls_describe_machine_groups'.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

cls_describe_machine_groupsA

查询机器组列表。机器组是日志采集端的管理单元,用于统一管理一组日志源机器。

参数说明

  • offset: 分页偏移量,默认 0

  • limit: 每页条数,默认 20

  • group_name: 按机器组名称过滤(可选)

  • region: 地域(可选),如 ap-guangzhou、na-ashburn,不传则使用默认地域,可通过 cls_describe_regions 查询所有可用地域

ParametersJSON Schema
NameRequiredDescriptionDefault
offsetNo
limitNo
group_nameNo
regionNo

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

A3.6/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries the full burden of behavioral disclosure. While it mentions this is a query/list operation, it doesn't disclose important behavioral traits like whether this requires authentication, rate limits, pagination behavior beyond basic offset/limit parameters, or what happens when no results match filters. The description provides some context about machine groups but lacks operational transparency.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is well-structured with a clear purpose statement followed by organized parameter explanations. Every sentence earns its place by providing essential information. It could be slightly more front-loaded with a clearer distinction from sibling tools, but overall it's appropriately sized and efficiently organized.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool has an output schema (which handles return values), 4 parameters with good description coverage, and moderate complexity, the description is reasonably complete. It explains what machine groups are, documents all parameters with semantics, and references related tools. The main gap is lack of behavioral transparency around authentication, rate limits, and error conditions.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The description provides excellent parameter semantics beyond the input schema. With 0% schema description coverage, the description fully compensates by explaining all 4 parameters: offset (pagination offset, default 0), limit (items per page, default 20), group_name (filter by machine group name, optional), and region (geographic region, optional, with examples and reference to another tool for available regions). This adds significant value beyond the bare schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the purpose as '查询机器组列表' (query machine group list), which is a specific verb+resource combination. It further explains that machine groups are management units for log collection endpoints. However, it doesn't explicitly differentiate from sibling tools like 'cls_describe_machine_group_detail' which presumably provides detailed information about a specific machine group.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides some implied usage context by mentioning that machine groups are '用于统一管理一组日志源机器' (used to uniformly manage a group of log source machines). It also references 'cls_describe_regions' for getting available regions. However, it doesn't explicitly state when to use this tool versus alternatives like 'cls_describe_machine_group_detail' or provide clear exclusions.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

cls_describe_regionsA

查询 CLS 支持的地域列表。返回所有可用地域的 ID 和中文名称,用于确认地域参数的正确取值。

无需参数

直接调用即可,无需传入任何参数。

返回信息

  • 地域 ID(如 ap-guangzhou、ap-shanghai)

  • 地域中文名称(如 广州、上海)

使用场景

  • 不确定某个城市/地区对应的地域 ID 时,先调用此工具查询

  • 需要列出所有可用地域供用户选择时使用

ParametersJSON Schema
NameRequiredDescriptionDefault

No parameters

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

A4.7/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries full burden. It effectively describes the tool's behavior: it's a read-only query (implied by '查询'), returns specific data fields (region IDs and Chinese names), and has no parameters. It doesn't mention rate limits, authentication needs, or pagination, but for a simple metadata query tool, the description provides adequate behavioral context.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is well-structured with clear sections (### 无需参数, ### 返回信息, ### 使用场景), front-loads the core purpose, and every sentence adds value. No redundant information or wasted words.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's simplicity (0 parameters, read-only query, has output schema), the description is complete. It explains what the tool does, when to use it, what it returns, and that no parameters are needed. The output schema will handle return value documentation, so the description appropriately focuses on usage context.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The tool has 0 parameters with 100% schema description coverage. The description explicitly states '无需参数' (no parameters needed) and '直接调用即可' (call directly), which adds helpful confirmation beyond the empty schema. This exceeds the baseline expectation for parameterless tools.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool's purpose as '查询 CLS 支持的地域列表' (query CLS supported region list), specifying both the verb (query) and resource (region list). It distinguishes itself from siblings by focusing on region metadata rather than logs, alarms, dashboards, or other CLS resources mentioned in sibling tool names.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description explicitly provides usage scenarios: '不确定某个城市/地区对应的地域 ID 时,先调用此工具查询' (when unsure about region ID for a city/area, call this tool first) and '需要列出所有可用地域供用户选择时使用' (use when needing to list all available regions for user selection). This gives clear when-to-use guidance with practical examples.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

cls_describe_scheduled_sql_tasksA

查询定时 SQL 任务列表。定时 SQL 用于周期性执行 SQL 分析并将结果存入目标日志主题。

参数说明

  • offset: 分页偏移量,默认 0

  • limit: 每页条数,默认 20

  • task_name: 按任务名称过滤(可选)

  • src_topic_id: 按源日志主题 ID 过滤(可选)

  • region: 地域(可选),如 ap-guangzhou、na-ashburn,不传则使用默认地域,可通过 cls_describe_regions 查询所有可用地域

返回信息

  • 任务 ID、名称、状态

  • 源主题、SQL 语句、调度周期

  • 目标主题、创建时间

ParametersJSON Schema
NameRequiredDescriptionDefault
offsetNo
limitNo
task_nameNo
src_topic_idNo
regionNo

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

A3.8/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries the full burden. It describes the tool as a query/list operation (implied read-only) and provides some behavioral context about pagination defaults and regional behavior. However, it doesn't disclose important traits like rate limits, authentication requirements, error conditions, or whether the operation is idempotent.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is well-structured with clear sections for purpose, parameters, and return information. It's appropriately sized with no wasted sentences. The only minor issue is that the purpose statement could be more front-loaded before the detailed sections.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's moderate complexity (5 parameters, no annotations, but has output schema), the description provides good coverage. The output schema exists, so the description doesn't need to explain return values in detail (though it helpfully summarizes them). The main gap is lack of behavioral context that annotations would normally provide.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

With 0% schema description coverage, the description fully compensates by providing detailed parameter explanations in Chinese. Each of the 5 parameters gets clear semantic meaning, including defaults, optionality, examples (region values), and references to other tools. This adds significant value beyond the bare schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool's purpose as '查询定时 SQL 任务列表' (query scheduled SQL task list) and explains that these tasks are for periodic SQL analysis with results stored in target log topics. This provides a specific verb+resource combination, though it doesn't explicitly differentiate from sibling tools like cls_describe_data_transform_tasks or cls_describe_topics.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implies usage context through the parameter explanations (e.g., region defaults and reference to cls_describe_regions for available regions) but doesn't provide explicit guidance on when to use this tool versus alternatives. No when-not-to-use or sibling tool comparisons are included.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

cls_describe_search_syntaxA

CQL 检索分析语法完整参考文档。当 cls_search_log 执行报错或不确定如何编写查询语句时使用。

返回 CLS CQL 完整语法参考文档,包含:

  • CQL 检索语法(键值检索、短语检索、逻辑操作符、数值比较、模糊匹配、字段存在性等)

  • CQL 与 Lucene 语法的核心区别

  • SQL 分析语法(管道符、FROM 省略、引号规则等)

  • histogram(时间分桶)、time_series(时序补全)、compare(同环比)等 CLS 扩展函数

  • IP 地理函数、百分位数函数等特殊函数

  • 时区处理规则、脏数据处理、类型转换等关键注意事项

调用此工具不需要任何参数。

ParametersJSON Schema
NameRequiredDescriptionDefault

No parameters

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

A4.7/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description carries the full burden. It discloses key behavioral traits: it returns a complete syntax reference document, lists specific content included (e.g., CQL retrieval syntax, SQL analysis syntax, CLS extension functions), and states '调用此工具不需要任何参数' (no parameters needed for calling this tool). However, it doesn't mention response format, size, or potential rate limits, leaving some behavioral aspects unspecified.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is well-structured and appropriately sized. It starts with a clear purpose and usage guideline, followed by a bulleted list of content included, and ends with the parameter note. Every sentence earns its place by providing essential information without redundancy, making it easy to scan and understand.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's complexity (providing syntax documentation), the description is complete. It details what the tool returns (a comprehensive reference with specific sections), when to use it, and that no parameters are needed. With an output schema present (as indicated by context signals), the description doesn't need to explain return values, and it adequately covers all necessary contextual aspects for a zero-parameter documentation tool.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The tool has 0 parameters, with schema description coverage at 100%. The description explicitly states '调用此工具不需要任何参数' (no parameters needed), which adds clarity beyond the empty schema. Since there are no parameters, the baseline is 4, and the description confirms this effectively.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description explicitly states the tool's purpose: '返回 CLS CQL 完整语法参考文档' (returns the complete CLS CQL syntax reference documentation). It distinguishes itself from sibling tools by specifying it's for CQL search syntax documentation, unlike cls_search_log (which executes queries) or other describe tools focused on alarms, dashboards, etc. The verb '返回' (return) and resource '参考文档' (reference documentation) are specific and clear.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides explicit guidance on when to use this tool: '当 cls_search_log 执行报错或不确定如何编写查询语句时使用' (use when cls_search_log execution errors or unsure how to write query statements). It names the alternative tool (cls_search_log) and specifies the context (error or uncertainty in query writing), offering clear when-to-use criteria that differentiate it from siblings.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

cls_describe_topic_detailA

获取日志主题详情。查看日志主题的完整配置信息。

参数说明

  • topic_id: 日志主题 ID(必填)

  • region: 地域(可选),如 ap-guangzhou、na-ashburn,不传则使用默认地域,可通过 cls_describe_regions 查询所有可用地域

ParametersJSON Schema
NameRequiredDescriptionDefault
topic_idYes
regionNo

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

A3.6/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description carries the full burden. It describes a read-only operation ('获取' - get, '查看' - view) without implying mutation, which is appropriate. However, it doesn't disclose behavioral traits such as authentication needs, rate limits, error handling, or what '完整配置信息' includes. The description adds basic context but misses key operational details that would help an agent use it correctly.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is well-structured with a clear purpose statement followed by a parameter section. It uses bullet points for parameters, making it easy to scan. Every sentence adds value: the first states the purpose, and the parameter explanations provide necessary context. It could be slightly more concise by integrating the parameter details more seamlessly, but overall it's efficient and front-loaded.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the context: 2 parameters, 0% schema coverage, no annotations, but an output schema exists. The description covers the purpose and parameters well, and since an output schema is present, it doesn't need to explain return values. It's complete enough for a read operation, though it could benefit from more behavioral transparency (e.g., error cases) to fully guide the agent.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The schema description coverage is 0%, so the description must compensate. It provides a parameter section explaining 'topic_id' as required and 'region' as optional with examples (e.g., 'ap-guangzhou') and references 'cls_describe_regions' for available values. This adds meaningful semantics beyond the bare schema, covering both parameters adequately. However, it doesn't detail format constraints or validation rules, keeping it from a perfect score.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool's purpose: '获取日志主题详情。查看日志主题的完整配置信息' (Get log topic details. View complete configuration information for a log topic). It specifies the verb ('获取' - get) and resource ('日志主题详情' - log topic details), making it easy to understand. However, it doesn't explicitly differentiate from sibling tools like 'cls_describe_topics' which might list topics rather than get details of a specific one.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implies usage by specifying that it retrieves '完整配置信息' (complete configuration information), suggesting it's for detailed views rather than summaries. It mentions an alternative tool 'cls_describe_regions' for querying available regions, but doesn't provide explicit guidance on when to use this tool versus other siblings like 'cls_describe_topics' or 'cls_describe_logsets'. The context is clear but lacks comprehensive alternatives or exclusions.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

cls_describe_topicsA

查询日志主题列表。日志主题是日志数据的基本存储单元。

参数说明

  • offset: 分页偏移量,默认 0

  • limit: 每页条数,默认 20

  • logset_id: 按日志集 ID 过滤(可选)

  • topic_name: 按日志主题名称过滤(可选,模糊匹配)

  • biz_type: 主题类型过滤(可选):0 表示日志主题,1 表示指标主题(时序数据主题)。不传则返回所有类型。当需要查询指标主题时,请传入 biz_type=1

  • region: 地域(可选),如 ap-guangzhou、na-ashburn,不传则使用默认地域,可通过 cls_describe_regions 查询所有可用地域

返回信息

  • 日志主题 ID、名称、所属日志集

  • 主题类型(日志主题/指标主题)

  • 存储类型、保存周期、分区数

  • 采集和索引状态

ParametersJSON Schema
NameRequiredDescriptionDefault
offsetNo
limitNo
logset_idNo
topic_nameNo
biz_typeNo
regionNo

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

A4/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries the full burden of behavioral disclosure. It effectively describes the tool's behavior as a read-only query operation (implied by '查询'), includes pagination details (offset/limit defaults), filtering options, and region handling. It also outlines the return information structure, though it doesn't cover aspects like error conditions, rate limits, or authentication needs, which keeps it from a perfect score.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is well-structured with clear sections (purpose, parameter explanations, return info) and uses bullet points for readability. It is appropriately sized, though the parameter section is lengthy due to covering all parameters—this is necessary given the lack of schema descriptions, so it earns its place without being wasteful.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a query tool with 6 parameters, 0% schema coverage, no annotations, but an output schema, the description is quite complete. It explains the tool's purpose, all parameters in detail, and the return information. The output schema likely covers return values, so the description doesn't need to duplicate that. Minor gaps include lack of error handling or explicit sibling tool comparisons, but overall it provides sufficient context for effective use.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Given 0% schema description coverage, the description fully compensates by providing detailed semantic explanations for all 6 parameters. It clarifies defaults (e.g., offset=0, limit=20), optionality, filtering logic (e.g., fuzzy matching for topic_name), enum values for biz_type (0 for log topics, 1 for metric topics), and region usage with a reference to another tool. This adds significant value beyond the bare schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool's purpose as '查询日志主题列表' (query log topic list) and explains that log topics are basic storage units for log data. This provides a specific verb ('query') and resource ('log topic list'), though it doesn't explicitly differentiate from sibling tools like 'cls_describe_logsets' or 'cls_describe_topic_detail' beyond the resource type.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides some implied usage guidance through parameter explanations (e.g., '当需要查询指标主题时,请传入 biz_type=1' for querying metric topics, and mentioning 'cls_describe_regions' for available regions). However, it lacks explicit when-to-use vs. alternatives (e.g., compared to 'cls_describe_topic_detail' for detailed info) or prerequisites, leaving room for improvement.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

cls_get_alarm_detailA

通过告警详情URL获取CLS告警的详细信息。从腾讯云告警详情URL中提取和解析告警信息,支持短链接和长链接格式。 该工具会自动解析URL、获取告警详情,并返回格式化的Markdown文档。

两种查询方式(二选一)

方式一:通过 URL 查询

  • 传入 url 参数(短链接或长链接),工具自动解析并获取告警详情

方式二:通过 record_id + region 查询

  • 传入 record_id 和 region 参数,工具直接构造 API 请求获取告警详情

  • 这两个参数可从 cls_describe_alarm_records 工具的返回结果中获取

参数说明

  • url: 告警详情 URL(可选),与 record_id+region 二选一

  • record_id: 告警记录 ID(可选),从 cls_describe_alarm_records 获取

  • region: 地域标识(可选),如 ap-guangzhou、ap-shanghai,从 cls_describe_alarm_records 获取

支持的URL格式

  1. 短链接:https://alarm.cls.tencentcs.com/WeNZ5sSP

  2. 短链接:https://mc.tencent.com/xxx

  3. 长链接:https://ap-guangzhou-open-monitor.cls.tencentcs.com/cls_no_login?action=GetAlertDetailPage#/alert?RecordId=xxx

返回内容

  • ⚠️ 告警基本信息(名称、ID、级别、地域)

  • 🔍 告警详细数据(监控对象、触发时间、持续时间、触发条件、当前值)

  • 📝 触发语句(CQL/SQL 查询)

  • 📊 多维分析结果(如有)

  • 💬 告警通知内容

  • 🔗 相关链接(详情页、日志查询、认领)

应用场景

  1. 快速查看告警详情:直接粘贴告警通知中的URL即可获取完整信息

  2. 从告警记录列表查看详情:先用 cls_describe_alarm_records 获取 record_id 和 region,再调用本工具

  3. 告警问题排查:查看告警触发条件、触发值、查询语句等关键信息

注意事项

  • url 与 record_id+region 二选一,不能同时提供或同时为空

  • 短链接会自动跳转到长链接进行解析

  • 此接口为免密接口,无需额外认证信息

ParametersJSON Schema
NameRequiredDescriptionDefault
urlNo
record_idNo
regionNo

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

A4.7/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries the full burden of behavioral disclosure. It effectively describes key behaviors: the tool automatically parses URLs and returns formatted Markdown, supports both short and long URL formats, short links automatically redirect to long links for parsing, and it's a '免密接口' (password-free interface) requiring no additional authentication. However, it doesn't mention rate limits, error handling, or performance characteristics.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is well-structured with clear sections (query methods, parameter explanation, URL formats, return content, application scenarios, notes) but could be more concise. Some information is repeated (e.g., the mutual exclusivity rule appears in multiple sections), and the Markdown formatting adds visual clarity but also length. Most sentences earn their place by providing distinct value.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's complexity (3 parameters with mutual exclusivity rules, multiple input formats, rich output) and the presence of an output schema, the description is remarkably complete. It covers all input methods, parameter semantics, URL formats, detailed return content structure, application scenarios, and important behavioral notes. The output schema existence means the description doesn't need to explain return values in technical detail.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

With 0% schema description coverage (titles only provide parameter names), the description fully compensates by providing comprehensive parameter semantics. It explains that 'url' accepts both short and long link formats, 'record_id' comes from cls_describe_alarm_records results, and 'region' is a geographic identifier with examples like 'ap-guangzhou'. It also clarifies the mutual exclusivity rule between parameter groups.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool's purpose: '通过告警详情URL获取CLS告警的详细信息' (get detailed information about CLS alarms through alarm detail URLs). It specifies the verb ('获取' - get/retrieve) and resource ('CLS告警的详细信息' - CLS alarm details), and distinguishes from siblings like cls_describe_alarm_records (which lists alarms) by focusing on retrieving detailed information for specific alarms.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides explicit guidance on when to use this tool vs alternatives. It outlines two query methods (URL-based vs record_id+region), explains that record_id and region can be obtained from cls_describe_alarm_records, and specifies application scenarios including '快速查看告警详情' (quickly view alarm details) and '从告警记录列表查看详情' (view details from alarm record list). It also explicitly states 'url 与 record_id+region 二选一' (choose one between url and record_id+region).

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

cls_get_log_contextA

获取日志上下文。根据一条日志的定位信息,查看其前后的日志记录,用于排查问题时了解完整的日志上下文。

参数说明

  • topic_id: 日志主题 ID(必填)

  • btime: 目标日志的时间(字符串),支持两种格式:

    1. 毫秒时间戳字符串(如 "1774537847429"):工具内部自动按 UTC+8 时区转换为所需格式,可直接使用 cls_search_log 返回的"时间(Time)"对应的毫秒时间戳

    2. UTC+8 时间字符串 YYYY-mm-dd HH:MM:SS.FFF(如 "2026-03-25 14:25:00.000"):需确保为 UTC+8 时区

  • pkg_id: 目标日志的包序号(从 cls_search_log 返回的 PkgId 字段获取)

  • pkg_log_id: 目标日志在包内的序号(从 cls_search_log 返回的 PkgLogId 字段获取)

  • prev_logs: 向前获取的日志条数,默认 10,最大 100

  • next_logs: 向后获取的日志条数,默认 10,最大 100

使用流程

  1. 先用 cls_search_log 查找目标日志

  2. 从结果中获取 PkgId、PkgLogId,以及"时间"对应的毫秒时间戳(或自行构造 UTC+8 时间字符串)

  3. 用这些信息调用本工具获取上下文

注意事项

  • btime 的时间字符串必须为 UTC+8 时区

  • 传入毫秒时间戳字符串时,工具会自动按 UTC+8 转换,无需手动处理时区

  • 毫秒精度会影响定位准确性,建议尽量使用精确的时间值

  • region: 地域(可选),如 ap-guangzhou、na-ashburn,不传则使用默认地域,可通过 cls_describe_regions 查询所有可用地域

ParametersJSON Schema
NameRequiredDescriptionDefault
topic_idYes
btimeYes
pkg_idYes
pkg_log_idYes
prev_logsNo
next_logsNo
regionNo

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

A4.7/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries the full burden of behavioral disclosure. It effectively describes key behaviors: it's a read operation (获取/查看 - get/view), specifies constraints (prev_logs/next_logs defaults and maximums of 10/100), explains timezone handling (UTC+8 conversion for timestamps, must use UTC+8 for strings), mentions accuracy considerations (millisecond precision affects accuracy), and notes optional parameters with defaults. It doesn't cover rate limits or authentication needs, but provides substantial operational context.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is well-structured with clear sections (purpose, parameter说明, 使用流程, 注意事项) and front-loaded purpose. It's appropriately sized for a 7-parameter tool with complex usage. Some sentences could be slightly tightened (e.g., the region note is a bit verbose), but overall it's efficient with minimal waste.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's complexity (7 parameters, 4 required, no schema descriptions, no annotations) and the presence of an output schema (which handles return values), the description is highly complete. It covers purpose, detailed parameter semantics, usage workflow, prerequisites, alternatives, constraints, and operational notes. The only minor gap is lack of explicit authentication/rate limit info, but this is compensated by the comprehensive parameter and usage guidance.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0%, so the description must fully compensate. It provides detailed semantic information for all 7 parameters: explains required vs. optional, sources for values (e.g., from cls_search_log results), formats (two time string formats, integer IDs), defaults (prev_logs=10, next_logs=10, region=''), constraints (max 100), and practical usage notes (timezone handling, precision advice). This goes well beyond what the bare schema titles offer.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool's purpose: '获取日志上下文。根据一条日志的定位信息,查看其前后的日志记录,用于排查问题时了解完整的日志上下文' (Get log context. Based on a log's positioning information, view logs before and after it, used to understand the complete log context when troubleshooting problems). This is specific (verb: get/view, resource: log context), distinguishes it from siblings like cls_search_log (which finds logs) and cls_get_log_count (which counts logs), and explains the value (troubleshooting).

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides explicit guidance on when and how to use this tool versus alternatives. It specifies a clear workflow: '1. 先用 cls_search_log 查找目标日志 2. 从结果中获取... 3. 用这些信息调用本工具' (1. First use cls_search_log to find the target log 2. Get... from the results 3. Use this information to call this tool). It also mentions an alternative tool for region queries (cls_describe_regions) and clarifies that region is optional with a default.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

cls_get_log_countA

快速获取日志数量。相比 cls_search_log 更快,适合只需要知道日志总数的场景。

参数说明

  • topic_id: 日志主题 ID(必填)。格式不固定,可能是 UUID(如 550b584b-xxxx)或自定义字符串。当用户提供的值不确定是 ID 还是名称时,优先当作 topic_id 直接使用;如果报错(如"主题不存在"),再通过 cls_describe_topics 按名称搜索获取正确的 topic_id

  • query: CQL 检索语句(必填)

  • start_time: 起始时间,Unix 时间戳(毫秒)

  • end_time: 结束时间,Unix 时间戳(毫秒)

  • region: 地域(可选),如 ap-guangzhou、na-ashburn,不传则使用默认地域,可通过 cls_describe_regions 查询所有可用地域

适用场景

  • 快速确认某类日志是否存在

  • 统计特定时间范围内的日志总量

注意事项

  • start_time/end_time 为毫秒时间戳,请先调用 cls_convert_time 工具转换,不要手动计算

  • 💡 编写 SQL 分析语句前,建议先调用 cls_describe_index 获取目标主题的索引配置,确认字段名称、类型及是否开启统计,避免因字段信息不明确导致查询失败

ParametersJSON Schema
NameRequiredDescriptionDefault
topic_idYes
queryYes
start_timeYes
end_timeYes
regionNo

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

A4.7/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries full burden and does well. It discloses important behavioral traits: performance characteristics (faster than cls_search_log), prerequisite tools (cls_convert_time for timestamp conversion, cls_describe_index for SQL preparation), and error handling guidance for topic_id. It doesn't mention rate limits or authentication needs, but covers substantial operational context.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is well-structured with clear sections (参数说明, 适用场景, 注意事项) and uses emphasis (⏰, 💡) effectively. While comprehensive, it maintains focus with each sentence adding value. Some redundancy exists in parameter explanations, but overall it's efficiently organized.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's complexity (5 parameters, 0% schema coverage, no annotations) and presence of output schema, the description is remarkably complete. It covers purpose, usage guidelines, parameter details, prerequisite tools, error handling, and operational constraints. The output schema existence means return values don't need explanation, allowing focus on invocation context.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

With 0% schema description coverage, the description fully compensates by providing rich parameter semantics. It explains each parameter's purpose, format constraints (UUID or custom string for topic_id, Unix timestamp in milliseconds for time fields), optionality, and practical usage guidance including fallback strategies for topic_id resolution and region defaults.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool's purpose: '快速获取日志数量' (quickly get log count). It distinguishes from sibling cls_search_log by noting it's faster and suitable for scenarios where only the total count is needed. This provides specific verb+resource and sibling differentiation.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description explicitly states when to use this tool ('适合只需要知道日志总数的场景' - suitable for scenarios where only total count is needed) and when to use alternatives ('相比 cls_search_log 更快' - faster than cls_search_log). It also provides specific usage scenarios like confirming log existence and counting logs in time ranges.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

cls_get_log_histogramA

获取日志数量直方图。统计指定时间范围内日志在时间维度上的分布情况,用于观察日志量趋势和异常波动。

参数说明

  • topic_id: 日志主题 ID(必填)

  • query: CQL 检索语句(必填),如 level:ERROR*(全部日志)

  • start_time: 起始时间,Unix 时间戳(毫秒)

  • end_time: 结束时间,Unix 时间戳(毫秒)

  • interval: 时间间隔(毫秒),系统会自动选择合适间隔,也可手动指定

适用场景

  • 观察日志量随时间的变化趋势

  • 发现某个时间段的日志突增或突降

  • 结合 cls_search_log 定位具体异常时段

注意事项

  • start_time/end_time 为毫秒时间戳,请先调用 cls_convert_time 工具转换,不要手动计算

  • 💡 编写 SQL 分析语句前,建议先调用 cls_describe_index 获取目标主题的索引配置,确认字段名称、类型及是否开启统计,避免因字段信息不明确导致查询失败

  • region: 地域(可选),如 ap-guangzhou、na-ashburn,不传则使用默认地域,可通过 cls_describe_regions 查询所有可用地域

ParametersJSON Schema
NameRequiredDescriptionDefault
topic_idYes
queryYes
start_timeYes
end_timeYes
intervalNo
regionNo

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

A4.6/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description carries the full burden. It discloses important behavioral traits: the tool is for statistical analysis (not destructive), requires specific time format handling (millisecond Unix timestamps), and suggests prerequisites like calling cls_convert_time for time conversion and cls_describe_index for field validation. However, it doesn't mention rate limits, authentication needs, or pagination behavior, leaving some gaps.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is well-structured with clear sections (purpose, parameters, scenarios, notes) and uses bullet points for readability. It's appropriately sized but could be slightly more concise in the notes section. Every sentence adds value, such as the warning about time conversion and suggestions for related tools.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the complexity (6 parameters, no annotations, but has output schema), the description is mostly complete. It covers purpose, parameters, usage scenarios, and prerequisites. Since an output schema exists, it doesn't need to explain return values. However, it lacks details on error handling or performance considerations, which could be useful for a tool with multiple parameters and dependencies.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

With 0% schema description coverage, the description fully compensates by providing detailed parameter semantics in the '参数说明' (Parameter explanation) section. It explains each parameter's purpose, required status, format (e.g., 'CQL 检索语句' - CQL query statement, Unix timestamp in milliseconds), and practical examples (e.g., query: 'level:ERROR' or '*'). This adds significant value beyond the bare schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool's purpose: '获取日志数量直方图。统计指定时间范围内日志在时间维度上的分布情况,用于观察日志量趋势和异常波动' (Get log count histogram. Count log distribution across time within a specified range, used to observe log volume trends and abnormal fluctuations). It specifies the verb ('获取' - get), resource ('日志数量直方图' - log count histogram), and distinguishes it from siblings like cls_search_log (for detailed logs) and cls_get_log_count (for total count).

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description explicitly provides usage guidelines in the '适用场景' (Applicable scenarios) section: observing log volume trends over time, detecting sudden increases or decreases, and combining with cls_search_log to locate specific abnormal periods. It also mentions when not to use it (e.g., for detailed logs, use cls_search_log instead). This gives clear context for when to choose this tool over alternatives.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

cls_list_metricsA

列出指标主题下的所有指标名称。用于在查询指标前了解有哪些可用指标。

参数说明

  • topic_id: 指标主题 ID(必填),注意是时序指标主题 ID,非普通日志主题 ID

  • start_time: 起始时间,Unix 时间戳(秒)

  • end_time: 结束时间,Unix 时间戳(秒)

  • region: 地域(可选),如 ap-guangzhou、na-ashburn,不传则使用默认地域,可通过 cls_describe_regions 查询所有可用地域

使用场景

  • 在使用 cls_query_metric / cls_query_range_metric 查询指标前,先列出可用指标

  • 了解某个指标主题下上报了哪些指标

注意事项

  • start_time/end_time 为秒级时间戳,请先调用 cls_convert_time 工具转换,不要手动计算

  • 返回的是指定时间范围内有数据的指标名称,建议查询最近 15 分钟即可

ParametersJSON Schema
NameRequiredDescriptionDefault
topic_idYes
start_timeYes
end_timeYes
regionNo

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

A4.8/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries the full burden of behavioral disclosure. It effectively describes key behavioral traits: the tool returns metric names that have data within the specified time range, recommends querying the last 15 minutes for practical use, and warns about time format requirements (seconds, not milliseconds). However, it doesn't mention pagination, rate limits, or authentication requirements.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is well-structured with clear sections (purpose, parameters, usage scenarios, notes), front-loaded with the core purpose, and every sentence adds value. The bullet points make it scannable, and there's no redundant information. The warning about time conversion is appropriately emphasized with emoji and bold formatting.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool has an output schema (which handles return values), no annotations, and 4 parameters with 0% schema coverage, the description provides excellent contextual completeness. It covers purpose, parameters, usage guidelines, behavioral constraints, and references to related tools. The time format warning and practical recommendation (query last 15 minutes) add important operational context.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

With 0% schema description coverage, the description fully compensates by providing detailed parameter semantics in the '参数说明' section. It explains each parameter's purpose, requirements (必填 for required), format constraints (Unix timestamp in seconds), default behavior (region defaults if not provided), and provides examples (ap-guangzhou, na-ashburn). The warning about time conversion is particularly valuable.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool's purpose with specific verbs ('列出' meaning 'list') and resources ('指标名称' meaning 'metric names'), and distinguishes it from siblings by explaining it's used before querying metrics with cls_query_metric/cls_query_range_metric. It explicitly differentiates from logging topics by specifying '时序指标主题 ID, 非普通日志主题 ID'.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides explicit usage guidelines in the '使用场景' section, stating when to use this tool (before querying metrics with cls_query_metric/cls_query_range_metric, to understand available metrics) and when not to use it (not for logging topics). It also mentions an alternative tool (cls_convert_time for time conversion) and references cls_describe_regions for region information.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

cls_query_metricA

查询 CLS 指标数据(单时间点)。支持 PromQL 兼容查询语法,获取某一时刻的指标值。

参数说明

  • topic_id: 指标主题 ID(必填),注意是时序指标主题 ID,非普通日志主题 ID

  • query: 指标查询语句(必填),PromQL 兼容语法

  • time: 查询时间点,Unix 时间戳(秒),默认当前时间

  • region: 地域(可选),如 ap-guangzhou、na-ashburn,不传则使用默认地域,可通过 cls_describe_regions 查询所有可用地域

PromQL 示例

  • metric_name — 查询单个指标当前值

  • rate(metric_name[5m]) — 5 分钟速率

  • sum(metric_name) by (label) — 按标签汇总

  • topk(5, metric_name) — 取 Top 5

注意事项

  • time 为秒级时间戳,请先调用 cls_convert_time 工具转换,不要手动计算

ParametersJSON Schema
NameRequiredDescriptionDefault
topic_idYes
queryYes
timeNo
regionNo

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

A4.7/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries the full burden of behavioral disclosure. It effectively describes key behavioral traits: the tool queries metric data (not logs), supports PromQL-compatible syntax, returns values at a specific time point, and has region-specific behavior. It also provides important operational guidance about time conversion. The only minor gap is lack of explicit mention about authentication or rate limits.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is well-structured with clear sections (purpose, parameters, examples, notes) and efficiently conveys necessary information. Every sentence adds value, though the PromQL examples section could be slightly more concise. The structure is front-loaded with the core purpose, followed by detailed supporting information.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's complexity (metric querying with PromQL), 0% schema coverage, no annotations, but with an output schema present, the description provides excellent completeness. It covers purpose, parameters with semantics, usage examples, important operational notes, and references to related tools. The output schema existence means the description doesn't need to explain return values, allowing it to focus on usage context.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

With 0% schema description coverage, the description fully compensates by providing comprehensive parameter semantics. It explains all four parameters in detail: topic_id (required metric topic ID, not log topic), query (required PromQL syntax), time (optional Unix timestamp in seconds, default current time), and region (optional, with examples). It also provides PromQL examples that clarify the query parameter usage beyond basic schema information.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool's purpose: '查询 CLS 指标数据(单时间点)' (query CLS metric data at a single time point). It specifies the verb '查询' (query) and resource 'CLS 指标数据' (CLS metric data), and distinguishes it from sibling tools like cls_query_range_metric by emphasizing '单时间点' (single time point). This provides specific differentiation from alternatives.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides explicit usage guidance. It states when to use this tool (for single-time-point metric queries with PromQL syntax) and when not to (implied by distinguishing from range queries). It also names alternatives: cls_convert_time for time conversion and cls_describe_regions for region lookup, creating clear contextual boundaries.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

cls_query_range_metricA

查询 CLS 指标数据(时间范围)。支持 PromQL 兼容查询语法,获取一段时间内的指标变化趋势。

参数说明

  • topic_id: 指标主题 ID(必填),注意是时序指标主题 ID,非普通日志主题 ID。格式不固定,可能是 UUID 或自定义字符串。当用户提供的值不确定是 ID 还是名称时,优先当作 topic_id 直接使用;如果报错,再通过 cls_describe_topics(biz_type=1) 按名称搜索获取正确的指标主题 ID

  • query: 指标查询语句(必填),PromQL 兼容语法

  • start_time: 起始时间,Unix 时间戳(秒)

  • end_time: 结束时间,Unix 时间戳(秒)

  • step: 步长(秒),数据点之间的间隔,默认 60

  • region: 地域(可选),如 ap-guangzhou、na-ashburn,不传则使用默认地域,可通过 cls_describe_regions 查询所有可用地域

适用场景

  • 查看指标随时间的变化趋势

  • 告警前查看历史指标走势

  • 对比不同时间段的指标数据

注意事项

  • start_time/end_time 为秒级时间戳,请先调用 cls_convert_time 工具转换,不要手动计算

ParametersJSON Schema
NameRequiredDescriptionDefault
topic_idYes
queryYes
start_timeYes
end_timeYes
stepNo
regionNo

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

A4.7/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries the full burden of behavioral disclosure. It effectively describes key behaviors: it supports PromQL-compatible query syntax, returns metric trends over time, requires specific topic_id format (time-series metric topic ID, not log topic ID), and has region defaults. It also mentions error handling for topic_id. However, it doesn't cover rate limits, authentication needs, or pagination behavior, leaving some gaps.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is well-structured with clear sections (purpose, parameters, scenarios, notes). It's appropriately sized for a 6-parameter tool with no annotations. Every sentence adds value, though the parameter section is detailed, which is necessary given the 0% schema coverage. It could be slightly more front-loaded by moving the purpose statement to the very beginning.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the complexity (6 parameters, 0% schema coverage, no annotations, but with output schema), the description is remarkably complete. It covers purpose, all parameters with semantics, usage scenarios, critical notes, and references to sibling tools. The presence of an output schema means the description doesn't need to explain return values. This provides everything needed for effective tool selection and invocation.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The schema description coverage is 0%, so the description must fully compensate. It provides detailed parameter semantics in the '参数说明' section, explaining each of the 6 parameters with purpose, format, requirements, defaults, and practical usage notes (e.g., topic_id format ambiguity resolution, time conversion requirement). This adds substantial value beyond the bare schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool's purpose: '查询 CLS 指标数据(时间范围)' (query CLS metric data with time range). It specifies the verb (query), resource (CLS metric data), and scope (time range). It distinguishes from sibling tools like cls_query_metric (which likely doesn't have time range) and cls_search_log (which handles logs not metrics).

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides explicit usage guidance in the '适用场景' (applicable scenarios) section, listing three specific use cases. It also includes '注意事项' (notes) with critical instructions about time conversion, explicitly naming the alternative tool cls_convert_time. This gives clear when-to-use and when-not-to-use guidance.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

cls_search_logA

检索分析 CLS 日志。支持 CQL 检索和 SQL 管道分析。

CQL 语法速查

CQL (CLS Query Language) 是 CLS 自研的检索分析语法,语句结构为:[检索条件] | [SQL 语句]。 检索条件用于过滤日志,SQL 用于统计分析。不需要分析时可省略 | 及 SQL 部分。

检索语法

  • 键值检索: status:404level:ERROR(字段值包含该词)

  • 全文检索: errortimeout(全文中包含该词)

  • 短语检索: "connection timeout"'user_name:"bob"'(精确短语,支持通配符如 "/var/log/acc*.log"

  • 逻辑操作符: ANDORNOT(不区分大小写,AND 优先级高于 OR)

  • 分组: level:(ERROR OR WARNING) AND pid:1234

  • 数值比较: status:>400status:>=400status:=200latency:<100

  • 模糊匹配: host:www.test*.com* 匹配零到多个字符,不支持前缀模糊如 *test

  • 字段存在性: key:*(字段存在)、key:""(字段存在但值为空)

  • 转义: body:user_name\:bob(特殊字符用 \ 转义)

SQL 分析(检索条件 | SQL,无需 FROM 和分号)

  • 字符串用单引号 '',字段名冲突用双引号 ""

  • * | SELECT COUNT(*) AS total

  • * | SELECT status, COUNT(*) AS cnt GROUP BY status ORDER BY cnt DESC

  • 默认返回 100 行,LIMIT 最大 100 万行

CLS 扩展函数

  • histogram(时间分桶): histogram(__TIMESTAMP__, interval 1 hour) — 直接传 LONG 型,自动 UTC+8

  • time_series(时序补全): time_series(__TIMESTAMP__, '5m', '%Y-%m-%d %H:%i:%s', '0') — 必须 GROUP BY + ORDER BY,不支持 DESC,分钟用 %i

  • compare(同环比): compare(count(*), 86400) — 返回数组下标从 1 开始,86400=日/604800=周

  • IP 地理: ip_to_province/city/country/provider(ip)

  • 百分位: APPROX_PERCENTILE(field, 0.99)

关键注意

  • CQL 是 CLS 推荐语法(SyntaxRule=1),相比 Lucene 更简便,特殊字符限制更少

  • CQL 中多个分词默认为 AND 关系(Lucene 默认为 OR)

  • __TIMESTAMP__ 是 bigint 毫秒时间戳,from_unixtime 要除 1000

  • 脏数据用 try_cast 代替 cast

  • 时区:histogram/time_series 传 LONG 型自动 UTC+8,其他日期函数默认 UTC+0,需手动加 8 小时

参数说明

  • topic_id: 日志主题 ID(必填)

  • query: CQL 检索语句(必填),如 level:ERROR* | SELECT COUNT(*) as cnt

  • start_time: 起始时间,Unix 时间戳(毫秒)

  • end_time: 结束时间,Unix 时间戳(毫秒)

  • limit: 返回条数,默认 100,最大 1000(仅对原始日志有效,SQL 分析不受此限制)

  • context: 翻页游标,首次查询无需传入,从上次返回结果获取

  • sort: 排序方式,asc(升序)或 desc(降序,默认)

注意事项

  • start_time/end_time 为毫秒时间戳,请先调用 cls_convert_time 工具转换,不要手动计算

  • 💡 编写 SQL 分析语句前,建议先调用 cls_describe_index 获取索引配置,确认字段名称和类型

  • CQL 执行报错时,可调用 cls_describe_search_syntax 获取 CLS 完整扩展语法参考文档

  • region: 地域(可选),如 ap-guangzhou、na-ashburn,不传则使用默认地域

ParametersJSON Schema
NameRequiredDescriptionDefault
topic_idYes
queryYes
start_timeYes
end_timeYes
limitNo
contextNo
sortNodesc
regionNo

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

A4.6/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries full burden and does an excellent job disclosing behavioral traits: it explains the CQL/SQL syntax, default return limits (100 rows, max 1M for SQL), pagination via context parameter, timezone handling (UTC+8 vs UTC+0), error handling recommendations, and regional defaults. The only minor gap is lack of explicit rate limit or authentication requirements.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is comprehensive but overly long (500+ words) with extensive syntax documentation that might be better in separate reference tools. While well-structured with clear sections, it includes implementation details like CQL syntax examples and SQL function references that exceed what's needed for tool selection. Some content could be moved to cls_describe_search_syntax.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's complexity (8 parameters, no annotations, rich functionality) and presence of an output schema, the description is remarkably complete. It covers purpose, usage guidelines, parameter semantics, behavioral traits, error handling, and sibling tool relationships. The output schema existence means return values don't need explanation, and the description addresses all other aspects thoroughly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

With 0% schema description coverage, the description fully compensates by providing detailed parameter explanations in the '参数说明' section. It clarifies required vs optional parameters, default values (limit=100, sort=desc), format requirements (millisecond timestamps), and practical usage guidance (call cls_convert_time for timestamps). This adds substantial value beyond the bare schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool's purpose as '检索分析 CLS 日志' (search and analyze CLS logs) with specific mention of supporting both CQL retrieval and SQL pipeline analysis. It distinguishes itself from siblings like cls_describe_index and cls_describe_search_syntax by being the primary execution tool for log queries rather than metadata or syntax reference tools.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides explicit guidance on when to use this tool versus alternatives, including calling cls_convert_time for timestamp conversion, cls_describe_index for field verification before SQL analysis, and cls_describe_search_syntax for syntax reference when errors occur. It also distinguishes from siblings like cls_get_log_count and cls_get_log_histogram by being the comprehensive query tool.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections. Dates show when Glama detected each change.

  1. 24 tool updatesv0.3.4
    • First observedcls_convert_time
    • First observedcls_describe_alarm_detail
    • First observedcls_describe_alarm_notices
    • First observedcls_describe_alarm_records
    • First observedcls_describe_alarms
    • First observedcls_describe_dashboards
    • First observedcls_describe_data_transform_tasks
    • First observedcls_describe_index
    • First observedcls_describe_logsets
    • First observedcls_describe_machine_group_detail
    • First observedcls_describe_machine_groups
    • First observedcls_describe_regions
    • First observedcls_describe_scheduled_sql_tasks
    • First observedcls_describe_search_syntax
    • First observedcls_describe_topic_detail
    • First observedcls_describe_topics
    • First observedcls_get_alarm_detail
    • First observedcls_get_log_context
    • First observedcls_get_log_count
    • First observedcls_get_log_histogram
    • First observedcls_list_metrics
    • First observedcls_query_metric
    • First observedcls_query_range_metric
    • First observedcls_search_log

TDQS

A4/5.0
Disambiguation4/5

Most tools have distinct purposes targeting specific CLS resources like logs, alarms, metrics, or configurations, with clear boundaries. However, some potential confusion exists between cls_describe_alarm_detail and cls_get_alarm_detail, as both retrieve alarm details but through different mechanisms, which could lead to misselection if not carefully read.

Naming Consistency5/5

Tool names follow a highly consistent snake_case pattern with a 'cls_' prefix, using descriptive verbs like 'describe', 'get', 'search', 'list', 'query', and 'convert'. This uniformity makes the set predictable and easy to navigate, with no deviations in naming style across all 24 tools.

Tool Count3/5

With 24 tools, the count is on the higher side for a single server, bordering on heavy. While CLS is a comprehensive logging service, some tools like cls_describe_search_syntax (documentation) and cls_convert_time (utility) might be better integrated or reduced, making the surface feel slightly bloated but still manageable.

Completeness5/5

The tool set provides extensive coverage for CLS operations, including CRUD-like actions for logs, alarms, metrics, dashboards, and configurations. It supports full workflows from data ingestion to analysis, with no obvious gaps—tools for time conversion, syntax reference, and context retrieval fill critical needs, ensuring agents can handle most tasks without dead ends.

Maintenance

ActivityInactive
ResponsivenessSyncing

Resources

Unclaimed servers have limited discoverability.

Looking for Admin?

If you are the server author, to access and configure the admin panel.

Related MCP Connectors

Related MCP Servers

  • F
    license
    A
    quality
    B
    maintenance
    Provides tools for accessing Alibaba Cloud observability products including SLS (Log Service) and ARMS (Application Real-time Monitoring Service), allowing any MCP-compatible AI assistants to quickly interact with these services.
    9
    164
    -
  • A
    license
    A
    quality
    D
    maintenance
    Enables AI assistants to query and analyze Alibaba Cloud SLS logs using natural language, supporting multiple log sources like Function Compute and ECS. It provides tools for searching logs, performing SQL analysis, and visualizing log distributions directly within Cursor or Claude.
    6
    57
    10
    MIT
  • A
    license
    Not graded
    quality
    B
    maintenance
    Enables large language models to directly access Tencent Cloud Log Service for log search, metric queries, and alarm management without code.
    256
    11
    Apache 2.0

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/Tinker-LGD2026/cls-mcp-server'

If you have feedback or need assistance with the MCP directory API, please join our Discord server