nowaikit 4.1.2 → 4.1.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,1270 +1,98 @@
1
1
  <div align="center">
2
2
 
3
- <img src="docs/assets/banner.svg" alt="NowAIKit — The Complete ServiceNow AI Kit" width="100%"/>
3
+ <img src="docs/assets/banner.svg" alt="NowAIKit — ServiceNow MCP Server" width="100%"/>
4
4
 
5
- <br/>
6
-
7
- [![AI-Powered](https://img.shields.io/badge/AI--Powered-Claude%20%7C%20ChatGPT%20%7C%20Gemini%20%7C%20Groq%20%7C%20OpenRouter-00D4AA?style=flat-square)](https://github.com/aartiq/nowaikit)
8
- [![Tools](https://img.shields.io/badge/400%2B%20Tools-All%20Modules-0F4C81?style=flat-square)](docs/TOOLS.md)
9
- [![TypeScript](https://img.shields.io/badge/TypeScript-5.x-3178C6?style=flat-square&logo=typescript&logoColor=white)](https://www.typescriptlang.org/)
10
- [![License: Source Available](https://img.shields.io/badge/license-Source%20Available-f59e0b?style=flat-square)](LICENSE)
11
- [![ServiceNow](https://img.shields.io/badge/ServiceNow-Latest%20Release-00D4AA?style=flat-square)](https://developer.servicenow.com)
5
+ [![npm](https://img.shields.io/npm/v/nowaikit?style=flat-square&color=00D4AA&label=npm)](https://www.npmjs.com/package/nowaikit)
6
+ [![Tools](https://img.shields.io/badge/450%2B%20tools-all%20modules-0F4C81?style=flat-square)](docs/TOOLS.md)
12
7
  [![MCP](https://img.shields.io/badge/MCP-Model%20Context%20Protocol-0F4C81?style=flat-square)](https://modelcontextprotocol.io)
13
- [![Node.js](https://img.shields.io/badge/Node.js-20%2B-339933?style=flat-square&logo=node.js&logoColor=white)](https://nodejs.org)
14
-
15
- <br/>
8
+ [![License: Source Available](https://img.shields.io/badge/license-Source%20Available-f59e0b?style=flat-square)](LICENSE)
16
9
 
17
10
  # NowAIKit — ServiceNow MCP Server
18
11
 
19
- ## The Most Comprehensive ServiceNow AI Toolkit
20
-
21
- > **400+ tools · 31+ ServiceNow modules · 5-minute setup · Free to use · Works with any AI**
22
-
23
- **NowAIKit** is the most comprehensive, production-ready AI toolkit for ServiceNow — and the only one that truly does it all.
24
-
25
- Connect **Claude**, **ChatGPT**, **Gemini**, **Cursor**, **GitHub Copilot**, or any MCP-compatible AI in under 5 minutes. Then let your AI read, build, deploy, and automate across every ServiceNow module — incidents, changes, scripts, flows, portals, integrations, HRSD, CSM, and more.
26
-
27
- Ask in plain English. Deploy business rules from chat. Run ATF suites on demand. Query dev, staging, and prod simultaneously. Automate across multiple customer tenants without switching tabs. **Your AI, your instance, your rules.**
28
-
29
- **Any AI. Any instance. Any scale. Free to use.**
30
-
31
- ---
32
-
33
- ### 🧩 Part of the NowAIKit suite
34
-
35
- This repo is the **core MCP server**. NowAIKit is a full ServiceNow + AI suite:
36
-
37
- - 🌐 **[nowaikit.com](https://nowaikit.com)** — product home, docs & setup guides
38
- - ☁️ **[NowAIKit Cloud](https://cloud.nowaikit.com)** — use the toolkit in your browser, no install
39
- - 📦 **[`nowaikit-sdk`](https://www.npmjs.com/package/nowaikit-sdk)** — TypeScript ServiceNow client library
40
- - 🧰 **NowAIKit Builder** (VS Code extension) · **NowAIKit Utils** (browser extension)
41
-
42
- > **⚠️ Official distribution only:** install from **npm (`nowaikit`)** or **[nowaikit.com](https://nowaikit.com)**. NowAIKit is **never** shipped as a downloadable GitHub `.zip` — beware copycat repos with "Download" buttons.
43
-
44
- ---
45
-
46
- > **Keywords:** ServiceNow MCP server · Model Context Protocol · ServiceNow AI · ITSM automation · ServiceNow Claude · ServiceNow ChatGPT · ServiceNow Cursor · ServiceNow Copilot · ServiceNow LLM · ServiceNow agent · MCP tools · ServiceNow API · agentic AI · ServiceNow developer tools
47
-
48
- <br/>
49
-
50
- | | |
51
- |---|---|
52
- | **Beginners** | Zero ServiceNow API knowledge needed. Connect in 5 minutes. Ask in plain English. Free PDI at developer.servicenow.com. |
53
- | **Developers** | Write, deploy, test, and manage scripts, flows, widgets, and integrations at AI speed — 10x faster. |
54
- | **Architects & MSPs** | Orchestrate multi-step autonomous workflows. Compare environments. Manage multiple customer tenants in one session. |
12
+ **Connect Claude, ChatGPT, Gemini, Cursor, Copilot — or any AI — to ServiceNow.**
55
13
 
56
- <br/>
14
+ 450+ tools across ITSM, ITOM, CMDB, HRSD, CSM, Flow Designer, scripting & portal. Read, build, query and automate any instance in plain English.
57
15
 
58
16
  </div>
59
17
 
60
18
  ---
61
19
 
62
- ## Who Is This For?
63
-
64
- <table>
65
- <tr>
66
- <td width="33%" valign="top">
67
-
68
- ### Beginners
69
- **Zero ServiceNow API knowledge required.**
70
-
71
- Connect Claude Desktop or Cursor to your free PDI in 5 minutes. Ask questions in plain English, browse incidents, search KB articles, place catalog orders, monitor SLAs — all from your AI chat window. No code. No Postman. No documentation diving. Just ask.
72
-
73
- *Start here → [5-Minute Quickstart](#getting-started)*
74
-
75
- </td>
76
- <td width="33%" valign="top">
77
-
78
- ### Developers
79
- **10x faster with AI as your development partner.**
80
-
81
- Write business rules, deploy client scripts, manage UI Policies and ACLs, create Service Portal widgets, configure REST Messages, manage Transform Maps, and update changesets — all in plain English. Full TypeScript types, ATF integration, and role-based packages built in.
82
-
83
- *Explore → [Platform Developer Package](#role-based-tool-packages)*
84
-
85
- </td>
86
- <td width="33%" valign="top">
87
-
88
- ### Architects, Admins & MSPs
89
- **Autonomous workflows. Multi-instance. Multi-customer.**
90
-
91
- Trigger Agentic Playbooks, orchestrate multi-step ITSM/HRSD/CSM processes, compare environments side by side, manage dozens of customer tenants in one session, and run full data quality audits — at AI speed, across your entire ServiceNow estate.
92
-
93
- *Deep dive → [Now Assist & Agentic Guide](docs/NOW_ASSIST.md)*
94
-
95
- </td>
96
- </tr>
97
- </table>
98
-
99
- ---
100
-
101
- ## Why NowAIKit
102
-
103
- <table>
104
- <tr>
105
- <td width="33%" valign="top">
106
-
107
- ### Fully Autonomous AI Operations
108
-
109
- Your AI doesn't just answer questions — it *acts*. Create incidents, write and deploy scripts, trigger flows, fire events, upload attachments, manage changesets, and run full ATF suites — end-to-end, without manual steps. Native Now Assist Agentic Playbook support for next-generation ServiceNow AI automation.
110
-
111
- </td>
112
- <td width="33%" valign="top">
113
-
114
- ### Works With Every AI, Out of the Box
115
-
116
- **Claude, ChatGPT, Gemini, Grok, Cursor, Windsurf, GitHub Copilot, Amazon Q, JetBrains, Continue.dev, Cline, Zed, Google AI Studio, Ollama** — all supported out of the box. Any MCP-compatible client. Any custom Python or TypeScript agent. One toolkit, every AI platform, zero lock-in.
117
-
118
- </td>
119
- <td width="33%" valign="top">
120
-
121
- ### Unmatched Platform Coverage
122
-
123
- **400+ production-ready tools** across every ServiceNow domain — ITSM, ITOM, HRSD, CSM, SecOps, GRC, Agile, ATF, Flow Designer, Scripting, Now Assist, Service Portal, Integration Hub, Performance Analytics, System Properties, Update Sets, Virtual Agent, ITAM, DevOps, Machine Learning, Workspace/UIB, Mobile, and Deployment. Nothing else comes close.
124
-
125
- </td>
126
- </tr>
127
- <tr>
128
- <td width="33%" valign="top">
129
-
130
- ### Role-Based Tool Intelligence
131
-
132
- Fourteen pre-built persona packages — service desk, platform developer, portal developer, integration engineer, ITOM engineer, AI developer, ITAM analyst, DevOps engineer, and more. Each exposes exactly the right tools for that role. Reduce noise, enforce least-privilege, and configure once per team.
133
-
134
- </td>
135
- <td width="33%" valign="top">
136
-
137
- ### Safe by Default, Powerful When Needed
138
-
139
- A five-tier permission model keeps your instance protected. **Read is always on.** Write, CMDB, Scripting, Now Assist, and ATF capabilities each require an explicit opt-in flag. No AI can accidentally modify your production data. Scale permissions as your confidence grows — without touching code.
140
-
141
- </td>
142
- <td width="33%" valign="top">
143
-
144
- ### True Multi-Instance & Multi-Customer
145
-
146
- Connect to **unlimited ServiceNow instances** from one session — dev, staging, prod, *and* multiple customer tenants simultaneously. Pass `instance: "acme_prod"` on any tool call, or `switch_instance` globally. MSPs, consultants, and enterprise teams can compare, query, and automate across every environment at once. No other ServiceNow AI toolkit does this.
147
-
148
- </td>
149
- </tr>
150
- </table>
151
-
152
- ---
153
-
154
- ## Quick Links
155
-
156
- | Resource | Link |
157
- |----------|------|
158
- | All Tools Reference | [docs/TOOLS.md](docs/TOOLS.md) |
159
- | Client Setup (All AI tools, beginner + advanced) | [docs/CLIENT_SETUP.md](docs/CLIENT_SETUP.md) |
160
- | Role-Based Tool Packages | [docs/TOOL_PACKAGES.md](docs/TOOL_PACKAGES.md) |
161
- | Now Assist & AI Integration | [docs/NOW_ASSIST.md](docs/NOW_ASSIST.md) |
162
- | ATF Testing Guide | [docs/ATF.md](docs/ATF.md) |
163
- | Scripting Management | [docs/SCRIPTING.md](docs/SCRIPTING.md) |
164
- | Reporting & Analytics | [docs/REPORTING.md](docs/REPORTING.md) |
165
- | Multi-Instance Setup | [docs/MULTI_INSTANCE.md](docs/MULTI_INSTANCE.md) |
166
- | 120+ Real-World Examples | [EXAMPLES.md](EXAMPLES.md) |
167
- | Changelog | [CHANGELOG.md](CHANGELOG.md) |
168
-
169
- ---
170
-
171
- ## Module Coverage
172
-
173
- Domain modules covering the full ServiceNow platform:
174
-
175
- | Module | Key Capabilities |
176
- |--------|-----------------|
177
- | Core & CMDB | Record query, schema discovery, CMDB CIs, ITOM Discovery, MID Servers, multi-instance management |
178
- | Incident Management | Create, update, resolve, close, work notes, comments |
179
- | Problem Management | Problem records, root cause analysis, known errors |
180
- | Change Management | Create, get, update, submit for approval, close change requests |
181
- | Task Management | Generic tasks, my-task lists, completions |
182
- | Knowledge Base | Search, create, update, publish KB articles |
183
- | Service Catalog & Approvals | Catalog browsing, create/update items, order items, SLA tracking, approval workflows, approval rules |
184
- | User & Group Management | Users, groups, membership, role assignments |
185
- | Reporting & Analytics | Aggregate queries, trend analysis, create/update reports, scheduled job CRUD, run history |
186
- | ATF Testing | Test suites, test execution, ATF Failure Insight |
187
- | Now Assist / AI | NLQ, AI Search, summaries, resolution suggestions, Agentic Playbooks |
188
- | Scripting | Business rules, script includes, client script CRUD, UI Policies, UI Actions, ACL management, changesets |
189
- | Agile / Scrum | Stories, epics, sprints, scrum tasks |
190
- | HR Service Delivery (HRSD) | HR cases, HR services, employee profiles, onboarding/offboarding |
191
- | Customer Service Management (CSM) | Customer cases, accounts, contacts, products, SLAs |
192
- | Security Operations & GRC | SecOps incidents, vulnerabilities, GRC risks, controls, threat intel |
193
- | Flow Designer & Process Automation | Flows, subflows, triggers, executions, Process Automation playbooks |
194
- | Service Portal & UI Builder | Create/list portals & pages, widgets (create/update/deploy), Next Experience apps/pages, themes |
195
- | Integration Hub | REST Messages, Transform Maps, Import Sets, Event Registry, OAuth apps, credential aliases |
196
- | Notifications & Attachments | Email notifications, email logs, file attachments (upload/list/delete), templates, subscriptions |
197
- | Performance Analytics | PA indicators/scorecards, time-series, create/update dashboards, PA jobs, data quality checks |
198
- | System Properties | Get, set, bulk operations, validate, export/import, audit history |
199
- | Update Set Management | Create, switch, preview, complete, export, auto-ensure active set |
200
- | Virtual Agent (VA) | Topic authoring, conversation history, categories, topic listing |
201
- | IT Asset Management (ITAM) | Assets, software licenses, contracts, compliance reporting |
202
- | DevOps & Pipeline Tracking | Pipelines, deployments, change governance, DORA metrics |
203
- | Scoped Applications (App Studio) | List, get, create, and update scoped application records |
204
-
205
- ---
206
-
207
- ## Authentication
208
-
209
- Two authentication methods are supported:
210
-
211
- | Method | Best For |
212
- |--------|----------|
213
- | **Basic Auth** | Development, personal instances, quick setup |
214
- | **OAuth 2.0** (client credentials / password grant) | Production deployments, service accounts |
215
-
216
- SSO / OIDC authentication (Okta, Azure AD / Entra, Ping Identity) is available in the Enterprise edition — see [nowaikit.com/#pricing](https://nowaikit.com/#pricing).
217
-
218
- For OAuth setup in ServiceNow, see [docs/SERVICENOW_OAUTH_SETUP.md](docs/SERVICENOW_OAUTH_SETUP.md).
219
-
220
- ---
221
-
222
- ## Permission System
223
-
224
- A four-tier permission model keeps your instance safe by default:
225
-
226
- | Tier | Environment Variable | Covers |
227
- |------|---------------------|--------|
228
- | 0 — Read | *(always on)* | All query and read operations |
229
- | 1 — Write | `WRITE_ENABLED=true` | Create/update across ITSM, HRSD, CSM, Agile |
230
- | 2 — CMDB Write | `CMDB_WRITE_ENABLED=true` | CI create/update in the CMDB |
231
- | 3 — Scripting | `SCRIPTING_ENABLED=true` | Business rules, script includes, changesets |
232
- | 4 — Now Assist | `NOW_ASSIST_ENABLED=true` | AI Agentic Playbooks, NLQ, AI Search |
233
-
234
- ---
235
-
236
- ## Role-Based Tool Packages
237
-
238
- Set `MCP_TOOL_PACKAGE` to expose only the tools relevant to each persona:
239
-
240
- | Package | Persona | Tools Included |
241
- |---------|---------|---------------|
242
- | `full` | Administrators | All tools (400+) |
243
- | `service_desk` | L1/L2 Agents | Incidents, tasks, approvals, KB, SLA |
244
- | `change_coordinator` | Change Managers | Changes (create/approve/close), CAB, CMDB, approvals |
245
- | `knowledge_author` | KB Authors | Knowledge base create/publish |
246
- | `catalog_builder` | Catalog Admins | Catalog, users, groups |
247
- | `system_administrator` | Sys Admins | Users, groups, reports, logs, notifications, attachments, ACLs, PA |
248
- | `platform_developer` | Developers | Scripts, UI Policies, UI Actions, ACLs, client scripts, ATF, changesets |
249
- | `portal_developer` | Portal/UX Devs | Portals, pages, widgets (create/update), UI Policies, UI Actions, client scripts |
250
- | `integration_engineer` | Integration Devs | REST Messages, Transform Maps, Import Sets, Events, OAuth, credentials |
251
- | `itom_engineer` | ITOM Engineers | CMDB, Discovery, MID servers, events |
252
- | `agile_manager` | Scrum Masters | Stories, epics, sprints |
253
- | `ai_developer` | AI Builders | Now Assist, NLQ, Agentic Playbooks |
254
-
255
- ---
256
-
257
- ## Getting Started
20
+ ## 🚀 Install (2 minutes)
258
21
 
259
- ### Option A — Interactive Setup Wizard (Recommended)
22
+ > Requires **Node.js 20+**.
260
23
 
261
24
  ```bash
262
- # Install globally (Node.js 20+ required)
25
+ # 1 install
263
26
  npm install -g nowaikit
264
27
 
265
- # Run the wizard detects your AI clients and writes config automatically
28
+ # 2 — run the wizard: it detects your AI clients and writes their config for you
266
29
  npx nowaikit setup
267
30
  ```
268
31
 
269
- The wizard will:
270
- 1. Ask for your ServiceNow instance URL + credentials
271
- 2. Test the connection
272
- 3. Let you pick a tool package and permission level
273
- 4. Detect Claude Desktop, Cursor, VS Code, Windsurf, Continue.dev, Claude Code on your machine
274
- 5. Write the config directly — no copy-paste, no manual JSON editing
275
-
276
- ```
277
- # Add a second instance later
278
- nowaikit setup --add
279
-
280
- # Manage instances
281
- nowaikit instances list
282
- ```
283
-
284
- ### Option B — Web Dashboard (one command)
285
-
286
- ```bash
287
- npx nowaikit web
288
- ```
289
-
290
- Opens the NowAIKit dashboard at **http://localhost:4175** — includes instance management, settings, and an audit log viewer.
291
-
292
- ```bash
293
- # Custom port
294
- npx nowaikit web --port 3000
295
-
296
- # Expose to network (use with caution)
297
- npx nowaikit web --host 0.0.0.0
298
-
299
- # Don't auto-open browser
300
- npx nowaikit web --no-open
301
- ```
302
-
303
- ### Option C — Desktop App
304
-
305
- Download the native desktop app (macOS, Windows, Linux) from [GitHub Releases](https://github.com/aartiq/nowaikit/releases). Includes a visual setup wizard, tool browser, and audit log viewer.
306
-
307
- ### Option D — Manual Setup
308
-
309
- ```bash
310
- git clone https://github.com/aartiq/nowaikit.git && cd nowaikit
311
- npm install && npm run build
312
- cp .env.example .env # fill in your ServiceNow credentials
313
- ```
314
-
315
- Then point your AI client at `dist/server.js` — see [Supported AI Clients](#supported-ai-clients) below.
316
-
317
- > **No ServiceNow instance?** Get a free Personal Developer Instance at [developer.servicenow.com](https://developer.servicenow.com) — ready in minutes.
318
-
319
- **Full installation guide → [docs/INSTALLATION.md](docs/INSTALLATION.md)**
320
-
321
- ---
322
-
323
- ## Client Setup Guides
324
-
325
- Step-by-step setup for every major AI client — Claude Desktop, Claude Code, Cursor, VS Code, Windsurf, Zed, GitHub Copilot, Continue.dev, Cline, JetBrains, Amazon Q, Google AI Studio, ChatGPT, Grok, Ollama, and more.
326
-
327
- **Full guide → [docs/CLIENT_SETUP.md](docs/CLIENT_SETUP.md)**
328
-
329
- For quick setup snippets, see the [Supported AI Clients](#supported-ai-clients) section below.
330
- ---
331
-
332
- ## Example Interactions
333
-
334
- Once connected, ask your AI assistant in plain language:
335
-
336
- **ITSM & Change Management:**
337
- ```
338
- Show me all open P1 incidents assigned to the Network Operations group.
339
- ```
340
- ```
341
- Create a normal change request for deploying the new API gateway — implementation planned for Saturday midnight.
342
- ```
343
- ```
344
- What CMDB CIs does the ERP application depend on?
345
- ```
346
-
347
- **Scripting & Development:**
348
- ```
349
- List all client scripts on the incident table and show me the ones that fire on form load.
350
- ```
351
- ```
352
- Create a UI action button "Escalate to L3" on the incident form that assigns the ticket to the L3-Support group.
353
- ```
354
- ```
355
- Show me all ACL rules for the change_request table that restrict the "delete" operation.
356
- ```
357
-
358
- **Service Portal & UI Builder:**
359
- ```
360
- List all widgets in the Service Portal that contain "catalog" in their name.
361
- ```
362
- ```
363
- Get the full source code of the "Stock Ticker" widget so I can update its server script.
364
- ```
365
- ```
366
- Create a new portal widget called "My Approvals Widget" with a simple Angular template that lists pending approvals.
367
- ```
368
-
369
- **Integrations & Events:**
370
- ```
371
- List all REST Message definitions that connect to external APIs.
372
- ```
373
- ```
374
- Show me all transform maps that target the incident table.
375
- ```
376
- ```
377
- Fire the custom event "myapp.ticket.escalated" on incident INC0012345.
378
- ```
379
-
380
- **Notifications & Attachments:**
381
- ```
382
- List all email notifications that trigger on the incident table when a comment is added.
383
- ```
384
- ```
385
- Upload a screenshot of the error (base64) as an attachment to incident INC0012345.
386
- ```
387
- ```
388
- Show me all failed email log entries from the last 24 hours.
389
- ```
390
-
391
- **Performance Analytics & Data Quality:**
392
- ```
393
- Get the current scorecard for the "Mean Time to Resolve" PA indicator with a 30-day trend.
394
- ```
395
- ```
396
- Check the data completeness of the incident table — how many incidents are missing assignment_group or category?
397
- ```
398
- ```
399
- Compare record counts across incident, change_request, and problem tables.
400
- ```
401
-
402
- **ATF, Reporting & Scheduled Jobs:**
403
- ```
404
- Run the Regression Test Suite and show me any failures with ATF Failure Insight details.
405
- ```
406
- ```
407
- Summarise the last 30 days of incident trends by category.
408
- ```
409
- ```
410
- Create a scheduled job that runs daily at 3am to archive closed incidents older than 90 days.
411
- ```
412
-
413
- For 120+ real-world examples with inputs, outputs, and advanced workflows, see [EXAMPLES.md](EXAMPLES.md).
414
-
415
- ---
416
-
417
- ## Slash Commands & @ Mentions
418
-
419
- Once connected, type `/` in Claude Desktop or Cursor to see built-in ServiceNow shortcuts:
420
-
421
- | Command | What it does |
422
- |---------|-------------|
423
- | `/morning-standup` | P1/P2 open incidents, changes due today, SLA breaches |
424
- | `/my-tickets` | All open tasks/incidents assigned to you |
425
- | `/p1-alerts` | Active P1 incidents with time-open and assignee |
426
- | `/my-changes` | Your pending change requests and approval status |
427
- | `/create-incident` | Guided incident creation |
428
- | `/sla-breaches` | Records currently breaching SLA |
429
- | `/ci-health` | CMDB CI health check |
430
- | `/run-atf` | Trigger ATF test suite |
431
- | `/switch-instance` | Interactive instance picker |
432
- | `/knowledge-search` | Search KB articles |
433
- | `/deploy-updateset` | Guided update set commit |
434
-
435
- Type `@` to pull live ServiceNow data into your AI context:
436
-
437
- | Mention | Returns |
438
- |---------|---------|
439
- | `@my-incidents` | Your open incidents |
440
- | `@open-changes` | Pending change requests |
441
- | `@sla-breaches` | Records breaching SLA now |
442
- | `@instance:info` | Current instance metadata |
443
- | `@ci:<name>` | CMDB CI by name |
444
- | `@kb:<title>` | Knowledge article by title |
445
-
446
- Add your own commands in `nowaikit.commands.json`:
447
-
448
- ```json
449
- [
450
- {
451
- "name": "my-p1-runbook",
452
- "description": "P1 runbook for my team",
453
- "template": "List all P1 incidents in the Network category. For each: number, description, assignee, time open. Flag SLA breaches."
454
- }
455
- ]
456
- ```
457
-
458
- ## Advanced Configuration
459
-
460
- | Topic | Guide |
461
- |-------|-------|
462
- | OAuth 2.0 setup (ServiceNow OAuth app creation) | [docs/SERVICENOW_OAUTH_SETUP.md](docs/SERVICENOW_OAUTH_SETUP.md) |
463
- | Multi-instance / multi-customer (dev, staging, prod, tenants) | [docs/MULTI_INSTANCE.md](docs/MULTI_INSTANCE.md) |
464
- | Role-based tool packages | [docs/TOOL_PACKAGES.md](docs/TOOL_PACKAGES.md) |
465
- | All environment variables reference | [docs/INSTALLATION.md](docs/INSTALLATION.md) |
466
-
467
- ### Pro / Enterprise Features
468
-
469
- The following features are available in **NowAIKit Pro** and **Enterprise** editions:
470
-
471
- | Feature | Edition |
472
- |---------|---------|
473
- | HTTP API server & web dashboard | Pro |
474
- | Desktop app (macOS, Windows, Linux) | Pro |
475
- | SSO / OIDC (Okta, Azure AD / Entra, Ping Identity) | Enterprise |
476
- | Audit logging (JSONL + SIEM webhooks) | Enterprise |
477
- | Org policy governance (MDM / GPO deployment) | Enterprise |
478
-
479
- Learn more at [nowaikit.com/#pricing](https://nowaikit.com/#pricing).
480
-
481
- ---
482
-
483
- ## See It In Action
484
-
485
- These are real interactions you can have with your AI once NowAIKit is connected:
486
-
487
- **Operations — plain English:**
488
- ```
489
- You: "Show me all P1 incidents opened this week that are still unresolved"
490
- You: "Which assignment groups have the most open incidents right now?"
491
- You: "Find all change requests scheduled for this weekend"
492
- You: "Is any SLA about to breach in the next 2 hours?"
493
- ```
494
-
495
- **Development — AI writes and deploys for you:**
496
- ```
497
- You: "Create a business rule that auto-assigns high-priority incidents to the NOC group"
498
- You: "Write a client script that validates email format on the contact form"
499
- You: "Create a Service Portal widget that shows my team's open tasks"
500
- You: "Set up a REST Message integration to send alerts to our Slack channel"
501
- ```
502
-
503
- **AI-powered intelligence:**
504
- ```
505
- You: "Summarise this incident and suggest a resolution based on similar past cases"
506
- You: "Use Predictive Intelligence to categorise this new incident description"
507
- You: "Trigger the SOC Agentic Playbook for this security incident"
508
- You: "What's the trend in P2 incidents over the last 6 months?"
509
- ```
510
-
511
- **Advanced automation:**
512
- ```
513
- You: "Compare record counts between prod and dev for the incident table"
514
- You: "Check data completeness on the cmdb_ci_server table — which fields are mostly empty?"
515
- You: "Run the nightly sync transform map on the latest import set"
516
- You: "Create a scheduled job that emails the on-call team daily at 7am"
517
- ```
518
-
519
- **Multi-instance & multi-customer:**
520
- ```
521
- You: "List all configured instances"
522
- You: "Switch to customer_acme and show me their open P1 incidents"
523
- You: "Compare open change counts between prod and staging"
524
- You: "Get SLA breach risk from customer_globex prod instance"
525
- ```
32
+ Restart your AI client (Claude Desktop, Cursor, …) and start asking. Done.
526
33
 
527
- See [EXAMPLES.md](EXAMPLES.md) for 120+ real-world examples across all ServiceNow modules.
34
+ > Prefer a UI? `npx nowaikit web` for a local dashboard or use **[NowAIKit Cloud](https://cloud.nowaikit.com)** (nothing to install).
528
35
 
529
36
  ---
530
37
 
531
- ## Supported AI Clients
532
-
533
- **Any MCP-compatible AI works.** NowAIKit has been tested with every major AI assistant, editor, and agent framework. Pick yours and follow the 3-step setup below.
534
-
535
- ### AI Assistants & Chat
536
-
537
- <details>
538
- <summary><b>Claude Desktop</b> — Anthropic (Mac / Windows / Linux)</summary>
539
-
540
- 1. Install Claude Desktop from [claude.ai/download](https://claude.ai/download)
541
- 2. Edit config:
542
- - **macOS**: `~/Library/Application Support/Claude/claude_desktop_config.json`
543
- - **Windows**: `%APPDATA%\Claude\claude_desktop_config.json`
544
- 3. Add this block — **single instance** (replace path and credentials):
38
+ ## 🔌 Manual setup (skip the wizard)
545
39
 
546
- ```json
547
- {
548
- "mcpServers": {
549
- "nowaikit": {
550
- "command": "node",
551
- "args": ["/absolute/path/to/nowaikit/dist/server.js"],
552
- "env": {
553
- "SERVICENOW_INSTANCE_URL": "https://yourinstance.service-now.com",
554
- "SERVICENOW_AUTH_METHOD": "basic",
555
- "SERVICENOW_BASIC_USERNAME": "admin",
556
- "SERVICENOW_BASIC_PASSWORD": "your_password",
557
- "WRITE_ENABLED": "false"
558
- }
559
- }
560
- }
561
- }
562
- ```
563
-
564
- Or use **multi-instance** (dev + staging + prod, or multiple customer tenants):
40
+ Add this to your client's MCP config (Claude Desktop `claude_desktop_config.json`, Cursor `~/.cursor/mcp.json`, etc.):
565
41
 
566
42
  ```json
567
43
  {
568
44
  "mcpServers": {
569
45
  "nowaikit": {
570
- "command": "node",
571
- "args": ["/absolute/path/to/nowaikit/dist/server.js"],
46
+ "command": "npx",
47
+ "args": ["-y", "nowaikit"],
572
48
  "env": {
573
- "SN_INSTANCES_CONFIG": "/absolute/path/to/instances.json"
574
- }
575
- }
576
- }
577
- }
578
- ```
579
-
580
- Copy `instances.example.json` → `instances.json`, fill in your instances, then ask:
581
- > *"List instances"* → *"Switch to prod"* → *"Show me all P1 incidents"*
582
- > *"Get open changes from customer_acme"* (uses `instance` parameter per-call)
583
-
584
- 4. Restart Claude Desktop. The hammer icon confirms connection.
585
-
586
- Full guide → [clients/claude-desktop/SETUP.md](clients/claude-desktop/SETUP.md) | [docs/MULTI_INSTANCE.md](docs/MULTI_INSTANCE.md)
587
- </details>
588
-
589
- <details>
590
- <summary><b>ChatGPT / OpenAI</b> (API)</summary>
591
-
592
- OpenAI supports MCP via the **Responses API** (`mcp` tool type) in the latest SDK (v1.50+):
593
-
594
- ```python
595
- from openai import OpenAI
596
- import os, subprocess
597
-
598
- # Start NowAIKit as a subprocess MCP server
599
- proc = subprocess.Popen(
600
- ["node", "/path/to/nowaikit/dist/server.js"],
601
- stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.PIPE,
602
- env={**os.environ,
603
- "SERVICENOW_INSTANCE_URL": "https://yourinstance.service-now.com",
604
- "SERVICENOW_AUTH_METHOD": "basic",
605
- "SERVICENOW_BASIC_USERNAME": "admin",
606
- "SERVICENOW_BASIC_PASSWORD": "your_password"}
607
- )
608
-
609
- client = OpenAI()
610
- # Use with Responses API tool type "mcp" or via function calling
611
- response = client.responses.create(
612
- model="gpt-4o",
613
- tools=[{"type": "mcp", "server_label": "nowaikit"}],
614
- input="Show me all open P1 incidents"
615
- )
616
- ```
617
-
618
- Full guide → [docs/CLIENT_SETUP.md](docs/CLIENT_SETUP.md)
619
- </details>
620
-
621
- <details>
622
- <summary><b>Google Gemini / Vertex AI</b> (API)</summary>
623
-
624
- 1. Install NowAIKit: `npm install -g nowaikit`
625
- 2. Use the Python client in `clients/gemini/`:
626
-
627
- ```bash
628
- pip install google-generativeai
629
- python clients/gemini/servicenow_gemini_client.py
630
- ```
631
-
632
- Full guide → [clients/gemini/SETUP.md](clients/gemini/SETUP.md)
633
- </details>
634
-
635
- <details>
636
- <summary><b>Google AI Studio</b> — Gemini 2.5 Flash / Pro / Gemini 3 (MCP Preview)</summary>
637
-
638
- Google AI Studio supports MCP servers via its agent execution environment (currently in preview).
639
-
640
- 1. Go to [aistudio.google.com](https://aistudio.google.com) and open **Build → Agent**
641
- 2. In the **Tools** panel, add an MCP Server and point it to your NowAIKit instance:
642
-
643
- ```json
644
- {
645
- "name": "nowaikit",
646
- "transport": "stdio",
647
- "command": "node",
648
- "args": ["/absolute/path/to/nowaikit/dist/server.js"],
649
- "env": {
650
- "SERVICENOW_INSTANCE_URL": "https://yourinstance.service-now.com",
651
- "SERVICENOW_AUTH_METHOD": "basic",
652
- "SERVICENOW_BASIC_USERNAME": "admin",
653
- "SERVICENOW_BASIC_PASSWORD": "your_password",
654
- "WRITE_ENABLED": "false"
655
- }
656
- }
657
- ```
658
-
659
- 3. Alternatively, use the **Gemini API** directly with function calling by mapping NowAIKit tool definitions:
660
-
661
- ```python
662
- import google.generativeai as genai
663
- import subprocess, json, os
664
-
665
- # Start NowAIKit MCP server
666
- proc = subprocess.Popen(
667
- ["node", "/path/to/nowaikit/dist/server.js"],
668
- stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.PIPE,
669
- env={**os.environ,
670
- "SERVICENOW_INSTANCE_URL": "https://yourinstance.service-now.com",
671
- "SERVICENOW_AUTH_METHOD": "basic",
672
- "SERVICENOW_BASIC_USERNAME": "admin",
673
- "SERVICENOW_BASIC_PASSWORD": "your_password"}
674
- )
675
-
676
- genai.configure(api_key=os.environ["GOOGLE_API_KEY"])
677
- model = genai.GenerativeModel("gemini-3.1-pro") # or gemini-3-flash, gemini-2.5-flash
678
- # Use model.generate_content() with tools= mapped from NowAIKit definitions
679
- ```
680
-
681
- Full guide → [docs/CLIENT_SETUP.md](docs/CLIENT_SETUP.md)
682
- </details>
683
-
684
- <details>
685
- <summary><b>Grok (xAI)</b> — via OpenAI-compatible API</summary>
686
-
687
- 1. Grok uses the OpenAI-compatible API format. Follow the OpenAI setup above
688
- 2. Set `base_url="https://api.x.ai/v1"` and your `XAI_API_KEY`
689
-
690
- Full guide → [docs/CLIENT_SETUP.md](docs/CLIENT_SETUP.md)
691
- </details>
692
-
693
- ---
694
-
695
- ### AI Code Editors
696
-
697
- <details>
698
- <summary><b>Cursor</b> — AI-first code editor</summary>
699
-
700
- 1. Open Cursor → Settings → MCP
701
- 2. Add server config:
702
-
703
- ```json
704
- {
705
- "mcpServers": {
706
- "nowaikit": {
707
- "command": "node",
708
- "args": ["/absolute/path/to/nowaikit/dist/server.js"],
709
- "env": {
710
- "SERVICENOW_INSTANCE_URL": "https://yourinstance.service-now.com",
711
- "SERVICENOW_AUTH_METHOD": "basic",
712
- "SERVICENOW_BASIC_USERNAME": "admin",
713
- "SERVICENOW_BASIC_PASSWORD": "your_password",
714
- "WRITE_ENABLED": "true",
715
- "SCRIPTING_ENABLED": "true"
716
- }
717
- }
718
- }
719
- }
720
- ```
721
- 3. Restart Cursor. Ask in Chat: *"List all open P1 incidents"*
722
-
723
- **Multi-instance:** Replace the env block with `"SN_INSTANCES_CONFIG": "/path/to/instances.json"` to connect to multiple tenants.
724
-
725
- Full guide → [clients/cursor/SETUP.md](clients/cursor/SETUP.md)
726
- </details>
727
-
728
- <details>
729
- <summary><b>Windsurf (Codeium)</b> — AI-native editor</summary>
730
-
731
- 1. Open Windsurf → Cascade → Configure MCP
732
- 2. Add the same JSON block as Cursor above
733
- 3. Reload Windsurf window
734
-
735
- Full guide → [docs/CLIENT_SETUP.md](docs/CLIENT_SETUP.md)
736
- </details>
737
-
738
- <details>
739
- <summary><b>Zed Editor</b> — collaborative AI editor</summary>
740
-
741
- 1. Open Zed → `~/.config/zed/settings.json`
742
- 2. Add under `"context_servers"`:
743
-
744
- ```json
745
- {
746
- "context_servers": {
747
- "nowaikit": {
748
- "command": { "path": "node", "args": ["/path/to/nowaikit/dist/server.js"] },
749
- "settings": {
750
- "SERVICENOW_INSTANCE_URL": "https://yourinstance.service-now.com",
751
- "SERVICENOW_AUTH_METHOD": "basic",
752
- "SERVICENOW_BASIC_USERNAME": "admin",
753
- "SERVICENOW_BASIC_PASSWORD": "your_password"
754
- }
755
- }
756
- }
757
- }
758
- ```
759
-
760
- Full guide → [docs/CLIENT_SETUP.md](docs/CLIENT_SETUP.md)
761
- </details>
762
-
763
- ---
764
-
765
- ### IDE Extensions
766
-
767
- <details>
768
- <summary><b>VS Code</b> — Native MCP (v1.99+, no subscription required)</summary>
769
-
770
- VS Code 1.99 and later includes built-in MCP support — no extension or subscription required.
771
-
772
- 1. Install [VS Code 1.99+](https://code.visualstudio.com/download)
773
- 2. Create `.vscode/mcp.json` in your workspace (or edit User settings):
774
-
775
- ```json
776
- {
777
- "servers": {
778
- "nowaikit": {
779
- "type": "stdio",
780
- "command": "node",
781
- "args": ["/absolute/path/to/nowaikit/dist/server.js"],
782
- "env": {
783
- "SERVICENOW_INSTANCE_URL": "https://yourinstance.service-now.com",
784
- "SERVICENOW_AUTH_METHOD": "basic",
785
- "SERVICENOW_BASIC_USERNAME": "admin",
786
- "SERVICENOW_BASIC_PASSWORD": "your_password",
787
- "WRITE_ENABLED": "true",
788
- "SCRIPTING_ENABLED": "true"
789
- }
790
- }
791
- }
792
- }
793
- ```
794
-
795
- 3. Open the Command Palette (`Cmd/Ctrl+Shift+P`) → **MCP: List Servers** to verify the connection
796
- 4. Open Copilot Chat (or any AI assistant in VS Code) and use `@nowaikit` or just ask naturally
797
-
798
- > **Tip:** Add `.vscode/mcp.json` to `.gitignore` if it contains credentials, or use environment variables from a `.env` file.
799
-
800
- Full guide → [clients/vscode/SETUP.md](clients/vscode/SETUP.md)
801
- </details>
802
-
803
- <details>
804
- <summary><b>VS Code — GitHub Copilot</b> (agent mode)</summary>
805
-
806
- 1. Install VS Code + GitHub Copilot extension
807
- 2. Create `.vscode/mcp.json` in your project:
808
-
809
- ```json
810
- {
811
- "servers": {
812
- "nowaikit": {
813
- "type": "stdio",
814
- "command": "node",
815
- "args": ["${workspaceFolder}/../../nowaikit/dist/server.js"],
816
- "env": {
817
- "SERVICENOW_INSTANCE_URL": "https://yourinstance.service-now.com",
818
- "SERVICENOW_AUTH_METHOD": "basic",
819
- "SERVICENOW_BASIC_USERNAME": "admin",
49
+ "SERVICENOW_INSTANCE_URL": "https://yourcompany.service-now.com",
50
+ "SERVICENOW_BASIC_USERNAME": "your_username",
820
51
  "SERVICENOW_BASIC_PASSWORD": "your_password"
821
52
  }
822
53
  }
823
54
  }
824
55
  }
825
56
  ```
826
- 3. Open Copilot Chat → Agent mode → `@nowaikit`
827
-
828
- Full guide → [clients/vscode/SETUP.md](clients/vscode/SETUP.md)
829
- </details>
830
-
831
- <details>
832
- <summary><b>VS Code — Continue.dev</b> (open-source Copilot alternative)</summary>
833
-
834
- 1. Install [Continue](https://marketplace.visualstudio.com/items?itemName=Continue.continue) from VS Code Marketplace
835
- 2. Edit `~/.continue/config.json`:
836
-
837
- ```json
838
- {
839
- "mcpServers": [
840
- {
841
- "name": "nowaikit",
842
- "command": "node",
843
- "args": ["/path/to/nowaikit/dist/server.js"],
844
- "env": {
845
- "SERVICENOW_INSTANCE_URL": "https://yourinstance.service-now.com",
846
- "SERVICENOW_AUTH_METHOD": "basic",
847
- "SERVICENOW_BASIC_USERNAME": "admin",
848
- "SERVICENOW_BASIC_PASSWORD": "your_password"
849
- }
850
- }
851
- ]
852
- }
853
- ```
854
-
855
- Full guide → [docs/CLIENT_SETUP.md](docs/CLIENT_SETUP.md)
856
- </details>
857
-
858
- <details>
859
- <summary><b>VS Code — Cline</b> (autonomous AI agent)</summary>
860
-
861
- 1. Install [Cline](https://marketplace.visualstudio.com/items?itemName=saoudrizwan.claude-dev) from VS Code Marketplace
862
- 2. Open Cline → MCP Servers → Add Server
863
- 3. Enter the path to `nowaikit/dist/server.js` and your environment variables
864
-
865
- Full guide → [docs/CLIENT_SETUP.md](docs/CLIENT_SETUP.md)
866
- </details>
867
57
 
868
- <details>
869
- <summary><b>JetBrains AI Assistant</b> (IntelliJ IDEA, PyCharm, WebStorm, etc.)</summary>
58
+ OAuth, multiple instances, and per-client steps → **[Client setup](docs/CLIENT_SETUP.md)** · **[OAuth setup](docs/SERVICENOW_OAUTH_SETUP.md)**.
870
59
 
871
- 1. Install JetBrains AI Assistant plugin
872
- 2. Go to Settings → Tools → AI Assistant → MCP Servers
873
- 3. Add a new server with the path to `nowaikit/dist/server.js`
874
- 4. Set environment variables in the server configuration dialog
875
-
876
- Full guide → [docs/CLIENT_SETUP.md](docs/CLIENT_SETUP.md)
877
- </details>
878
-
879
- <details>
880
- <summary><b>Amazon Q Developer</b> (AWS CLI + IDE)</summary>
881
-
882
- 1. Install Amazon Q Developer extension for VS Code or IntelliJ
883
- 2. Configure MCP via `~/.aws/amazonq/mcp.json`:
884
-
885
- ```json
886
- {
887
- "mcpServers": {
888
- "nowaikit": {
889
- "command": "node",
890
- "args": ["/path/to/nowaikit/dist/server.js"],
891
- "env": {
892
- "SERVICENOW_INSTANCE_URL": "https://yourinstance.service-now.com",
893
- "SERVICENOW_AUTH_METHOD": "basic",
894
- "SERVICENOW_BASIC_USERNAME": "admin",
895
- "SERVICENOW_BASIC_PASSWORD": "your_password"
896
- }
897
- }
898
- }
899
- }
900
- ```
901
-
902
- Full guide → [docs/CLIENT_SETUP.md](docs/CLIENT_SETUP.md)
903
- </details>
904
-
905
- ---
906
-
907
- ### CLI & Terminal Agents
908
-
909
- <details>
910
- <summary><b>Claude Code / Claude CLI</b> — Anthropic's official CLI</summary>
911
-
912
- ```bash
913
- # Install Claude Code
914
- npm install -g @anthropic-ai/claude-code
915
-
916
- # Register NowAIKit as an MCP server
917
- claude mcp add nowaikit node /absolute/path/to/nowaikit/dist/server.js \
918
- --env SERVICENOW_INSTANCE_URL=https://yourinstance.service-now.com \
919
- --env SERVICENOW_AUTH_METHOD=basic \
920
- --env SERVICENOW_BASIC_USERNAME=admin \
921
- --env SERVICENOW_BASIC_PASSWORD=your_password
922
-
923
- # Verify
924
- claude mcp list
925
-
926
- # Use it
927
- claude "Show me all unresolved P1 incidents"
928
- ```
929
-
930
- Full guide → [clients/claude-code/SETUP.md](clients/claude-code/SETUP.md)
931
- </details>
932
-
933
- <details>
934
- <summary><b>Ollama</b> — run AI locally (Llama, Mistral, Phi, etc.)</summary>
935
-
936
- 1. Install [Ollama](https://ollama.ai) and pull a model: `ollama pull llama3`
937
- 2. Use an MCP-compatible client (e.g. Cline or Continue) configured to use Ollama as the model
938
- 3. Point the MCP server at `nowaikit/dist/server.js`
939
-
940
- Full guide → [docs/CLIENT_SETUP.md](docs/CLIENT_SETUP.md)
941
- </details>
60
+ No instance? Grab a free Personal Developer Instance at **[developer.servicenow.com](https://developer.servicenow.com)**.
942
61
 
943
62
  ---
944
63
 
945
- ### Programmatic / Agent SDK
946
-
947
- <details>
948
- <summary><b>OpenAI Codex / Custom Python Agent</b></summary>
949
-
950
- ```bash
951
- cd clients/codex
952
- pip install -r requirements.txt
953
- cp .env.basic.example .env # fill in your credentials
954
- python servicenow_openai_client.py
955
- ```
956
-
957
- Full guide → [clients/codex/SETUP.md](clients/codex/SETUP.md)
958
- </details>
959
-
960
- <details>
961
- <summary><b>Anthropic Agent SDK (Claude API)</b></summary>
962
-
963
- ```python
964
- import anthropic, subprocess, json
965
-
966
- # Start NowAIKit subprocess
967
- proc = subprocess.Popen(
968
- ["node", "/path/to/nowaikit/dist/server.js"],
969
- stdin=subprocess.PIPE, stdout=subprocess.PIPE,
970
- env={**os.environ,
971
- "SERVICENOW_INSTANCE_URL": "https://yourinstance.service-now.com",
972
- "SERVICENOW_AUTH_METHOD": "basic",
973
- "SERVICENOW_BASIC_USERNAME": "admin",
974
- "SERVICENOW_BASIC_PASSWORD": "your_password"}
975
- )
976
- # Then use with the Anthropic MCP client SDK
977
- ```
978
-
979
- See [Anthropic MCP Python SDK](https://github.com/modelcontextprotocol/python-sdk) for full integration.
980
- </details>
981
-
982
- ---
64
+ ## 💬 Use it — just ask
983
65
 
984
- ### Quick Reference
66
+ - *"How many active P1 incidents are open right now?"*
67
+ - *"Show me the 5 most recent changes and their risk."*
68
+ - *"Create a business rule on the incident table that…"*
69
+ - *"Run the ATF suite for the HR onboarding flow."*
70
+ - *"What's the CMDB health for our prod CIs?"*
985
71
 
986
- | Client | Type | Auth | Guide |
987
- |--------|------|------|-------|
988
- | Claude Desktop | Desktop app | Basic, OAuth | [Setup](clients/claude-desktop/SETUP.md) |
989
- | Claude Code CLI | Terminal | Basic, OAuth | [Setup](clients/claude-code/SETUP.md) |
990
- | Cursor | AI editor | Basic, OAuth | [Setup](clients/cursor/SETUP.md) |
991
- | Windsurf | AI editor | Basic, OAuth | [Setup](docs/CLIENT_SETUP.md) |
992
- | Zed | AI editor | Basic, OAuth | [Setup](docs/CLIENT_SETUP.md) |
993
- | **VS Code** (Native MCP 1.99+) | IDE | Basic, OAuth | [Setup](clients/vscode/SETUP.md) |
994
- | VS Code + GitHub Copilot | IDE | Basic, OAuth | [Setup](clients/vscode/SETUP.md) |
995
- | VS Code + Continue.dev | IDE | Basic, OAuth | [Setup](docs/CLIENT_SETUP.md) |
996
- | VS Code + Cline | IDE | Basic, OAuth | [Setup](docs/CLIENT_SETUP.md) |
997
- | JetBrains AI | IDE | Basic, OAuth | [Setup](docs/CLIENT_SETUP.md) |
998
- | Amazon Q Developer | IDE / CLI | Basic, OAuth | [Setup](docs/CLIENT_SETUP.md) |
999
- | ChatGPT / OpenAI | API | Basic, OAuth | [Setup](clients/codex/SETUP.md) |
1000
- | **Google AI Studio** | API / Agent | Basic, OAuth | [Setup](docs/CLIENT_SETUP.md) |
1001
- | Google Gemini API | API | Basic, OAuth | [Setup](clients/gemini/SETUP.md) |
1002
- | Grok (xAI) | API | Basic, OAuth | [Setup](docs/CLIENT_SETUP.md) |
1003
- | Ollama (local) | Local | Basic | [Setup](docs/CLIENT_SETUP.md) |
1004
- | Anthropic Agent SDK | Python | Basic, OAuth | [Setup](docs/CLIENT_SETUP.md) |
72
+ **Read-only by default.** Write, scripting and CMDB changes are opt-in flags — prod can't be modified by accident.
1005
73
 
1006
74
  ---
1007
75
 
1008
- ## What's New in v2.5
1009
-
1010
- ### Multi-provider AI chat in the Desktop app & Web Dashboard
1011
-
1012
- The nowaikit Desktop and Web Dashboard support **5 AI providers** side-by-side — with full agentic tool-use for all providers. All model lists are kept current with each provider's latest releases.
1013
-
1014
- - **Provider switcher** — one-click toggle between providers in the Chat header; per-provider model dropdown updates automatically
1015
- - **Claude (Anthropic)** — Opus 4.6 · Sonnet 4.6 · Haiku 4.5
1016
- - **ChatGPT / OpenAI** — GPT-5.2 · GPT-5.2 Pro · GPT-5.1 · GPT-5 mini · GPT-5 nano · GPT-4.1 · GPT-4o · o3 · o4 mini
1017
- - **Gemini (Google AI)** — Gemini 3.1 Pro · Gemini 3 Pro · Gemini 3 Flash · 2.5 Pro · 2.5 Flash · 2.5 Flash Lite
1018
- - **Groq (free)** — Llama 4 Maverick · Llama 4 Scout · Llama 3.3 70B · Llama 3.1 8B — ultra-fast inference, no credit card required
1019
- - **OpenRouter (200+ models)** — unified gateway to OpenAI o1 Pro · xAI Grok 4 · Claude Opus 4.6 · Gemini 2.5 Flash · DeepSeek R1 · Llama 4 Maverick · and more — many free tiers available
1020
- - **o3/o4 reasoning model support** — automatic detection skips system messages and switches to `max_completion_tokens`; tools not sent to models that don't support them
1021
-
1022
- ### In-app provider sign-in
1023
-
1024
- Settings → AI Providers now shows a unified **"Sign in to {Provider}"** flow per provider:
1025
-
1026
- 1. Click **Sign in to Claude / ChatGPT / Gemini / Groq / OpenRouter** — the provider's API key portal opens in your system browser
1027
- 2. Sign in to your account and create/copy an API key
1028
- 3. Paste it directly into the focused input that appears
1029
- 4. Click **Verify Key** — a lightweight validation call confirms the key is valid before you save
1030
-
1031
- Each provider panel shows a clear **subscription note** explaining that API access is separate from consumer subscriptions (Claude.ai Pro, ChatGPT Plus, Gemini Advanced). Groq and OpenRouter offer generous free tiers — no credit card required.
1032
-
1033
- ### Slash-command tool picker in Chat
1034
-
1035
- Type `/` in the chat input to open a floating picker over all 400+ ServiceNow tools:
1036
-
1037
- - Filter by tool name or description as you type
1038
- - `↑` / `↓` to navigate · **Tab** or **Enter** to select · **Esc** to close
1039
- - Inserts `/toolname` into your message — the AI knows to invoke that specific tool
1040
-
1041
- ### Other Desktop improvements
1042
-
1043
- - **Test Key button** — inline on the API key input; calls the provider's model-list endpoint to validate without sending a chat message
1044
- - **Server health auto-recovery** — polls every 8 seconds; "offline" status recovers automatically without restarting the app
1045
- - **Dashboard URL truncation** — long instance URLs are truncated with `…` (full URL on hover)
1046
- - **Bug fix: ChatGPT and Gemini responses now display correctly** — responses were being silently dropped due to a content-format mismatch between provider response conversion and the renderer; now fully fixed for both providers and the HTTP API server
1047
-
1048
- [Full changelog](CHANGELOG.md)
1049
-
1050
- ## What's New in v2.4
76
+ ## 📚 Docs
1051
77
 
1052
- ### Zero-config setup & desktop experience
1053
- - **`npx nowaikit setup`** — interactive wizard detects and writes config for every AI client automatically. No JSON editing.
1054
- - **nowaikit Desktop** cross-platform Electron app (macOS, Windows, Linux) with 8-step visual wizard, dashboard, tool browser, and audit log. No separate server install needed.
1055
- - **Web dashboard** served at `http://localhost:3100` by the HTTP server. Browse tools, view health, tail audit logs.
1056
-
1057
- ### Slash commands & @ mentions
1058
- - **11 built-in `/` slash commands** — `/morning-standup`, `/p1-alerts`, `/my-tickets`, `/create-incident`, `/sla-breaches`, `/ci-health`, `/run-atf`, `/switch-instance`, `/deploy-updateset`, and more
1059
- - **6 `@` mention resources** — `@my-incidents`, `@open-changes`, `@sla-breaches`, `@instance:info`, `@ci:<name>`, `@kb:<title>`
1060
- - Custom commands via `nowaikit.commands.json`
1061
-
1062
- ### Enterprise features
1063
- - **Audit logging** — every tool call logged to JSONL file + webhook (SIEM integration). Wired into both MCP and HTTP servers.
1064
- - **SSO / OIDC** — Okta/Entra/Ping IdP → ServiceNow token exchange. `GET /auth/login` + `/auth/callback` routes in HTTP server.
1065
- - **Org/team policy** (`nowaikit.org.json`) — admin-deployed config: allowed instances, locked tool packages, SSO enforcement, write controls. Deploy via MDM or GPO.
1066
- - **Per-user execution context** — auth modes: `service-account`, `per-user` (OAuth Authorization Code), `impersonation`. Queries respect each user's ServiceNow ACLs.
1067
-
1068
- ### App builder integrations
1069
- - **HTTP API server** (`npm run serve`) — REST proxy for Lovable, Bolt, v0, Replit apps. Keeps credentials server-side.
1070
- - **Smithery registry** — `smithery install nowaikit` one-command install.
1071
-
1072
- [Full changelog](CHANGELOG.md)
1073
-
1074
- ## What's New in v2.3
1075
-
1076
- - **Scoped Application (App Studio) module** — `list_scoped_apps`, `get_scoped_app`, `create_scoped_app`, `update_scoped_app`
1077
- - **Create/update reports** — `create_report`, `update_report` added to Reporting module
1078
- - **Create/update dashboards** — `create_dashboard`, `update_dashboard` added to Performance Analytics
1079
- - **Create portals & pages** — `create_portal`, `create_portal_page` added to Service Portal module
1080
- - **Create/update catalog items** — `create_catalog_item`, `update_catalog_item` added to Catalog module
1081
- - **Approval rules** — `create_approval_rule` for automated approval workflow setup
1082
- [Full changelog](CHANGELOG.md)
1083
-
1084
- ## What's New in v2.2
1085
-
1086
- - **5 new modules**: System Properties, Update Set Management, Virtual Agent authoring, IT Asset Management, DevOps & Pipeline Tracking
1087
- - **True multi-instance & multi-customer support** — connect to unlimited instances (dev, staging, prod, customer tenants) simultaneously from one session
1088
- - **Per-call instance routing** — pass `instance: "name"` to any tool, or `switch_instance` globally
1089
- - **2 new role packages** — `devops_engineer`, `itam_analyst`
1090
- - `system_administrator` package extended with system properties and update set tools
1091
- [Full changelog](CHANGELOG.md)
1092
-
1093
- ### v2.1 highlights
1094
-
1095
- - **4 new modules**: Service Portal & UI Builder, Integration Hub, Notifications & Attachments, Performance Analytics
1096
- - **Scripting enhancements** — UI Policies, UI Actions, ACL management
1097
- - **Reporting enhancements** — scheduled job CRUD + run history
1098
- - **Now Assist** — `generate_work_notes` AI-drafted work notes for any record
1099
- - **2 new role packages** — `portal_developer`, `integration_engineer`
1100
- - **Binary file upload** — `uploadAttachment()` via ServiceNow Attachment API
1101
-
1102
- ## What's New in v2.0
1103
-
1104
- - **HRSD module** — HR cases, services, profiles, onboarding/offboarding workflows
1105
- - **CSM module** — Customer cases, accounts, contacts, products, SLA tracking
1106
- - **Security Operations & GRC** — SecOps incidents, vulnerabilities, risks, controls, threat intel
1107
- - **Flow Designer** — List, inspect, trigger, and monitor flows and subflows
1108
- - **OAuth 2.0** for all AI clients
1109
- - **Role-based tool packages** — persona-specific packages
1110
- - **Now Assist Agentic Playbooks** — AI automation
1111
- - **ATF Failure Insight** — test failure diagnostics
1112
- - **61 unit tests** covering all permission tiers, routing, and domain handlers
1113
- - **Complete documentation** — reference guides in `docs/`
1114
-
1115
- ---
1116
-
1117
- ## Documentation
1118
-
1119
- | Guide | Description |
1120
- |-------|-------------|
1121
- | [docs/TOOLS.md](docs/TOOLS.md) | Complete reference for all tools with parameters, return types, and permission requirements |
1122
- | [docs/CLIENT_SETUP.md](docs/CLIENT_SETUP.md) | Step-by-step beginner + advanced setup for all AI clients (Claude, ChatGPT, Gemini, Cursor, VS Code, Windsurf, Continue, Cline, Codex, JetBrains, Ollama) |
1123
- | [docs/TOOL_PACKAGES.md](docs/TOOL_PACKAGES.md) | Role-based package reference — which tools each of the 14 persona packages includes |
1124
- | [docs/NOW_ASSIST.md](docs/NOW_ASSIST.md) | Now Assist and AI integration guide — NLQ, AI Search, Agentic Playbooks |
1125
- | [docs/ATF.md](docs/ATF.md) | ATF testing guide — suites, test runs, ATF Failure Insight |
1126
- | [docs/SCRIPTING.md](docs/SCRIPTING.md) | Scripting management — business rules, script includes, UI Policies, UI Actions, ACLs, changesets |
1127
- | [docs/REPORTING.md](docs/REPORTING.md) | Reporting and analytics — aggregate queries, Performance Analytics, scheduled jobs |
1128
- | [docs/MULTI_INSTANCE.md](docs/MULTI_INSTANCE.md) | Multi-instance configuration via `instances.json` or environment variables |
1129
- | [docs/SERVICENOW_OAUTH_SETUP.md](docs/SERVICENOW_OAUTH_SETUP.md) | Creating an OAuth application in ServiceNow for secure API access |
1130
- | [docs/INSTALLATION.md](docs/INSTALLATION.md) | Full installation guide including wizard, enterprise config, SSO, and audit logging |
1131
- | [clients/lovable/SETUP.md](clients/lovable/SETUP.md) | HTTP API server — integrate with Lovable, Bolt, v0, Replit apps |
1132
- | [desktop/BUILDING.md](desktop/BUILDING.md) | Build and code-sign the Electron desktop app |
1133
- | [EXAMPLES.md](EXAMPLES.md) | 120+ real-world examples with inputs, outputs, and advanced workflows |
1134
-
1135
- ---
1136
-
1137
- ## Development
1138
-
1139
- ```bash
1140
- npm install # install dependencies
1141
- npm run build # compile TypeScript → dist/
1142
- npm test # run unit tests
1143
- npm run dev # watch mode (hot reload)
1144
- npm run type-check # TypeScript type check only
1145
- npm run lint # lint
1146
- ```
1147
-
1148
- ### Project Structure
1149
-
1150
- ```
1151
- src/
1152
- server.ts — MCP server entry point (stdio)
1153
- http-server.ts — HTTP API server (REST proxy for web apps)
1154
- servicenow/
1155
- client.ts — ServiceNow REST API client (Basic / OAuth / per-user)
1156
- instances.ts — Multi-instance manager
1157
- types.ts — TypeScript type definitions + AuthMode
1158
- tools/
1159
- index.ts — Tool router & role-based package system
1160
- core.ts, incident.ts, change.ts, problem.ts, task.ts
1161
- knowledge.ts, catalog.ts, user.ts, reporting.ts, atf.ts
1162
- now-assist.ts, script.ts, agile.ts, hrsd.ts, csm.ts
1163
- security.ts, flow.ts, portal.ts, integration.ts, notification.ts
1164
- performance.ts, sys-properties.ts, updateset.ts, va.ts, itam.ts, devops.ts
1165
- prompts/
1166
- index.ts — MCP prompts registry (/ slash commands)
1167
- itsm.ts — 11 built-in slash commands
1168
- user-prompts.ts — Custom commands from nowaikit.commands.json
1169
- resources/
1170
- index.ts — MCP resources (@ mentions)
1171
- auth/
1172
- sso.ts — OIDC/SSO module (IdP → ServiceNow token exchange)
1173
- dashboard/
1174
- html.ts — Web dashboard (served at GET /)
1175
- cli/
1176
- index.ts — CLI entry point (commander.js)
1177
- setup.ts — Interactive setup wizard
1178
- detect-clients.ts — Auto-detect installed AI clients
1179
- config-store.ts — ~/.config/nowaikit/instances.json
1180
- auth.ts — nowaikit auth login/logout/whoami
1181
- writers/index.ts — Write configs to AI client config files
1182
- utils/
1183
- permissions.ts — Five-tier permission gate functions
1184
- audit.ts — Structured JSONL audit logger + webhook
1185
- org-config.ts — Org/team policy loader (nowaikit.org.json)
1186
- errors.ts — Typed error classes
1187
- logging.ts — Structured logger
1188
- desktop/
1189
- main/ — Electron main process (Node.js)
1190
- renderer/src/ — React 18 UI (Vite)
1191
- electron-builder.yml — Cross-platform packaging config
1192
- BUILDING.md — Desktop build & code-signing guide
1193
- tests/
1194
- tools/ — Unit tests
1195
- docs/ — Reference documentation
1196
- clients/
1197
- claude-desktop/ — Claude Desktop setup guide
1198
- cursor/ — Cursor setup guide
1199
- vscode/ — VS Code setup guide
1200
- claude-code/ — Claude Code setup guide
1201
- lovable/ — Lovable/Bolt/v0/Replit HTTP proxy guide
1202
- codex/ — OpenAI Codex Python client
1203
- gemini/ — Google Gemini Python client
1204
- smithery.yaml — Smithery registry config
1205
- ```
1206
-
1207
- ---
1208
-
1209
- ## Contributing
1210
-
1211
- Contributions are welcome. Please read [CONTRIBUTING.md](CONTRIBUTING.md) before opening a pull request.
1212
-
1213
- - Bug reports and feature requests: [open an issue](../../issues)
1214
- - New tool domains, additional tests, or documentation improvements are especially appreciated
1215
- - All PRs require `npm test` to pass
1216
-
1217
- ---
1218
-
1219
- ## Security
78
+ | | |
79
+ |---|---|
80
+ | [Installation](docs/INSTALLATION.md) · [Client setup](docs/CLIENT_SETUP.md) | [All 450+ tools](docs/TOOLS.md) · [Tool packages](docs/TOOL_PACKAGES.md) |
81
+ | [Multi-instance](docs/MULTI_INSTANCE.md) · [OAuth](docs/SERVICENOW_OAUTH_SETUP.md) | [Scripting](docs/SCRIPTING.md) · [ATF](docs/ATF.md) · [Reporting](docs/REPORTING.md) |
1220
82
 
1221
- If you discover a security vulnerability, please follow the responsible disclosure process in [SECURITY.md](SECURITY.md). Do not open a public issue.
83
+ Full guides & product home **[nowaikit.com](https://nowaikit.com)**
1222
84
 
1223
85
  ---
1224
86
 
1225
- ## Frequently Asked Questions
1226
-
1227
- **Do I need to know the ServiceNow API to use this?**
1228
- No. For beginners, you just connect your AI and ask questions in plain English. The kit handles all API calls automatically.
1229
-
1230
- **Which ServiceNow versions are supported?**
1231
- All actively supported ServiceNow releases. The toolkit targets the latest available APIs and has been tested on the three most recent releases — **Australia**, **Zurich**, and **Yokohama** — and works on any currently supported instance.
1232
-
1233
- **Can I use this on a free Personal Developer Instance (PDI)?**
1234
- Yes. Get a free PDI at [developer.servicenow.com](https://developer.servicenow.com) and connect in 5 minutes.
1235
-
1236
- **Is it safe to use on production?**
1237
- Yes. The permission system is read-only by default. Write, scripting, and Now Assist capabilities must each be explicitly enabled with environment variables. Use role packages to limit the tool surface.
1238
-
1239
- **Can I use multiple AI providers at the same time?**
1240
- Yes. Each AI client gets its own MCP config pointing at the same (or different) NowAIKit instance. Run Claude Desktop and Cursor side by side against the same ServiceNow environment. In the nowaikit Desktop app you can switch between Claude, ChatGPT, and Gemini with one click inside the Chat page.
1241
-
1242
- **Does it support multi-instance / multiple customers?**
1243
- Yes. Configure any number of instances (prod, staging, dev, or multiple customer tenants) via `instances.json` or environment variables. Use `list_instances`, `switch_instance`, and `get_current_instance` tools to manage them, or pass `instance: "name"` to any individual tool call. See [docs/MULTI_INSTANCE.md](docs/MULTI_INSTANCE.md).
87
+ ## 🧩 Part of the NowAIKit suite
1244
88
 
1245
- **Is it free?**
1246
- Completely free to use for personal and commercial purposes. See [LICENSE](LICENSE) for details.
1247
-
1248
- ---
1249
-
1250
- ## License
89
+ - 🌐 **[nowaikit.com](https://nowaikit.com)** docs, guides & product home
90
+ - ☁️ **[NowAIKit Cloud](https://cloud.nowaikit.com)** the toolkit in your browser, no install
91
+ - 📦 **[`nowaikit-sdk`](https://www.npmjs.com/package/nowaikit-sdk)** — TypeScript ServiceNow client library
92
+ - 🧰 **NowAIKit Builder** (VS Code) · **NowAIKit Utils** (browser extension)
1251
93
 
1252
- [Source Available](LICENSE) free to use for personal and commercial purposes. See LICENSE for details.
94
+ > **⚠️ Official distribution only:** install from **npm (`nowaikit`)** or **[nowaikit.com](https://nowaikit.com)**. NowAIKit is never shipped as a downloadable GitHub `.zip` beware copycat "download" repos.
1253
95
 
1254
96
  ---
1255
97
 
1256
- <div align="center">
1257
-
1258
- ### The only ServiceNow AI toolkit you'll ever need.
1259
-
1260
- 400+ tools. 31+ modules. Every AI platform. True multi-instance. Free to use.
1261
-
1262
- **NowAIKit** &bull; ServiceNow MCP Server &bull; ServiceNow AI Agent &bull; ServiceNow Claude Integration &bull; ServiceNow ChatGPT &bull; ServiceNow Cursor &bull; ServiceNow Gemini &bull; ServiceNow Automation &bull; ServiceNow Developer Tools &bull; ServiceNow Multi-Instance &bull; ServiceNow MSP
1263
-
1264
- If NowAIKit saves you time, please ⭐ star the repository — it helps others find the project.
1265
-
1266
- [![GitHub Stars](https://img.shields.io/github/stars/aartiq/nowaikit?style=social)](../../stargazers)
1267
-
1268
- Built by Hardik Benani · [AartiQ](https://nowaikit.com)
1269
-
1270
- </div>
98
+ © 2026 AartiQ (Hardik Benani) · [NowAIKit Source Available License](LICENSE)