Skip to main content

aliyun observability mcp server

Project description

阿里云可观测MCP服务

中文自述文件 英文自述文件

简介

git 阿里云可观测 MCP服务,提供了一系列访问阿里云可观测各产品的工具能力,覆盖产品包含阿里云日志服务SLS、阿里云云监控等,任意支持 MCP 协议的智能体助手都可快速接入。

目前提供的 MCP 工具以阿里云日志服务为主,其他产品会陆续支持,工具详细如下:

版本记录

可以查看 CHANGELOG.md

常见问题

可以查看 FAQ.md

工具列表

日志相关

工具名称 用途 关键参数 最佳实践
sls_list_projects 列出SLS项目,支持模糊搜索和分页 projectName:项目名称(可选,模糊搜索)
limit:返回项目数量上限(默认50,范围1-100)
regionId:阿里云区域ID
- 在不确定可用项目时,首先使用此工具
- 使用合理的limit值避免返回过多结果
sls_list_logstores 列出项目内的日志存储,支持名称模糊搜索 project:SLS项目名称(必需)
logStore:日志存储名称(可选,模糊搜索)
limit:返回结果数量上限(默认10)
isMetricStore:是否筛选指标存储
logStoreType:日志存储类型
regionId:阿里云区域ID
- 确定项目后使用此工具查找相关日志存储
- 可通过logStoreType筛选特定类型日志存储
sls_describe_logstore 检索日志存储的结构和索引信息 project:SLS项目名称(必需)
logStore:SLS日志存储名称(必需)
regionId:阿里云区域ID
- 在查询前使用此工具了解可用字段及其类型
- 检查所需字段是否启用了索引
sls_execute_sql_query 在指定时间范围内对日志存储执行SQL查询 project:SLS项目名称(必需)
logStore:SLS日志存储名称(必需)
query:SQL查询语句(必需)
fromTimestampInSeconds:查询开始时间戳(必需)
toTimestampInSeconds:查询结束时间戳(必需)
limit:返回结果数量上限(默认10)
regionId:阿里云区域ID
- 使用适当的时间范围优化查询性能
- 限制返回结果数量避免获取过多数据
sls_translate_text_to_sql_query 将自然语言描述转换为SLS SQL查询语句 text:查询的自然语言描述(必需)
project:SLS项目名称(必需)
logStore:SLS日志存储名称(必需)
regionId:阿里云区域ID
- 适用于不熟悉SQL语法的用户
- 对于复杂查询,可能需要优化生成的SQL
sls_diagnose_query 诊断SLS查询问题,提供失败原因分析 query:待诊断的SLS查询(必需)
errorMessage:查询失败的错误信息(必需)
project:SLS项目名称(必需)
logStore:SLS日志存储名称(必需)
regionId:阿里云区域ID
- 查询失败时使用此工具了解根本原因
- 根据诊断建议修改查询语句
指标相关
工具名称 用途 关键参数 最佳实践
cms_translate_text_to_promql 将自然语言描述转换为PromQL查询语句 text: 要转换的自然语言文本(必需)
project: SLS项目名称(必需)
metricStore: SLS指标存储名称(必需)
regionId: 阿里云区域ID(必需)
- 提供清晰、具体的指标描述
- 如已知,可在描述中提及特定的指标名称、标签或操作
- 排除项目或指标存储名称本身
- 检查并优化生成的查询以提高准确性和性能

权限要求

为了确保 MCP Server 能够成功访问和操作您的阿里云可观测性资源,您需要配置以下权限:

  1. 凭据配置

    • 服务使用默认凭据链进行登录,支持 Cloud SSO 等方式。
    • 请确保运行环境已正确配置阿里云凭据(如通过 aliyun configure 命令配置 Cloud SSO)。
  2. RAM 授权 (重要)

    • 关联的 RAM 用户或角色必须被授予访问相关云服务所需的权限。
    • 强烈建议遵循"最小权限原则":仅授予运行您计划使用的 MCP 工具所必需的最小权限集,以降低安全风险。
    • 根据您需要使用的工具,参考以下文档进行权限配置:
      • 日志服务 (SLS):如果您需要使用 sls_* 相关工具,请参考 日志服务权限说明,并授予必要的读取、查询等权限。
    • 特殊权限说明,如果使用了SQL生成之类的工具,需要单独授予sls:CallAiTools的权限
    • 请根据您的实际应用场景,精细化配置所需权限。

使用说明

在使用 MCP Server 之前,需要先配置阿里云凭据(推荐使用 Cloud SSO),请参考 默认凭据链

使用 uvx 安装运行

⚠️ 需要 Python 3.10 及以上版本,推荐使用 uv 作为包管理器。

  1. 使用 uvx 命令启动(可以指定版本号,会自动拉取对应依赖):
uvx --from 'alibabacloud-observability-cloud-sso-mcp==0.2.9' alibabacloud-observability-cloud-sso-mcp
  1. 使用 uvx 命令启动(默认最新版本):
uvx run alibabacloud-observability-cloud-sso-mcp

可通过命令行传递指定参数:

  • --log-level 指定日志级别,可选值为 DEBUGINFOWARNINGERROR,默认值为 INFO

从源码安装

# clone 源码
git clone git@github.com:aliyun/alibabacloud-observability-mcp-server.git
# 进入源码目录
cd alibabacloud-observability-mcp-server
# 安装依赖
uv sync
# 运行
uv run alibabacloud-observability-cloud-sso-mcp

AI 工具集成

Cursor,Cline 等集成

  1. 使用 stdio 启动方式 直接从源码目录启动,注意
    1. 需要指定 --directory 参数,指定源码目录,最好是绝对路径
    2. uv命令 最好也使用绝对路径,如果使用了虚拟环境,则需要使用虚拟环境的绝对路径
{
  "mcpServers": {
    "alibaba_cloud_observability": {
      "command": "uv",
      "args": [
        "--directory",
        "/path/to/your/alibabacloud-observability-mcp-server",
        "run",
        "alibabacloud-observability-cloud-sso-mcp"
      ]
    }
  }
}
  1. 使用 stdio 启动方式-从 module 启动
{
  "mcpServers": {
    "alibaba_cloud_observability": {
      "command": "uv",
      "args": [
        "run",
        "alibabacloud-observability-cloud-sso-mcp"
      ]
    }
  }
}

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file alibabacloud_observability_cloud_sso_mcp-0.2.9.tar.gz.

File metadata

File hashes

Hashes for alibabacloud_observability_cloud_sso_mcp-0.2.9.tar.gz
Algorithm Hash digest
SHA256 502a67496025be7a916711432c57d5a57d417478e9033a7d595ac3b4db62c2b6
MD5 f001afae6e2428bdcfce268169145d93
BLAKE2b-256 6ec6a8aedd2ee1ce6e10584895418ce2b316fc41f0e8432568af888f9a71e687

See more details on using hashes here.

File details

Details for the file alibabacloud_observability_cloud_sso_mcp-0.2.9-py3-none-any.whl.

File metadata

File hashes

Hashes for alibabacloud_observability_cloud_sso_mcp-0.2.9-py3-none-any.whl
Algorithm Hash digest
SHA256 f3260c8d360cd2e951808de070fe090c1f01121178a50af2fad18ab764c2212e
MD5 48fe93c651f7ddeaca6a860673f1b07c
BLAKE2b-256 911d5c06d7b4c7160b2c5a4915cfceb974d57d0638d4f13b43d94877ceaf0c3d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page