kxkaloo/alibabacloud-observability-mcp-server

sls_list_projects

列出阿里云日志服务中的所有项目。

        ## 功能概述

        该工具可以列出指定区域中的所有SLS项目，支持通过项目名进行模糊搜索。如果不提供项目名称，则返回该区域的所有项目。

        ## 使用场景

        - 当需要查找特定项目是否存在时
        - 当需要获取某个区域下所有可用的SLS项目列表时
        - 当需要根据项目名称的部分内容查找相关项目时

        ## 返回数据结构

        返回的项目信息包含：
        - project_name: 项目名称
        - description: 项目描述
        - region_id: 项目所在区域

        ## 查询示例

        - "有没有叫 XXX 的 project"
        - "列出所有SLS项目"

        Args:
            ctx: MCP上下文，用于访问SLS客户端
            projectName: 项目名称查询字符串，支持模糊搜索
            limit: 返回结果的最大数量，范围1-100，默认10
            regionId: 阿里云区域ID,region id format like "xx-xxx",like "cn-hangzhou"

        Returns:
            包含项目信息的字典列表，每个字典包含project_name、description和region_id
        

sls_list_logstores

列出SLS项目中的日志库。

        ## 功能概述

        该工具可以列出指定SLS项目中的所有日志库，如果不选，则默认为日志库类型
        支持通过日志库名称进行模糊搜索。如果不提供日志库名称，则返回项目中的所有日志库。

        ## 使用场景

        - 当需要查找特定项目下是否存在某个日志库时
        - 当需要获取项目中所有可用的日志库列表时
        - 当需要根据日志库名称的部分内容查找相关日志库时
        - 如果从上下文未指定 project参数，除非用户说了遍历，则可使用 sls_list_projects 工具获取项目列表

        ## 是否指标库

        如果需要查找指标或者时序相关的库,请将is_metric_store参数设置为True

        ## 查询示例

        - "我想查询有没有 XXX 的日志库"
        - "某个 project 有哪些 log store"

        Args:
            ctx: MCP上下文，用于访问SLS客户端
            project: SLS项目名称，必须精确匹配
            log_store: 日志库名称，支持模糊搜索
            limit: 返回结果的最大数量，范围1-100，默认10
            is_metric_store: 是否指标库，可选值为True或False，默认为False
            region_id: 阿里云区域ID

        Returns:
            日志库名称的字符串列表
        

sls_describe_logstore

获取SLS日志库的结构信息。

        ## 功能概述

        该工具用于获取指定SLS项目中日志库的索引信息和结构定义，包括字段类型、别名、是否大小写敏感等信息。

        ## 使用场景

        - 当需要了解日志库的字段结构时
        - 当需要获取日志库的索引配置信息时
        - 当构建查询语句前需要了解可用字段时
        - 当需要分析日志数据结构时

        ## 返回数据结构

        返回一个字典，键为字段名，值包含以下信息：
        - alias: 字段别名
        - sensitive: 是否大小写敏感
        - type: 字段类型
        - json_keys: JSON字段的子字段信息

        ## 查询示例

        - "我想查询 XXX 的日志库的 schema"
        - "我想查询 XXX 的日志库的 index"
        - "我想查询 XXX 的日志库的结构信息"

        Args:
            ctx: MCP上下文，用于访问SLS客户端
            project: SLS项目名称，必须精确匹配
            log_store: SLS日志库名称，必须精确匹配
            region_id: 阿里云区域ID

        Returns:
            包含日志库结构信息的字典
        

sls_execute_sql_query

执行SLS日志查询。

        ## 功能概述

        该工具用于在指定的SLS项目和日志库上执行查询语句，并返回查询结果。查询将在指定的时间范围内执行。 如果上下文没有提到具体的 SQL 语句，必须优先使用 sls_translate_text_to_sql_query 工具生成查询语句,无论问题有多简单

        ## 使用场景

        - 当需要根据特定条件查询日志数据时
        - 当需要分析特定时间范围内的日志信息时
        - 当需要检索日志中的特定事件或错误时
        - 当需要统计日志数据的聚合信息时


        ## 查询语法

        查询必须使用SLS有效的查询语法，而非自然语言。如果不了解日志库的结构，可以先使用sls_describe_logstore工具获取索引信息。

        ## 时间范围

        查询必须指定时间范围：  if the query is generated by sls_translate_text_to_sql_query tool, should use the fromTimestampInSeconds and toTimestampInSeconds in the sls_translate_text_to_sql_query response
        - fromTimestampInSeconds: 开始时间戳（秒）
        - toTimestampInSeconds: 结束时间戳（秒）

        ## 查询示例

        - "帮我查询下 XXX 的日志信息"
        - "查找最近一小时内的错误日志"

        ## 错误处理
        - Column xxx can not be resolved 如果是 sls_translate_text_to_sql_query 工具生成的查询语句 可能存在查询列未开启统计，可以提示用户增加相对应的信息，或者调用 sls_describe_logstore 工具获取索引信息之后，要用户选择正确的字段或者提示用户对列开启统计。当确定列开启统计之后，可以再次调用sls_translate_text_to_sql_query 工具生成查询语句

        Args:
            ctx: MCP上下文，用于访问SLS客户端
            project: SLS项目名称
            logStore: SLS日志库名称
            query: SLS查询语句
            fromTimestamp: 查询开始时间戳（秒）
            toTimestamp: 查询结束时间戳（秒）
            limit: 返回结果的最大数量，范围1-100，默认10
            regionId: 阿里云区域ID

        Returns:
            查询结果列表，每个元素为一条日志记录
        

