Servicenow Docs

# ServiceNow Documentation Skill

从 docs.servicenow.com 和 developer.servicenow.com 搜索并检索文档。此技能提供对 ServiceNow 发布说明、平台文档以及面向开发者的 API 参考资料和指南的访问。

## 何时使用

当用户询问以下内容时使用此技能： - ServiceNow API 文档（GlideRecord、GlideAjax、GlideQuery 等） - 发布说明、补丁或新功能 - 平台配置或管理 - 脚本模式或最佳实践 - 辅助功能、UI 或用户偏好设置 - 任何 ServiceNow 产品或功能文档 - 开发者主题，如 openFrameAPI、ScriptLoader、spContextManager 或移动 API

## 工具

### servicenow_search

搜索 ServiceNow 文档数据库。

**Args:** - `query` (字符串，必填) - 搜索词（例如 "GlideRecord"、"accessibility preferences"、"patch notes"） - `limit` (数字，默认: 10) - 返回的最大结果数 - `version` (字符串，可选) - 按版本筛选（例如 "Washington DC"、"Zurich"、"Yokohama"）

**示例:** ```json {"query": "GlideAjax client script", "limit": 5} ```

### servicenow_get_article

获取文档文章的完整内容。

**Args:** - `url` (字符串，必填) - 文章 URL（自动从 Zoomin 转换为 docs.servicenow.com）

**示例:** ```json {"url": "https://docs.servicenow.com/bundle/zurich-release-notes/page/release-notes/quality/zurich-patch-5.html"} ```

### servicenow_list_versions

列出可用的 ServiceNow 文档版本/发布。

**Args:** 无需参数

### servicenow_latest_release

获取最新 ServiceNow 版本的发布说明（自动检测最近的版本）。

**Args:** 无需参数

### servicenow_dev_suggest

从 ServiceNow 开发者文档获取自动补全建议。

**Args:** - `term` (字符串，必填) - 部分搜索词（例如 "Gli"、"openFrame"、"spCon"）

**示例:** ```json {"term": "openFrame"} ```

### servicenow_dev_search

搜索 ServiceNow 开发者文档（API、指南、参考）。返回 API 参考页面的 URL。

**Args:** - `query` (字符串，必填) - 搜索词（例如 "openFrameAPI"、"spContextManager"） - `limit` (数字，默认: 10) - 返回的最大结果数

**示例:** ```json {"query": "ScriptLoader", "limit": 5} ```

### servicenow_dev_guide

通过路径获取 ServiceNow 开发者指南。适用于 PDI 指南、开发者计划文档等。

**Args:** - `path` (字符串，必填) - 指南路径（例如 "developer-program/getting-instance-assistance"、"pdi-guide/requesting-an-instance"） - `release` (字符串，默认: "zurich") - 发布版本

**示例:** ```json {"path": "developer-program/getting-instance-assistance"} ```

## URL 处理

- **搜索 API：** 使用 Zoomin API (servicenow-be-prod.servicenow.com) 进行搜索 - **面向用户的 URL：** 自动转换为 docs.servicenow.com 以提高可读性 - **文章内容：** 通过 Zoomin API 端点获取，并带有正确的请求头 - **开发者文档搜索：** developer.servicenow.com GraphQL + databroker 搜索 API - **开发者文档内容：** 直接从 developer.servicenow.com 页面获取

## 使用示例

用户：“ServiceNow 中的辅助功能首选项有哪些？” → 使用 servicenow_search 查找辅助功能文档 → 使用 servicenow_get_article 获取完整内容 → 为用户总结首选项

用户：“告诉我最新的 ServiceNow 补丁” → 使用 servicenow_latest_release 获取最新的发布说明 → 获取并总结补丁详细信息

用户：“如何使用 openFrameAPI？” → 使用 servicenow_dev_suggest 或 servicenow_dev_search 查找最佳的开发者文档主题 → 返回 API 参考页面的 URL（需要浏览器访问才能获取完整内容）

用户：“展示获取实例的 PDI 指南” → 使用 servicenow_dev_guide，路径为 "pdi-guide/requesting-an-instance" → 返回完整的指南内容

## 使用的 API

- **Zoomin 搜索 API：** `https://servicenow-be-prod.servicenow.com/search` - **内容源：** docs.servicenow.com（通过 Zoomin API 访问） - **开发者搜索 API：** `https://developer.servicenow.com/api/now/uxf/databroker/exec` - **开发者建议 API：** `https://developer.servicenow.com/api/now/graphql` - **开发者指南 API：** `https://developer.servicenow.com/api/snc/v1/guides`（公开，无需认证）

## 局限性

- **API 参考内容：** developer.servicenow.com 上的 API 参考页面需要浏览器访问。`servicenow_dev_search` 返回 URL，但无法获取完整的 API 文档内容。 - **指南内容：** 可通过 `servicenow_dev_guide` 完整获取指南内容，无需认证。