datawatch

datawatch

datawatch 可调用数据可观测性平台的 API，获取平台健康状况和每日简报、告警（摘要、收件箱、趋势、历史记录和规则）、受监控的数据资产及其发现结果、新鲜度摘要、检查和计划，以及架构摘要、变更列表、基线和监控信息。一个二进制文件同时提供命令行界面和 stdio MCP 服务。

使用时需要 API 密钥。请在使用前设置 ARMOR_API_KEY；如果未设置或为空，所有工具都会报错，并指出该变量名，且不会发出任何请求。可通过 DATAWATCH_API_URL 覆盖 API 基础 URL；如果未设置，请求将发送至 https://api.anomalyarmor.ai（标注为重构版本）。

范围说明：平台文档列出了 52 个工具名称（其标题称有 29 个，版本行称有 52 个；列出的各节共包含 52 个）。datawatch 实现了其中标注为核心的 24 个工具——告警、资产、新鲜度和架构漂移——未实现指标、有效性、引用完整性、目标位置、覆盖率、建议、问答、智能、血缘、作业、标签和 API 密钥相关工具。

安装

npx @reneturcios/datawatch get_alerts_summary

或者运行容器镜像：

docker run -i ghcr.io/cloudcorprecords/datawatch

容器默认启动 MCP 服务（见下文）。传入 CLI 参数即可将其用作 CLI。

CLI

子命令与 MCP 工具名称相对应：

export ARMOR_API_KEY=...

datawatch health_summary
datawatch get_todays_briefing
datawatch list_alerts --status open --severity high
datawatch list_inbox_alerts --limit 20
datawatch update_alert --alert-id al1 --action acknowledge --comment "looking into it"
datawatch get_alert_trends --period 7d
datawatch list_alert_rules --asset-id a1 --is-active true
datawatch create_alert_rule --asset-id a1 --rule-type freshness --config '{"threshold_hours":24}'
datawatch list_assets --source snowflake --search orders
datawatch create_asset --name warehouse --source-type snowflake
datawatch trigger_asset_discovery --asset-id a1
datawatch check_freshness --asset-id a1 --table-path db.schema.orders
datawatch setup_freshness --asset-id a1 --table-path db.schema.orders --check-interval 1h
datawatch list_schema_changes --severity breaking
datawatch create_schema_baseline --asset-id a1 --description initial
datawatch get_schema_monitoring --asset-id a1

datawatch --version

结果以 JSON 格式输出上游载荷。退出码：成功时为 0；调用失败时为 1（包括缺少密钥或上游 API 错误）；用法错误时为 2。

MCP 服务

一个二进制文件同时提供两种接口。mcp 子命令会启动 stdio MCP 服务：

npx -y @reneturcios/datawatch mcp

MCP 客户端配置：

{
  "mcpServers": {
    "datawatch": {
      "command": "npx",
      "args": ["-y", "@reneturcios/datawatch", "mcp"],
      "env": { "ARMOR_API_KEY": "..." }
    }
  }
}

工具

工具	输入	功能
health_summary	（无）	平台整体健康状况摘要。
get_todays_briefing	（无）	今日可观测性简报。
get_alerts_summary	（无）	当前告警摘要。
list_alerts	status、severity、asset_id、from_date、to_date	列出告警，可选使用筛选条件。
list_inbox_alerts	status、limit（整数）	列出收件箱告警。
update_alert	alert_id、action（均为必填）、comment	对告警执行操作。
get_alert_trends	period	获取指定时段的告警趋势。
get_alert_history	alert_id（必填）	获取一条告警的历史记录。
list_alert_rules	asset_id、is_active（布尔值）	列出告警规则。
create_alert_rule	asset_id、rule_type（均为必填）、config（对象）	创建告警规则。
manage_alert_rule	rule_id、action（均为必填）	管理告警规则。
list_assets	source、asset_type、search	列出数据资产。
create_asset	name、source_type（均为必填）、connection_config（对象）	创建数据资产。
manage_asset	asset_id、action（均为必填）	管理数据资产。
trigger_asset_discovery	asset_id（必填）	触发资产发现。
get_freshness_summary	（无）	获取所有资产的新鲜度摘要。
check_freshness	asset_id（必填）、table_path	检查单个资产的新鲜度。
setup_freshness	asset_id、table_path（均为必填）、check_interval	设置新鲜度监控。
list_freshness_schedules	asset_id	列出新鲜度计划。
manage_freshness_schedule	schedule_id、action（均为必填）	管理新鲜度计划。
get_schema_summary	（无）	架构监控摘要。
list_schema_changes	asset_id、severity、from_date、to_date	列出架构变更。
create_schema_baseline	asset_id（必填）、description	创建架构基线。
get_schema_monitoring	asset_id（必填）	获取单个资产的架构监控信息。

开发

npm install
npm run build   # tsc -> dist/
npm test        # node test runner over test/*.test.ts, no network (fake fetch fixtures)
npm run dev     # run the CLI from source via tsx

许可证

MIT — 参见 LICENSE。