Skip to content
Back to search

alibabacloud-observability-mcp-server

阿里云可观测 MCP Server(Go 版)

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today
Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/aliyun--alibabacloud-observability-mcp-server/badge.svg)](/listings/aliyun--alibabacloud-observability-mcp-server)

HTML

<a href="/listings/aliyun--alibabacloud-observability-mcp-server"><img src="/api/listings/aliyun--alibabacloud-observability-mcp-server/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

**方式一:npx skills add(推荐)**

由 [Vercel Labs](https://github.com/vercel-labs/skills) 维护的通用 skill 安装器,支持 69+ 种 coding agents:

# 全局安装(所有项目可用)
npx skills add aliyun/alibabacloud-observability-mcp-server

# 项目级安装(仅当前项目可用)
npx skills add aliyun/alibabacloud-observability-mcp-server --local

**方式二:curl(无需 Node.js)**

# 下载并安装 skill 到 ~/.claude/skills/
curl -fsSL https://raw.githubusercontent.com/aliyun/alibabacloud-observability-mcp-server/master/skills/deploy-observability/SKILL.md -o ~/.claude/skills/deploy-observability/SKILL.md

**方式三:从项目仓库复制**

如果你已经克隆了本项目:

# 全局安装
cp skills/deploy-observability/SKILL.md ~/.claude/skills/deploy-observability/

# 或项目级安装(在项目根目录下)
cp skills/deploy-observability/SKILL.md .claude/skills/deploy-observability/

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

README.md · README · 261 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

  1. # 阿里云可观测 MCP Server(Go 版)
  2. <p align="center">
  3. <a href="./README.md"><img alt="中文" src="https://img.shields.io/badge/简体中文-d9d9d9"></a>
  4. <a href="./README_EN.md"><img alt="English" src="https://img.shields.io/badge/English-d9d9d9"></a>
  5. </p>
  6. ---
  7. > **📌 重要提示**
  8. >
  9. > 本项目已使用 **Go 语言重构**。如需使用原 Python 版本,请访问 [`v1`](./v1) 目录:
  10. > - 📖 [v1/README.md](./v1/README.md) - Python 版本文档
  11. > - 📦 Python 版本通过 `pip install mcp-server-aliyun-observability` 安装
  12. ---
  13. 阿里云可观测 MCP Server 的 Go 语言实现,为 AI 模型提供对阿里云日志服务(SLS)和云监控(CMS)的结构化数据访问能力。基于 [Model Context Protocol](https://modelcontextprotocol.io/) 协议,可与 Cursor、Kiro、Cline、Windsurf 等 AI 工具无缝集成。
  14. ## 特性
  15. - 支持 stdio、SSE、streamable-http 三种传输模式
  16. - 模块化工具集架构:PaaS(云监控 2.0)、IaaS(SLS/CMS 直接访问)、Shared
  17. - 灵活的时间表达式解析:相对时间、绝对时间戳、Grafana 风格、预设关键词
  18. - 时序数据对比分析:统计计算、趋势分析、差异评分
  19. - 结构化错误处理:英文错误描述和解决方案建议
  20. - 稳定性保障:重试(指数退避)、熔断器、优雅关闭
  21. - 结构化 JSON 日志(slog)
  22. - 单一二进制文件,零运行时依赖
  23. ## 快速开始
  24. ### 下载与安装
  25. 从 [Releases](https://github.com/aliyun/alibabacloud-observability-mcp-server/releases) 页面下载对应平台的二进制文件:
  26. ```bash
  27. # Linux amd64
  28. wget https://github.com/aliyun/alibabacloud-observability-mcp-server/releases/latest/download/alibabacloud-observability-mcp-server-linux-amd64.tar.gz
  29. tar -xzf alibabacloud-observability-mcp-server-linux-amd64.tar.gz
  30. # macOS arm64 (M1/M2)
  31. wget https://github.com/aliyun/alibabacloud-observability-mcp-server/releases/latest/download/alibabacloud-observability-mcp-server-darwin-arm64.tar.gz
  32. tar -xzf alibabacloud-observability-mcp-server-darwin-arm64.tar.gz
  33. ```
  34. 解压后包含:
  35. - `alibabacloud-observability-mcp-server` - 可执行文件
  36. - `config.yaml` - 默认配置文件
  37. ### 配置凭证
  38. ```bash
  39. # 设置阿里云 AccessKey
  40. export ALIBABA_CLOUD_ACCESS_KEY_ID=<your_access_key_id>
  41. export ALIBABA_CLOUD_ACCESS_KEY_SECRET=<your_access_key_secret>
  42. ```
  43. > AccessKey 获取方式:[阿里云 AccessKey 管理](https://help.aliyun.com/document_detail/53045.html)
  44. ### 启动服务
  45. ```bash
  46. # 以 stdio 模式启动(MCP 客户端直接调用)
  47. ./alibabacloud-observability-mcp-server start --stdio
  48. # 以网络模式启动(默认 transport 在 config.yaml 中配置)
  49. ./alibabacloud-observability-mcp-server start --config config.yaml
  50. ```
  51. ### CLI 命令
  52. ```bash
  53. # 查看版本信息
  54. ./alibabacloud-observability-mcp-server version
  55. # 列出所有已注册工具
  56. ./alibabacloud-observability-mcp-server tools
  57. ```
  58. ## 从源码构建
  59. ```bash
  60. git clone https://github.com/aliyun/alibabacloud-observability-mcp-server.git
  61. cd alibabacloud-observability-mcp-server
  62. make build
  63. ```
  64. ## 配置
  65. 配置采用两层结构:
  66. 1. `config.yaml` - 服务器配置(传输模式、日志、网络等)
  67. 2. `.env` 文件或环境变量 - 凭证和运行时参数
  68. 详细的配置项说明请参考 `config.yaml` 中的注释。
  69. ## AI 工具集成
  70. ### streamable-http 模式(推荐)
  71. 1. 配置 `config.yaml`(设置 `server.transport: streamable-http`)
  72. 2. 启动服务:`./bin/alibabacloud-observability-mcp-server start`
  73. 3. 配置 `mcp.json`:
  74. ```json
  75. {
  76. "mcpServers": {
  77. "alibaba_cloud_observability": {
  78. "url": "http://localhost:8080"
  79. }
  80. }
  81. }
  82. ```
  83. ### stdio 模式
  84. ```json
  85. {
  86. "mcpServers": {
  87. "alibaba_cloud_observability": {
  88. "command": "./bin/alibabacloud-observability-mcp-server",
  89. "args": ["start", "--stdio"],
  90. "env": {
  91. "ALIBABA_CLOUD_ACCESS_KEY_ID": "<your_access_key_id>",
  92. "ALIBABA_CLOUD_ACCESS_KEY_SECRET": "<your_access_key_secret>"
  93. }
  94. }
  95. }
  96. }
  97. ```
  98. ## 工具集
  99. ### 查看完整工具列表
  100. 运行以下命令查看当前注册的所有工具:
  101. ```bash
  102. ./bin/alibabacloud-observability-mcp-server tools
  103. ```
  104. ### 付费功能说明
  105. 以下 AI 智能工具每次调用会产生 STAROps 费用:
  106. | 工具 | 功能 |
  107. |------|------|
  108. | `sls_text_to_sql` | 自然语言转 SQL |
  109. | `sls_text_to_spl` | 自然语言转 SPL |
  110. | `sls_sop` | SLS 智能运维助手 |
  111. | `cms_natural_language_query` | 自然语言数据查询 |
  112. 计费详情查看 [STAROps 计费说明](https://www.aliyun.com/price/product#/starops/detail)。如不需要 AI 能力,可在 `config.yaml` 的 `enabled_tools` 中仅启用免费工具。
  113. ### 权限要求
  114. | 服务 | 权限文档 | 适用工具 |
  115. |------|---------|------|
  116. | 日志服务 (SLS) | [SLS 权限](https://help.aliyun.com/zh/sls/overview-8) | `sls_*` |
  117. | 应用实时监控 (ARMS) | [ARMS 权限](https://help.aliyun.com/zh/arms/security-and-compliance/overview-8) | `umodel_*` |
  118. | 云监控 (CMS) | [CMS 权限](https://help.aliyun.com/zh/cms/cloudmonitor-2-0/) | `cms_*` |
  119. **特殊权限**:使用 AI 智能工具(如 `sls_text_to_sql`、`cms_natural_language_query`)需要授予 CMS 的 `cms:CreateChat`、`cms:CreateThread` 权限。
  120. ### 时间表达式
  121. 所有数据查询工具支持灵活的时间范围格式:
  122. | 格式 | 示例 |
  123. |------|------|
  124. | 相对预设 | `last_5m`、`last_1h`、`last_1d` |
  125. | 相对时间 | `now()-1h`、`now-30m` |
  126. | Grafana 风格 | `now-15m~now-5m`、`now/d`、`now-1d/d` |
  127. | 绝对时间戳 | `1718451045`(秒)、`1718451045000`(毫秒) |
  128. | 日期时间字符串 | `2024-01-01 00:00:00`、`2024-01-01T00:00:00Z` |
  129. ## 项目结构
  130. ```
  131. ├── cmd/server/ # CLI 入口
  132. ├── pkg/
  133. │ ├── client/ # SLS/CMS 客户端
  134. │ ├── config/ # 配置管理
  135. │ ├── server/ # MCP Server 核心
  136. │ └── toolkit/ # 工具集(PaaS/IaaS/Shared)
  137. └── v1/ # Python 版本
  138. ```
  139. ## 安全建议
  140. - 服务不存储 AccessKey,仅在运行时用于 API 调用
  141. - SSE/HTTP 模式下需自行做好访问控制
  142. - 建议部署在内网或 VPC,避免暴露公网
  143. - 推荐使用函数计算 (FC) 部署,仅 VPC 内访问
  144. ## Skill 自动化部署
  145. 本项目提供 AI Agent Skill,支持通过自然语言指令完成部署、启动和更新。
  146. ### 安装 Skill
  147. **方式一:npx skills add(推荐)**
  148. 由 [Vercel Labs](https://github.com/vercel-labs/skills) 维护的通用 skill 安装器,支持 69+ 种 coding agents:
  149. ```bash
  150. # 全局安装(所有项目可用)
  151. npx skills add aliyun/alibabacloud-observability-mcp-server
  152. # 项目级安装(仅当前项目可用)
  153. npx skills add aliyun/alibabacloud-observability-mcp-server --local
  154. ```
  155. **方式二:curl(无需 Node.js)**
  156. ```bash
  157. # 下载并安装 skill 到 ~/.claude/skills/
  158. curl -fsSL https://raw.githubusercontent.com/aliyun/alibabacloud-observability-mcp-server/master/skills/deploy-observability/SKILL.md -o ~/.claude/skills/deploy-observability/SKILL.md
  159. ```
  160. **方式三:从项目仓库复制**
  161. 如果你已经克隆了本项目:
  162. ```bash
  163. # 全局安装
  164. cp skills/deploy-observability/SKILL.md ~/.claude/skills/deploy-observability/
  165. # 或项目级安装(在项目根目录下)
  166. cp skills/deploy-observability/SKILL.md .claude/skills/deploy-observability/
  167. ```
  168. ### 使用 Skill
  169. 安装 skill 后,将以下内容复制到支持 Skill 的 AI Agent(如 Claude Code)中:
  170. **首次部署**:
  171. ```
  172. 请使用 deploy-observability skill 帮我完成以下操作:
  173. 1. 克隆项目到 ~/alibabacloud-observability-mcp-server
  174. 2. 下载依赖并构建
  175. 3. 复制 .env.example 为 .env,并提示我填写阿里云 AccessKey
  176. 4. 让我选择启动模式(stdio / sse / streamable-http)
  177. 5. 生成 JSON 配置,供我粘贴到 AI Agent 中使用
  178. ```
  179. **项目更新**:
  180. ```
  181. 请使用 deploy-observability skill 帮我更新项目:
  182. 1. 拉取最新代码
  183. 2. 检测是否有依赖、配置或环境变量变更
  184. 3. 对比工具列表变化,告诉我新增/删除了哪些工具
  185. 4. 重新构建并重启服务
  186. ```
  187. 详细使用文档请参考 [skills/deploy-observability/SKILL.md](skills/deploy-observability/SKILL.md)。
  188. ## 许可证
  189. 本项目遵循与原 Python 版相同的许可协议。

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.