Everything you need to run AI on ServiceNow

NowAIKit Documentation

NowAIKit is the most comprehensive, production-ready AI toolkit for ServiceNow — and the only one that truly does it all. With 400+ tools, a built-in WebUI, and a dedicated desktop app, you can manage incidents, query CMDB, deploy scripts, and automate workflows — all through natural language.

How it works

Prerequisites

Before installing NowAIKit, make sure you have the following:

Installation

Install NowAIKit globally using npm:

$ npm install -g nowaikit

Or use it without installing via npx (recommended for AI client configs):

$ npx -y nowaikit

Verify the installation:

$ nowaikit --version
3.0.0

Two Ways to Run

NowAIKit supports two execution modes — choose the one that fits your workflow:

MCP Mode — Connect Any AI Client

This is the primary mode. Start NowAIKit as an MCP server and point your AI client at it. All 400+ tools including fluent_query, batch_request, and execute_script are available to the AI automatically.

# Start the MCP server (used in AI client configs)
$ npx -y nowaikit

# With write operations enabled
$ npx -y nowaikit --allow-write

Once running, your AI can use power tools like:

• fluent_query — GlideQuery-style chained queries with where, select, aggregate, groupBy
• batch_request — bundle up to 50 operations in a single call, 50-70% fewer round-trips
• execute_script — run GlideRecord, GlideQuery, and server-side APIs directly on the instance

See Client Setup below for config examples for Claude, Cursor, VS Code, and more.

Direct CLI Mode — No AI Client Needed

Run the 26 built-in AI capabilities (scan, review, build, ops, docs) directly from your terminal. You provide your own API key — no MCP client required.

# List all 26 capabilities
$ nowaikit capabilities

# Run a capability with Anthropic
$ nowaikit run scan-health --provider anthropic

# Run with OpenAI
$ nowaikit run review-code --provider openai

# Run with local Ollama (air-gapped)
$ nowaikit run build-business-rule --provider ollama

Interactive Setup Wizard

The fastest way to get started. NowAIKit includes a guided setup wizard that walks you through connecting your instance, choosing authentication, and configuring your AI client.

$ npx nowaikit --setup

The wizard will prompt you for your instance URL, credentials, authentication method (Basic or OAuth), and generate the correct config for your chosen AI client.

Claude Desktop

Edit your Claude Desktop configuration file to add NowAIKit.

Config file location

Basic Auth config

{
  "mcpServers": {
    "nowaikit": {
      "command": "npx",
      "args": ["-y", "nowaikit"],
      "env": {
        "SN_INSTANCE_URL": "https://your-instance.service-now.com",
        "SN_USERNAME":     "your-username",
        "SN_PASSWORD":     "your-password"
      }
    }
  }
}

With write permissions enabled

{
  "mcpServers": {
    "nowaikit": {
      "command": "npx",
      "args": [
        "-y", "nowaikit",
        "--allow-write",
        "--allow-cmdb"
      ],
      "env": {
        "SN_INSTANCE_URL": "https://your-instance.service-now.com",
        "SN_USERNAME":     "your-username",
        "SN_PASSWORD":     "your-password"
      }
    }
  }
}

Restart Claude Desktop after saving the config file.

Claude Code (CLI)

Claude Code is Anthropic's CLI tool for developers. Configure NowAIKit in your .claude/config.json or pass it as a command-line flag:

$ claude --mcp-server nowaikit='npx -y nowaikit'

Or add to your project's .mcp.json for persistent configuration — same format as Claude Desktop.

Cursor

Create or edit .cursor/mcp.json in your project root:

{
  "mcpServers": {
    "nowaikit": {
      "command": "npx",
      "args": ["-y", "nowaikit"],
      "env": {
        "SN_INSTANCE_URL": "https://your-instance.service-now.com",
        "SN_USERNAME":     "your-username",
        "SN_PASSWORD":     "your-password"
      }
    }
  }
}

Alternatively, add it globally via Cursor Settings → MCP → Add new global server.

VS Code & Cline

Install the Cline extension from the VS Code Marketplace, then configure NowAIKit in Cline's MCP settings:

"nowaikit": {
  "command": "npx",
  "args": ["-y", "nowaikit"],
  "env": {
    "SN_INSTANCE_URL": "https://your-instance.service-now.com",
    "SN_USERNAME":     "your-username",
    "SN_PASSWORD":     "your-password"
  }
}

ChatGPT / OpenAI

Use NowAIKit with OpenAI's ecosystem including ChatGPT and Codex. The integration uses a Python wrapper that translates tool schemas to OpenAI function definitions.

Supports the latest models: GPT-4.1, o3, o4-mini, and all OpenAI function-calling models.

Google Gemini

Connect NowAIKit to Google Gemini and Vertex AI. The integration converts tool schemas to Gemini function declarations, supporting Gemini 2.5 Pro, Gemini 2.5 Flash, and all Gemini models with function calling.

