Servicenow Docs

核心用法

servicenow-docs 技能通过 Zoomin API 对接 docs.servicenow.com 官方文档库，提供三类核心操作：

1. 搜索文档 (servicenow_search)：支持关键词检索（如 GlideRecord、business rule），可按版本（Washington DC、Zurich 等）过滤，默认返回 10 条结果
2. 获取全文 (servicenow_get_article)：根据搜索结果的 URL 拉取完整文档内容
3. 版本列表 (servicenow_list_versions)：查询所有可用文档版本/发行版

显著优点

• 官方权威：直接对接 ServiceNow 官方文档源，信息一手、更新及时
• 版本精准：支持按发行版过滤，避免版本混淆导致的脚本兼容问题
• 结构清晰：API 设计简洁，搜索-获取流程符合开发者查阅习惯
• 覆盖全面：涵盖 API 参考、脚本开发、平台功能三大核心领域

潜在缺点与局限性

• 依赖外部 API：Zoomin API 的稳定性与速率限制直接影响可用性
• 非实时镜像：文档更新可能存在同步延迟
• 无离线能力：需持续联网，无法本地缓存大规模文档
• 结果相关性：搜索质量受 Zoomin 引擎算法制约，复杂查询可能需人工筛选

适合人群

ServiceNow 开发者、管理员、顾问及学习者优先；特别适合需要快速查阅官方 API 签名、脚本最佳实践或验证平台行为的技术人员。

常规风险

• 数据外泄：查询内容（如业务对象名）通过 API 传输至 ServiceNow 服务器
• 依赖失效：若 Zoomin API 变更或 docs.servicenow.com 重构，工具可能失效
• 版本漂移：未指定版本时可能获取到与实例不匹配的最新文档，导致实施偏差

核心用法

该 Skill 提供三个核心工具用于访问 ServiceNow 官方文档：

1. servicenow_search — 搜索文档数据库，支持关键词（如 "GlideRecord"、"business rule"）、结果数量限制及版本过滤（如 "Washington DC"、"Zurich"）
2. servicenow_get_article — 获取指定 URL 的完整文章内容
3. servicenow_list_versions — 列出所有可用文档版本

典型工作流：先使用搜索工具定位相关文章，再通过 URL 获取详细内容。适用于开发脚本、配置业务规则、学习平台 API 等场景。

显著优点

• 官方权威数据源：直接对接 ServiceNow 官方 Zoomin API（docs.servicenow.com），确保文档的准确性和时效性
• 类型安全：TypeScript 编写，配合 zod v4.3.5 进行输入验证，代码健壮
• 版本隔离：支持按版本过滤，避免新旧版本 API 混用导致的兼容性问题
• 隐私友好：仅传输用户主动输入的搜索关键词，不收集敏感个人信息
• 代码质量优秀：静态分析得分 90，无危险函数、硬编码密钥或动态代码执行

潜在缺点与局限性

• 网络依赖：完全依赖 ServiceNow 官方服务可用性，无本地缓存机制
• 无超时重试：当前 fetch 调用未配置超时，极端网络条件下可能挂起
• 无内容类型验证：未校验 API 返回的 Content-Type，存在格式异常风险
• 无许可证声明：项目未明确开源许可证，商用场景存在法律模糊地带

适合人群

• ServiceNow 平台开发者（ITSM、ITOM、HRSD 等模块）
• 需要编写 Business Rule、Script Include、UI Action 的技术顾问
• 准备 ServiceNow 认证考试（CSA、CAD、ITSM 等）的考生
• 企业内 ServiceNow 运维团队的技术支持人员

常规风险

| 风险类型 | 等级 | 说明 |

|---------|------|------|

| 数据外泄 | 极低 | 仅向官方域名发送搜索关键词，HTTPS 加密传输 |

| 代码执行 | 无 | 未检测到 eval/exec/system 等危险函数 |

| 依赖漏洞 | 低 | 仅依赖 zod v4.3.5，无已知 CVE |

| 服务可用性 | 中 | 依赖外部 API，建议添加超时处理 |

安全认证报告给出 S 级（90 分）评价，属于优秀安全级别。