sls_translate_text_to_sql_query

将自然语言转换为SLS查询语句。当用户有明确的 logstore 查询需求，必须优先使用该工具来生成查询语句

        ## 功能概述

        该工具可以将自然语言描述转换为有效的SLS查询语句，便于用户使用自然语言表达查询需求。用户有任何 SLS 日志查询需求时，都需要优先使用该工具。

        ## 使用场景

        - 当用户不熟悉SLS查询语法时
        - 当需要快速构建复杂查询时
        - 当需要从自然语言描述中提取查询意图时

        ## 使用限制

        - 仅支持生成SLS查询，不支持其他数据库的SQL如MySQL、PostgreSQL等
        - 生成的是查询语句，而非查询结果，需要配合sls_execute_query工具使用
        - 如果查询涉及ARMS应用，应优先使用arms_generate_trace_query工具
        - 需要对应的 log_sotre 已经设定了索引信息，如果生成的结果里面有字段没有索引或者开启统计，可能会导致查询失败，需要友好的提示用户增加相对应的索引信息

        ## 最佳实践

        - 提供清晰简洁的自然语言描述
        - 不要在描述中包含项目或日志库名称
        - 如有需要，指定查询的时间范围
        - 首次生成的查询可能不完全符合要求，可能需要多次尝试

        ## 查询示例

        - "帮我生成下 XXX 的日志查询语句"
        - "查找最近一小时内的错误日志"

        Args:
            ctx: MCP上下文，用于访问SLS客户端
            text: 用于生成查询的自然语言文本
            project: SLS项目名称
            log_store: SLS日志库名称
            region_id: 阿里云区域ID

        Returns:
            生成的SLS查询语句
        

sls_diagnose_query

诊断SLS查询语句。

        ## 功能概述

        当 SLS 查询语句执行失败时，可以调用该工具，根据错误信息，生成诊断结果。诊断结果会包含查询语句的正确性、性能分析、优化建议等信息。

        ## 使用场景

        - 当需要诊断SLS查询语句的正确性时
        - 当 SQL 执行错误需要查找原因时

        ## 查询示例

        - "帮我诊断下 XXX 的日志查询语句"
        - "帮我分析下 XXX 的日志查询语句"

        Args:
            ctx: MCP上下文，用于访问SLS客户端
            query: SLS查询语句
            error_message: 错误信息
            project: SLS项目名称
            log_store: SLS日志库名称
            region_id: 阿里云区域ID
        

sls_get_regions

获取阿里云的部分区域列表。

        ## 功能概述

        该工具用于获取阿里云的部分区域列表，便于在执行SLS查询时指定区域。

        ## 使用场景

        - 当需要获取阿里云的部分区域列表时
        - 当需要根据区域进行SLS查询时
        - 当用户没有明确指定区域ID 时，可以调用该工具获取区域列表，并要求用户进行选择

        ## 返回数据格式

        返回包含区域列表的字典，每个字典包含region_id和region_name。

        ## 查询示例

        - "获取阿里云的部分区域列表"
        

sls_get_current_time

获取当前时间。

        ## 功能概述
        1. 获取当前时间，会返回当前时间字符串和当前时间戳(毫秒)

        ## 使用场景
        1. 只有当无法从聊天记录里面获取到当前时间时候才可以调用该工具
        

arms_search_apps

搜索ARMS应用。

        ## 功能概述

        该工具用于根据应用名称搜索ARMS应用，返回应用的基本信息，包括应用名称、PID、用户ID和类型。

        ## 使用场景

        - 当需要查找特定名称的应用时
        - 当需要获取应用的PID以便进行其他ARMS操作时
        - 当需要检查用户拥有的应用列表时

        ## 搜索条件

        - app_name_query必须是应用名称的一部分，而非自然语言
        - 搜索结果将分页返回，可以指定页码和每页大小

        ## 返回数据结构

        返回一个字典，包含以下信息：
        - total: 符合条件的应用总数
        - page_size: 每页大小
        - page_number: 当前页码
        - trace_apps: 应用列表，每个应用包含app_name、pid、user_id和type

        ## 查询示例

        - "帮我查询下 XXX 的应用"
        - "找出名称包含'service'的应用"

        Args:
            ctx: MCP上下文，用于访问ARMS客户端
            app_name_query: 应用名称查询字符串
            region_id: 阿里云区域ID
            page_size: 每页大小，范围1-100，默认20
            page_number: 页码，默认1

        Returns:
            包含应用信息的字典
        

