ServiceNow SDK

概览

GitHubGitHub

ServiceNow SDK 是一个面向 ServiceNow Now Platform 的开发工具包，旨在将现代开发者工作流引入该平台。它允许开发者以源代码形式构建应用，使用 git 进行版本管理，并通过熟悉的工具完成部署。 该 SDK 与 ServiceNow Fluent 配合使用。Fluent 是一个基于 TypeScript 的 DSL（领域特定语言），用于在代码中定义应用元数据。除了 Fluent，SDK 还支持 JavaScript 模块和第三方库。 ### AI Skills 能力 仓库中包含用于创建、编辑和部署 ServiceNow Fluent 应用的 agent skills。安装这些技能后，AI 编码助手可以在编写代码前查阅 SDK 文档和实时实例信息，使生成的代码符合实际的 Fluent 约定。具体能力包括： - **自动识别项目结构**：检测到 `now.config.json` 时，会自动阅读 SDK 的 `quickstart` 和 `fluent-language` 文档，理解项目结构、元数据类型和约定后再进行修改。 - **按需查阅权威文档**：通过 `explain` 命令直接读取已安装的 `@servicenow/sdk` 包内文档，确保引用的文档与项目使用的 SDK 版本一致。可查询的元数据类型包括 `Table`、`BusinessRule`、`Acl`、`Flow`、`ScriptInclude`、`ClientScript`、`UiPolicy` 等。 - **查询实时实例**：通过 `query` 命令检查记录是否存在、查找 `sys_id`、查看表或列的 schema、获取 choice 和 role/scope 信息。 - **避免不安全变更**：了解平台特定的注意事项，例如不会在未确认的情况下从 `.now.ts` 文件中删除 `Table()`、`BusinessRule()` 或 `Record()` 定义。 ### 支持的 AI 工具 SDK 提供了针对多种 AI 编码工具的安装方式，包括 Claude Code、Codex、Cursor、GitHub Copilot、Grok、Kiro 以及 Windsurf 等。其中 `query` 能力需要 SDK 4.8.0 或更高版本，其他 AI Skills 功能需要 4.6.0 或更高版本。 适合希望在 ServiceNow Now Platform 上采用源码驱动开发流程的团队和开发者使用。

Q&A

ServiceNow SDK 是什么？由 AI 生成

ServiceNow SDK 是一个为 Now Platform 带来现代开发者工作流的工具包，允许以源代码形式构建应用、用 git 版本管理并使用已有工具部署。它与基于 TypeScript 的 DSL ServiceNow Fluent 配合使用。

AI Skills 功能需要什么版本的 SDK？由 AI 生成

AI Skills 功能依赖 SDK 4.6.0 或更高版本中提供的特性。其中 query 能力额外要求 SDK 版本达到 4.8.0 或更高。

如何在 GitHub Copilot 中安装 now-sdk skill？由 AI 生成

需要将 GitHub CLI 更新到 2.90.0 或更高版本，然后运行 gh skill install ServiceNow/sdk now-sdk。默认作为项目 skill 安装在 .github/skills/now-sdk，加 --scope user 可作为个人 skill 安装。安装后在 Copilot CLI 中运行 /skills reload 加载。

explain 命令的作用是什么？由 AI 生成

explain 命令直接从已安装的 @servicenow/sdk 包中读取文档，让 AI agent 始终参考与项目 SDK 版本匹配的文档，而非可能过时的训练数据。可查询 Table、BusinessRule、Acl 等元数据类型及 build、deploy 等工作流。

query 命令能做什么？由 AI 生成

query 命令可以查询实时实例数据，包括检查记录是否已存在、查找 sys_id、检查表或列的 schema、获取 choice 和 role/scope 信息，使生成的代码基于实际实例数据而非假设。

NPM 包名是什么？由 AI 生成

NPM 包名为 @servicenow/sdk。