Skip to content

local-development.md

Latest commit

 

History

History
79 lines (53 loc) · 1.58 KB

local-development.md

File metadata and controls

79 lines (53 loc) · 1.58 KB

docs / getting-started / local-development

Local Development

1. Install Dependencies

npm install

2. Configure Environment

Copy the example environment file and fill in your values:

cp .env.example .env

Generate an Encryption Key

The server encrypts OAuth tokens at rest with AES-256-GCM. Generate a 32-byte key:

npm run generate-key

Paste the output into TOKEN_ENCRYPTION_KEY in your .env.

Required Variables

At minimum, set these in .env:

SERVICENOW_INSTANCE_URL=https://yourorg.service-now.com
SERVICENOW_CLIENT_ID=<from SN OAuth app>
SERVICENOW_CLIENT_SECRET=<from SN OAuth app>
TOKEN_ENCRYPTION_KEY=<base64 32-byte key>
ALLOWED_ORIGINS=https://claude.ai

See Environment Variables for the full configuration reference.

3. Start the Dev Server

npm run dev

This runs the server with tsx in watch mode on port 8080 (or MCP_PORT).

4. Verify

curl -s http://localhost:8080/health | jq

Expected response:

{
  "status": "healthy",
  "uptime": 1.234,
  "redis": "connected",
  "timestamp": "2026-03-11T..."
}

If Redis shows "disconnected", check that Redis is running and REDIS_URL is correct. See Troubleshooting.

Build Check

npm run build    # TypeScript compilation
npm test         # Run all tests

See also: Prerequisites · ServiceNow OAuth Setup · First Tool Call