核心功能
servicenow-agent 是一款面向 ServiceNow 平台的只读型 CLI 工具,专为安全的数据探查场景设计。它封装了 ServiceNow 四大核心 API(Table API、Attachment API、Aggregate API、Service Catalog API)的 GET 操作,完全禁止写入行为(POST/PUT/PATCH/DELETE)。
显著优点
- 零风险只读设计:从架构层面限制为 GET 方法,杜绝误操作导致的数据变更或删除
- 多维度数据访问:支持表记录查询(list/get)、单条记录精准获取、附件元数据与内容下载、聚合统计(count/avg/min/max/sum)、服务目录变量读取、字段结构探测及工单历史时间线回溯
- 灵活的查询能力:完整的
sysparm_*参数体系,支持复杂查询条件、字段筛选、显示值转换、分页控制 - 批量工作流支持:通过 JSON 批处理文件可执行多表关联查询,内置推荐预设(事件模式检查、历史记录模板、附件追踪)
- 认证方式灵活:支持
.env环境变量配置或命令行实时覆盖
潜在局限
- 只读限制:无法用于创建、更新或删除记录,不满足运维操作需求
- Node.js 依赖:需要运行时环境支持,增加部署复杂度
- 性能约束:建议主动设置
sysparm_limit避免大数据量超时,聚合统计优于全量下载 - 服务目录空结果:特定搜索条件下可能返回空数组,需调整查询策略
适用人群
- ITSM/ITIL 分析师需快速审计工单状态与历史
- 安全合规团队进行只读数据取证与附件收集
- 开发测试人员验证表结构与服务目录配置
- 项目经理提取统计报表与趋势分析
常规风险提示
- 凭证(用户名/密码)以明文或环境变量形式存储,需确保
.env文件权限管控 - 附件下载可能涉及敏感文件内容,需遵循组织数据分级策略
- 聚合查询若未合理设置
sysparm_group_by,可能对源系统造成计算压力 - 建议优先使用
schema探测字段名,避免无效查询消耗 API 配额