nowaikit — Installation Guide

$ npm install -g nowaikit
$ npx nowaikit setup

$ nowaikit setup --add         # Add a second instance
$ nowaikit instances list      # List configured instances
$ nowaikit instances remove dev # Remove an instance
$ nowaikit auth login          # Per-user OAuth login
$ nowaikit auth whoami         # Show active ServiceNow user

# Make executable and move to PATH
$ chmod +x nowaikit-macos-arm64
$ sudo mv nowaikit-macos-arm64 /usr/local/bin/nowaikit
$ nowaikit setup

# Move to a folder in your PATH, then run:
> .\nowaikit-Setup-2.4.0.exe setup

$ git clone https://github.com/aartiq/nowaikit.git
$ cd nowaikit
$ npm install
$ npm run build

$ cp .env.example .env

SERVICENOW_INSTANCE_URL=https://yourcompany.service-now.com
SERVICENOW_AUTH_METHOD=basic
SERVICENOW_BASIC_USERNAME=your_username
SERVICENOW_BASIC_PASSWORD=your_password

{
  "mcpServers": {
    "nowaikit": {
      "command": "npx",
      "args": ["-y", "nowaikit"],
      "env": {
        "SERVICENOW_INSTANCE_URL": "https://yourinstance.service-now.com",
        "SERVICENOW_AUTH_METHOD": "basic",
        "SERVICENOW_BASIC_USERNAME": "admin",
        "SERVICENOW_BASIC_PASSWORD": "your_password"
      }
    }
  }
}

$ TRANSPORT=sse npx nowaikit

# Test SSE connection
$ curl -N http://localhost:3000/sse

# Send a message
$ curl -X POST http://localhost:3000/messages \
  -H 'Content-Type: application/json' \
  -d '{"jsonrpc":"2.0","method":"tools/list","id":1}'

$ TRANSPORT=http npx nowaikit

$ curl -X POST http://localhost:3000/mcp \
  -H 'Content-Type: application/json' \
  -d '{"jsonrpc":"2.0","method":"tools/list","id":1}'

NOWAIKIT_API_KEY=your-secret-api-key

$ curl -X POST http://localhost:3000/mcp \
  -H 'Authorization: Bearer your-secret-api-key' \
  -H 'Content-Type: application/json' \
  -d '{"jsonrpc":"2.0","method":"tools/list","id":1}'

# List all tools
$ curl http://localhost:3000/api/tools

# Execute a tool
$ curl -X POST http://localhost:3000/api/tool \
  -H 'Content-Type: application/json' \
  -d '{"name":"get_incident","arguments":{"number_or_sysid":"INC0010001"}}'

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

# Send a task
$ curl -X POST http://localhost:3000/a2a/tasks/send \
  -H 'Content-Type: application/json' \
  -d '{"task":{"message":"List my open P1 incidents"}}'

# Start with SSE transport and open dashboard
$ TRANSPORT=sse npx nowaikit
# Then open http://localhost:3000 in your browser

# Stdio transport (default — no TRANSPORT variable needed)
SERVICENOW_INSTANCE_URL=https://yourinstance.service-now.com
SERVICENOW_AUTH_METHOD=basic
SERVICENOW_BASIC_USERNAME=admin
SERVICENOW_BASIC_PASSWORD=your_password

TRANSPORT=sse
PORT=3000
HOST=0.0.0.0
CORS_ORIGIN=https://myapp.example.com
NOWAIKIT_API_KEY=my-secret-key-here

SERVICENOW_INSTANCE_URL=https://yourinstance.service-now.com
SERVICENOW_AUTH_METHOD=oauth
SERVICENOW_OAUTH_CLIENT_ID=your_client_id
SERVICENOW_OAUTH_CLIENT_SECRET=your_client_secret
SERVICENOW_OAUTH_USERNAME=svc_account
SERVICENOW_OAUTH_PASSWORD=svc_password

WRITE_ENABLED=true
MCP_TOOL_PACKAGE=full

TRANSPORT=http
PORT=8080
HOST=127.0.0.1
CORS_ORIGIN=*
NOWAIKIT_API_KEY=my-secret-key-here

SERVICENOW_INSTANCE_URL=https://yourinstance.service-now.com
SERVICENOW_AUTH_METHOD=oauth
SERVICENOW_OAUTH_CLIENT_ID=your_client_id
SERVICENOW_OAUTH_CLIENT_SECRET=your_client_secret
SERVICENOW_OAUTH_USERNAME=svc_account
SERVICENOW_OAUTH_PASSWORD=svc_password

WRITE_ENABLED=true
MCP_TOOL_PACKAGE=full

# Terminal 1 — start the server
$ TRANSPORT=http PORT=3000 NOWAIKIT_API_KEY=my-key npx nowaikit

# Terminal 2 — call a tool via REST API
$ curl -X POST http://localhost:3000/api/tool \
  -H 'Authorization: Bearer my-key' \
  -H 'Content-Type: application/json' \
  -d '{"name":"get_incident","arguments":{"number_or_sysid":"INC0010001"}}'

# Use discover_table to auto-generate CRUD tools for any table
$ curl -X POST http://localhost:3000/api/tool \
  -H "Authorization: Bearer $NOWAIKIT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"discover_table","arguments":{"table_name":"u_custom_app"}}'

# 1. Discover the agent
$ curl http://localhost:3000/.well-known/agent.json

# 2. Send a task via A2A
$ curl -X POST http://localhost:3000/a2a/tasks/send \
  -H "Content-Type: application/json" \
  -d '{"task":{"message":"Create a P2 incident for slow VPN performance"}}'

# Start SSE server
$ TRANSPORT=sse PORT=3000 npx nowaikit

# Connect to SSE stream (long-lived connection)
$ curl -N http://localhost:3000/sse

# Send an MCP message
$ curl -X POST http://localhost:3000/messages \
  -H 'Content-Type: application/json' \
  -d '{"jsonrpc":"2.0","method":"tools/list","id":1}'

"List my 5 most recent open incidents"