arms_generate_trace_query

生成ARMS应用的调用链查询语句。

        ## 功能概述

        该工具用于将自然语言描述转换为ARMS调用链查询语句，便于分析应用性能和问题。

        ## 使用场景

        - 当需要查询应用的调用链信息时
        - 当需要分析应用性能问题时
        - 当需要跟踪特定请求的执行路径时
        - 当需要分析服务间调用关系时

        ## 查询处理

        工具会将自然语言问题转换为SLS查询，并返回：
        - 生成的SLS查询语句
        - 存储调用链数据的项目名
        - 存储调用链数据的日志库名

        ## 查询上下文

        查询会考虑以下信息：
        - 应用的PID
        - 响应时间以纳秒存储，需转换为毫秒
        - 数据以span记录存储，查询耗时需要对符合条件的span进行求和
        - 服务相关信息使用serviceName字段
        - 如果用户明确提出要查询 trace信息，则需要在查询问题上question 上添加说明返回trace信息

        ## 查询示例

        - "帮我查询下 XXX 的 trace 信息"
        - "分析最近一小时内响应时间超过1秒的调用链"

        Args:
            ctx: MCP上下文，用于访问ARMS和SLS客户端
            user_id: 用户阿里云账号ID
            pid: 应用的PID
            region_id: 阿里云区域ID
            question: 查询调用链的自然语言问题

        Returns:
            包含查询信息的字典，包括sls_query、project和log_store
        

arms_profile_flame_analysis

分析ARMS应用火焰图性能热点。

        ## 功能概述

        当应用存在性能问题且开启持续剖析时，可以调用该工具对ARMS应用火焰图性能热点进行分析，生成分析结果。分析结果会包含火焰图的性能热点问题、优化建议等信息。

        ## 使用场景

        - 当需要分析ARMS应用火焰图性能问题时

        ## 查询示例

        - "帮我分析下ARMS应用 XXX 的火焰图性能热点"

        Args:
            ctx: MCP上下文，用于访问SLS客户端
            pid: ARMS应用监控服务PID
            startMs: 分析的开始时间，通过get_current_time工具获取毫秒级时间戳
            endMs: 分析的结束时间，通过get_current_time工具获取毫秒级时间戳
            profileType: Profile类型，用于选择需要分析的Profile指标，支持CPU热点和内存热点，如'cpu'、'memory'
            ip: ARMS应用服务主机地址，非必要参数，用于选择所在的服务机器，如有多个填写时以英文逗号","分隔，如'192.168.0.1,192.168.0.2'，不填写默认查询服务所在的所有IP
            thread: 服务线程名称，非必要参数，用于选择对应线程，如有多个填写时以英文逗号","分隔，如'C1 CompilerThre,C2 CompilerThre'，不填写默认查询服务所有线程
            threadGroup: 服务聚合线程组名称，非必要参数，用于选择对应线程组，如有多个填写时以英文逗号","分隔，如'http-nio-*-exec-*,http-nio-*-ClientPoller-*'，不填写默认查询服务所有聚合线程组
            regionId: 阿里云区域ID，如'cn-hangzhou'、'cn-shanghai'等
        

arms_diff_profile_flame_analysis

对比两个时间段火焰图的性能变化。

        ## 功能概述

        对应用在两个不同时间段内的性能进行分析，生成差分火焰图。通常用于发布前后或性能优化前后性能对比，帮助识别性能提升或退化。

        ## 使用场景

        - 发布前后、性能优化前后不同时间段火焰图性能对比

        ## 查询示例

        - "帮我分析应用 XXX 在发布前后的性能变化情况"

        Args:
            ctx: MCP上下文，用于访问SLS客户端
            pid: ARMS应用监控服务PID
            currentStartMs: 火焰图当前（基准）时间段的开始时间戳，通过get_current_time工具获取毫秒级时间戳
            currentEndMs: 火焰图当前（基准）时间段的结束时间戳，通过get_current_time工具获取毫秒级时间戳
            referenceStartMs: 火焰图对比时间段（参考时间段）的开始时间戳，通过get_current_time工具获取毫秒级时间戳
            referenceEndMs: 火焰图对比时间段（参考时间段）的结束时间戳，通过get_current_time工具获取毫秒级时间戳
            profileType: Profile类型，如'cpu'、'memory'
            ip: ARMS应用服务主机地址，非必要参数，用于选择所在的服务机器，如有多个填写时以英文逗号","分隔，如'192.168.0.1,192.168.0.2'，不填写默认查询服务所在的所有IP
            thread: 服务线程名称，非必要参数，用于选择对应线程，如有多个填写时以英文逗号","分隔，如'C1 CompilerThre,C2 CompilerThre'，不填写默认查询服务所有线程
            threadGroup: 服务聚合线程组名称，非必要参数，用于选择对应线程组，如有多个填写时以英文逗号","分隔，如'http-nio-*-exec-*,http-nio-*-ClientPoller-*'，不填写默认查询服务所有聚合线程组
            regionId: 阿里云区域ID，如'cn-hangzhou'、'cn-shanghai'等
        

