用途
byok-observability-mcp 用于从 Claude Code、Codex 或任意 MCP 客户端查询本机的可观测性技术栈,且数据不离开本机。它面向需要将监控与日志平台的查询能力接入 AI 客户端的开发者与运维人员。
主要能力
支持的后端包括:
- Grafana:当设置 GRAFANA_URL 与 GRAFANA_TOKEN 时启用。
- Prometheus:当设置 PROMETHEUS_URL 时启用。
- Kafka UI:当设置 KAFKA_UI_URL 时启用。
- Datadog:当同时设置 DD_API_KEY 与 DD_APP_KEY 时启用,实际是代理官方 Datadog MCP 服务器。默认工具集为 core、apm、alerting,设置 DD_TOOLSETS=all 可加载全部。
此外始终提供一个可用于检查所有已配置后端连通性的工具。所有工具均为只读,不会对任何后端执行写操作。
支持按需部分配置:只配置你使用的后端,未配置后端的工具不会暴露。
支持定时报告:可将自动化的可观测性摘要按计划发送到 Slack,无需运行 Claude 或 Codex 实例,命令收集数据、按严重级别分类、格式化并发送 Slack 消息后退出,完全无状态。
使用方式
方式 A —— 交互式向导(推荐):运行一次向导,回答几个问题,即可生成现成的 .mcp.json。向导会:让你选择要配置的后端;按服务询问凭证;在写入前用真实端点测试连通性;将 .mcp.json 写入项目根目录或 ~/.claude/(由你选择)。随后启动 Claude Code 即可。无需克隆、构建或 env 文件,可在 60 秒内完成。
方式 B —— 手动配置 .mcp.json:在项目根目录创建 .mcp.json,只包含所需后端。凭证若进入 git,可使用 ${VAR} 方式(Configuration → Method B)。启动 Claude Code 后会自动读取 .mcp.json,无需 claude mcp add,也无需构建步骤。
支持的客户端:Claude Code 与 Codex 均会自动读取 .mcp.json,也可通过 CLI 添加。
凭证获取:
- Grafana:Administration → Users and access → Service accounts → Add service account(Role 设为 Viewer)→ Create → Add service account token → Generate token,复制以 glsa_ 开头的 token。
- Prometheus:无认证时无需凭证;使用 basic auth 时相应设置。
- Kafka UI:无认证时无需凭证;需要登录时提供账号。
- Datadog:API key 位于 Organization Settings → API Keys → New Key;Application key 位于 Organization Settings → Application Keys → New Key;DD_SITE 需与你的 Datadog 登录 URL 匹配。
配置方法:
- 方法 A:直接在 .mcp.json 中填入凭证值(最简单),共享仓库时请将 .mcp.json 加入 .gitignore。
- 方法 B:在 .mcp.json 中使用 ${VAR} 占位符,真实值放在 .env(加入 .gitignore),启动 Claude 时加载该 env。附带现成的辅助脚本,以及包含所有变量的模板 .mcp.json.example。也可添加到 ~/.claude.json。
定时报告配置:
- 获取 Slack Incoming Webhook URL:api.slack.com/apps → Create New App → From scratch → Incoming Webhooks 开启 → Add New Webhook to Workspace → 选择频道 → Allow → 复制 Webhook URL。
- 设置环境变量。
- 运行一次性报告验证,应在数秒内在 Slack 频道看到消息。
- 使用 cron 定时:编辑 crontab 并添加相应行;可将所有环境变量放入 .env 并在 cron 命令中 source。macOS 也可用 launchd(登录时运行、重启后仍有效),创建 ~/Library/LaunchAgents/com.observability-mcp.report.plist。停止使用 launchctl unload。
示例提示:支持单后端查询、跨后端查询,以及 v0.2.0+ 的事件响应场景。
安全
- 所有工具为只读,不对任何后端执行写操作。
- 凭证仅从环境变量读取,绝不记录或发送至 Anthropic。所有错误消息中的 token 均会被脱敏。
- 默认启用 TLS 证书校验。
- MCP 进程在本地运行,只有当你把基础设施 URL 输入聊天时,这些 URL 才会进入 Claude 的上下文窗口。
- 文档给出了最小权限建议。
适用场景
适用于希望通过 Claude Code、Codex 等 MCP 客户端对本机可观测性平台(Grafana、Prometheus、Kafka UI、Datadog)进行只读查询,并希望凭证与数据留在本机的开发与运维场景;也适用于需要将可观测性摘要定时推送到 Slack 的团队。
限制
资料未提供具体平台兼容范围、价格与收费信息、性能指标或效果保证;部分后端仅在设置相应环境变量时启用;Datadog 能力依赖官方 Datadog MCP 服务器。资料中未给出的具体测试版本号、完整环境变量列表与示例命令细节暂未提供。