Google's free-tier Gemini models are a great option for teams looking to reduce AI costs while maintaining full ServiceNow coverage.

Other Clients

Any client that supports MCP follows the same pattern. Use the npx -y nowaikit command with your credentials as environment variables.

Environment Variables

NowAIKit is configured via environment variables. Create a .env file in your project directory or set them in your AI client's config.

Basic Authentication

The simplest way to connect. Use a dedicated ServiceNow service account rather than a personal account.

SN_INSTANCE_URL=https://your-instance.service-now.com
SN_USERNAME=your-service-account
SN_PASSWORD=your-password

OAuth 2.0

Recommended for production environments. Requires an OAuth application registered in your ServiceNow instance.

Step 1 — Create an OAuth application in ServiceNow

1. Navigate to System OAuth › Application Registry
2. Click New → Create an OAuth API endpoint for external clients
3. Set a name, note the Client ID and Client Secret
4. Set the Token Lifespan and Refresh Token Lifespan as needed

Step 2 — Configure NowAIKit

SN_INSTANCE_URL=https://your-instance.service-now.com
SN_OAUTH_CLIENT_ID=your-client-id
SN_OAUTH_CLIENT_SECRET=your-client-secret
SN_OAUTH_TOKEN_URL=https://your-instance.service-now.com/oauth_token.do
SN_USERNAME=your-username
SN_PASSWORD=your-password

SSO / OIDC (Enterprise)

Enterprise tier supports single sign-on via industry-standard protocols. Connect NowAIKit to your organisation's identity provider for seamless, secure authentication.

Multi-Instance Setup

NowAIKit supports connecting to multiple ServiceNow instances simultaneously. Use numbered environment variables to define each instance:

# Primary instance (default)
SN_INSTANCE_URL=https://prod.service-now.com
SN_USERNAME=svc-account
SN_PASSWORD=prod-password

# Secondary instance
SN_INSTANCE_2_URL=https://dev12345.service-now.com
SN_INSTANCE_2_USERNAME=svc-account
SN_INSTANCE_2_PASSWORD=dev-password
SN_INSTANCE_2_NAME=Development

Then ask your AI to switch instances by name: "Switch to the Development instance" or "Connect to my staging environment."

Permission Tiers

NowAIKit uses a five-tier security model. Tier 0 is always active. All higher tiers require explicit flags.

Enabling Permissions

Pass permission flags as arguments in your AI client's MCP config:

"args": [
  "-y", "nowaikit",
  "--allow-write",
  "--allow-cmdb",
  "--allow-scripting",
  "--allow-agentic"
]

Persona Packages

Persona packages pre-configure the tools exposed to your AI based on your role. Set one via the SN_PERSONA environment variable.

SN_PERSONA=developer

400+ Tools Across 32 Categories

Every tool is production-ready, tested, and works autonomously. Here's what's included in each module.

Documentation Hub

Deep-dive guides for every aspect of NowAIKit. Click any card to read the full documentation.

ITSM

IT Service Management tools cover the full incident lifecycle, change management, problem management, and service requests.

ITOM & CMDB

IT Operations Management and Configuration Management Database tools for infrastructure visibility and operations.

HRSD & CSM

Development Tools

Platform & Admin

SecOps & GRC

Agile & Scrum

Virtual Agent

IT Asset Management

DevOps & Pipelines

Notifications & Attachments

System Properties & Update Sets

Machine Learning & App Studio

Desktop App

NowAIKit includes a native desktop application built with Electron, available for macOS, Windows, and Linux. Features include:

• System tray integration with quick access
• Multi-window support for parallel workflows
• Slash-command tool picker — type / to browse all 400+ tools
• @ context references for quick navigation
• Multi-provider AI chat built-in
• Keyboard shortcuts and hotkeys
• Automatic updates

Web Dashboard & AI Chat

Access NowAIKit from any browser with the built-in web dashboard. Includes multi-provider AI chat supporting:

Running out of credits with one provider? Switch to another instantly — no coding, no config changes, just click.

HTTP API Server

NowAIKit includes a REST API wrapper that exposes all 400+ tools as HTTP endpoints. Perfect for web apps, dashboards, and custom integrations.

$ npm run serve
# or
$ node dist/http-server.js

Build custom apps with Lovable, v0, Bolt, or any web framework — connect to ServiceNow through NowAIKit's REST API.

Slash Commands

Type / in the chat input to open a floating picker over all 400+ ServiceNow tools. Browse by category, search by name, and insert any tool directly into your conversation.

Use @ to reference context — mention instances, tables, records, or recent results for faster workflows.

Now Assist (AI)

10 AI-native tools that integrate with ServiceNow's Now Assist platform features:

Reporting & Analytics

13 tools for querying data, building Performance Analytics dashboards, scheduling reports, and exporting results. Ask your AI to generate reports in natural language.

ATF Testing