arms_get_application_info

        根据 PID获取具体某个应用的信息，
        ## 功能概述
        1. 获取ARMS应用信息，会返回应用的 PID，AppName,开发语言类型比如 java,python 等
        
        ## 使用场景
        1. 当用户明确提出要查询某个应用的信息时，可以调用该工具
        2. 有场景需要获取应用的开发语言类型，可以调用该工具
        

arms_trace_quality_analysis

Trace 质量检测

        ## 功能概述
        识别指定 traceId 的 Trace 是否存在完整性问题（断链）和性能问题（错慢调用）

        ## 使用场景

        - 检测调用链是否存在问题

        ## 查询示例

        - "帮我分析调用链"

        Args:
            ctx: MCP上下文，用于访问SLS客户端
            traceId: 待分析的 Trace 的 traceId，必要参数
            startMs: 分析的开始时间，通过get_current_time工具获取毫秒级时间戳
            endMs: 分析的结束时间，通过get_current_time工具获取毫秒级时间戳
            regionId: 阿里云区域ID，如'cn-hangzhou'、'cn-shanghai'等
        

arms_slow_trace_analysis

深入分析 Trace 慢调用根因

        ## 功能概述

        针对 Trace 中的慢调用进行诊断分析，输出包含概述、根因、影响范围及解决方案的诊断报告。

        ## 使用场景

        - 性能问题定位和修复

        ## 查询示例

        - "请分析 ${traceId} 这个 trace 慢的原因"

        Args:
            ctx: MCP上下文，用于访问SLS客户端
            traceId: 待分析的Trace的 traceId，必要参数
            startMs: 分析的开始时间，通过get_current_time工具获取毫秒级时间戳
            endMs: 分析的结束时间，通过get_current_time工具获取毫秒级时间戳
            regionId: 阿里云区域ID，如'cn-hangzhou'、'cn-shanghai'等
        

arms_error_trace_analysis

深入分析 Trace 错误根因

        ## 功能概述

        针对 Trace 中的错误调用进行深入诊断分析，输出包含概述、根因、影响范围及解决方案的错误诊断报告。

        ## 使用场景

        - 性能问题定位和修复

        ## 查询示例

        - "请分析 ${traceId} 这个 trace 发生错误的原因"

        Args:
            ctx: MCP上下文，用于访问SLS客户端
            traceId: 待分析的Trace的 traceId，必要参数
            startMs: 分析的开始时间，通过get_current_time工具获取毫秒级时间戳
            endMs: 分析的结束时间，通过get_current_time工具获取毫秒级时间戳
            regionId: 阿里云区域ID，如'cn-hangzhou'、'cn-shanghai'等
        

cms_translate_text_to_promql

将自然语言转换为Prometheus PromQL查询语句。

        ## 功能概述

        该工具可以将自然语言描述转换为有效的PromQL查询语句，便于用户使用自然语言表达查询需求。

        ## 使用场景

        - 当用户不熟悉PromQL查询语法时
        - 当需要快速构建复杂查询时
        - 当需要从自然语言描述中提取查询意图时

        ## 使用限制

        - 仅支持生成PromQL查询
        - 生成的是查询语句，而非查询结果
        - 禁止使用sls_execute_query工具执行，两者接口不兼容

        ## 最佳实践

        - 提供清晰简洁的自然语言描述
        - 不要在描述中包含项目或时序库名称
        - 首次生成的查询可能不完全符合要求，可能需要多次尝试

        ## 查询示例

        - "帮我生成 XXX 的PromQL查询语句"
        - "查询每个namespace下的Pod数量"

        Args:
            ctx: MCP上下文，用于访问SLS客户端
            text: 用于生成查询的自然语言文本
            project: SLS项目名称
            metricStore: SLS时序库名称
            regionId: 阿里云区域ID

        Returns:
            生成的PromQL查询语句