9 tools for ServiceNow's Automated Test Framework. Run test suites, get failure insights, and manage test cases — all through natural language.

Scripting & Code Management

27 tools across 7 domains: Business Rules, Script Includes, Client Scripts, UI Policies, UI Actions, ACLs, and Update Sets. Create, review, update, and deploy code — all from your AI chat.

SDK & Fluent Query

Three power tools for advanced ServiceNow operations: fluent_query (GlideQuery-style chained queries), batch_request (multi-operation batching, 50-70% fewer round-trips), and execute_script (server-side Background Script execution).

fluent_query — GlideQuery-style queries

Build complex queries with familiar GlideQuery patterns: where, orWhere, select, aggregate (COUNT/AVG/SUM/MIN/MAX), groupBy, orderBy, and limit. Supports dot-walking and display values.

{
  "table": "incident",
  "where": [["active","=",true], ["priority","<",3]],
  "select": ["number","short_description","caller_id.email"],
  "orderBy": "-sys_created_on",
  "limit": 10
}

batch_request — Multi-operation batching

Execute up to 50 REST operations in a single HTTP call. Reduces round-trips by 50-70%, ideal for dashboards and bulk operations.

{
  "operations": [
    { "id": "inc", "method": "GET", "url": "/api/now/table/incident?sysparm_limit=5" },
    { "id": "chg", "method": "GET", "url": "/api/now/table/change_request?sysparm_limit=5" },
    { "id": "prb", "method": "GET", "url": "/api/now/table/problem?sysparm_limit=5" }
  ]
}

execute_script — Server-side scripting

Run GlideRecord, GlideQuery, GlideAggregate, and all server-side APIs directly on the instance. Requires --allow-write.

var gr = new GlideRecord('incident');
gr.addEncodedQuery('active=true^priority=1');
gr.query();
gs.print('P1 count: ' + gr.getRowCount());

Flow Designer

Create and manage flows, subflows, and actions through natural language. Integrates with Integration Hub for connecting to external systems.

• Create and trigger flows
• Manage subflows and reusable actions
• Debug flow execution and view logs
• Integration Hub connections to 3rd-party systems

Audit Logging

Enterprise tier includes comprehensive audit logging for compliance and security. Every tool execution is logged with user, timestamp, action, and result.

• JSONL format — machine-readable, easy to parse
• SIEM webhooks — stream to Splunk, Sentinel, or any SIEM
• Per-user context — track who did what, when, and on which instance

Pricing & Licensing

NowAIKit uses a two-tier licensing model:

Incidents & Changes

These are plain-language prompts you can give to your AI client. NowAIKit translates them to ServiceNow API calls.

Scripting & Deployment

Reporting & Analytics

v4.0.0 Features in Action

Practical examples for the major v4.0.0 capabilities: HTTP transport, dynamic schema discovery, A2A protocol, and the REST API.

Running with HTTP Transport

Start NowAIKit as a Streamable HTTP server accessible to any HTTP client or agent framework.

# Start NowAIKit as an HTTP server on port 3000
$ TRANSPORT=http PORT=3000 npx nowaikit

# Output:
# NowAIKit v4.0.0 — Streamable HTTP on http://localhost:3000
# Dashboard:   http://localhost:3000/
# MCP endpoint: http://localhost:3000/mcp
# REST API:    http://localhost:3000/api/*
# A2A:         http://localhost:3000/.well-known/agent.json

Dynamic Schema Discovery

Ask your AI to discover any ServiceNow table — including custom ones. NowAIKit reads the schema and auto-generates 5 typed CRUD tools.

A2A Agent Discovery

NowAIKit exposes a Google A2A agent card so other agents can discover its capabilities automatically.

$ curl http://localhost:3000/.well-known/agent.json

# Response (abbreviated):
{
  "name": "NowAIKit",
  "description": "400+ ServiceNow tools via MCP",
  "url": "http://localhost:3000",
  "capabilities": {
    "streaming": true,
    "pushNotifications": false
  },
  "skills": [
    { "id": "incident-management", "name": "Incident Management" },
    { "id": "change-management", "name": "Change Management" },
    ...
  ]
}

REST API Usage

Call NowAIKit tools directly via HTTP — no MCP client required. Useful for scripts, CI/CD pipelines, and custom integrations.

# List all available tools
$ curl -H "Authorization: Bearer $NOWAIKIT_API_KEY" http://localhost:3000/api/tools

# Call a tool directly
$ curl -X POST http://localhost:3000/api/tool \
  -H "Authorization: Bearer $NOWAIKIT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"get_incident","arguments":{"number":"INC0010001"}}'

# Response:
{
  "result": {
    "number": "INC0010001",
    "short_description": "Email server unreachable",
    "state": "In Progress",
    "priority": "2 - High"
  }
}

See the Transport Configuration section for full endpoint reference and authentication details.

What's New

Stay up to date with the latest NowAIKit releases, features, and improvements.

Troubleshooting