Skip to main content

A comprehensive MCP server for ServiceNow - platform introspection, ITSM workflows, CMDB operations, change intelligence, debugging, investigations, and documentation generation.

Project description

servicenow-platform-mcp banner

PyPI version Python versions License

servicenow-platform-mcp

A comprehensive Model Context Protocol (MCP) server for ServiceNow. Provides a comprehensive suite of tools across 20 tool groups for platform introspection, change intelligence, debugging, record management, ITSM workflows, CMDB operations, service catalog, automated investigations, documentation generation, and Flow Designer analysis.

Quick Start

1. Set environment variables:

export SERVICENOW_INSTANCE_URL=https://your-instance.service-now.com
export SERVICENOW_USERNAME=admin
export SERVICENOW_PASSWORD=your-password

2. Run the server:

uvx servicenow-platform-mcp

3. Connect your MCP client (see Configuration below).

Configuration

OpenCode

Add to ~/.config/opencode/opencode.json:

{
  "mcp": {
    "servicenow": {
      "type": "local",
      "command": ["uvx", "servicenow-platform-mcp"],
      "environment": {
        "SERVICENOW_INSTANCE_URL": "https://your-instance.service-now.com",
        "SERVICENOW_USERNAME": "admin",
        "SERVICENOW_PASSWORD": "your-password"
      }
    }
  }
}

Claude Desktop

Add to claude_desktop_config.json:

{
  "mcpServers": {
    "servicenow": {
      "command": "uvx",
      "args": ["servicenow-platform-mcp"],
      "env": {
        "SERVICENOW_INSTANCE_URL": "https://your-instance.service-now.com",
        "SERVICENOW_USERNAME": "admin",
        "SERVICENOW_PASSWORD": "your-password"
      }
    }
  }
}

VS Code / Cursor

Add to .vscode/mcp.json:

{
  "servers": {
    "servicenow": {
      "command": "uvx",
      "args": ["servicenow-platform-mcp"],
      "env": {
        "SERVICENOW_INSTANCE_URL": "https://your-instance.service-now.com",
        "SERVICENOW_USERNAME": "admin",
        "SERVICENOW_PASSWORD": "your-password"
      }
    }
  }
}

Generic stdio

SERVICENOW_INSTANCE_URL=https://your-instance.service-now.com \
SERVICENOW_USERNAME=admin \
SERVICENOW_PASSWORD=your-password \
uvx servicenow-platform-mcp

Environment Variables

Variable Description Default Required
SERVICENOW_INSTANCE_URL Full URL (must start with https://) - Yes
SERVICENOW_USERNAME ServiceNow username - Yes
SERVICENOW_PASSWORD ServiceNow password - Yes
MCP_TOOL_PACKAGE Tool package to load full No
SERVICENOW_ENV Environment label (dev/test/staging/prod) dev No
MAX_ROW_LIMIT Max rows per query (1-10000) 100 No
LARGE_TABLE_NAMES_CSV Tables requiring date filters syslog,sys_audit,sys_log_transaction,sys_email_log No
SCRIPT_ALLOWED_ROOT Root dir for script_path in artifact write "" (disabled) When using script_path
SENTRY_DSN Sentry DSN for error reporting "" No
SENTRY_ENVIRONMENT Sentry environment label Falls back to SERVICENOW_ENV No

The server reads from .env and .env.local files automatically.

AI Agent Setup

Copy and paste this prompt to your AI agent (Claude Code, Cursor, OpenCode, etc.):

Install and configure servicenow-platform-mcp by following the instructions here:
https://raw.githubusercontent.com/Xerrion/servicenow-platform-mcp/refs/heads/main/INSTALL.md

Or read the Installation Guide directly.

Key Features

  • Platform introspection - describe tables, query records, inspect metadata, compute aggregates
  • Change intelligence - update set inspection, artifact diffs, audit trails, release notes
  • Debug and trace - event timelines, flow execution, email tracing, import sets, field mutations
  • Record management - full CRUD with preview-then-apply safety pattern
  • Artifact management - create/update business rules, script includes, and 15+ artifact types with local script file support
  • ITSM workflows - incident, change, problem lifecycle management
  • CMDB operations - browse CIs, relationships, classes, and health checks
  • Service catalog - browse, order, cart management, checkout
  • Knowledge management - search, create, update articles and feedback
  • Investigations - automated analysis of stale automations, deprecated APIs, ACL conflicts, performance bottlenecks
  • Documentation generation - logic maps, artifact summaries, test scenarios, review notes
  • Flow Designer - inspect flows, actions, executions, snapshots, migration analysis

Tool Packages

Control which tools are loaded with MCP_TOOL_PACKAGE. There are 14 preset packages:

Package Groups Description
full 20 All standard tools (default)
core_readonly 4 Read-only core tools
none 0 No tools loaded
itil 16 ITIL process tools
developer 13 Development-focused tools
readonly 10 Read-only operations
analyst 8 Analysis and reporting
incident_management 9 Incident lifecycle
change_management 8 Change request tools
cmdb 6 CMDB management
problem_management 9 Problem lifecycle
request_management 8 Request/RITM tools
knowledge_management 6 Knowledge base tools
service_catalog 6 Service catalog tools

You can also create custom packages with comma-separated group names (e.g. MCP_TOOL_PACKAGE="table,record,debug"). See the Wiki for full package and tool group details.

Safety

  • Table deny list - blocks access to sensitive system tables (sys_user_has_password, oauth_credential, sys_credentials, etc.)
  • Sensitive field masking - password, token, secret, and similar fields are automatically masked
  • Write gating - all write operations blocked when SERVICENOW_ENV is set to prod or production
  • Row limits and large table protection - prevents runaway queries with configurable caps and mandatory date filters

These guardrails reduce risk but are not a guarantee - always validate in a sub-production environment.

See the Safety & Policy wiki page for complete details.

Development

git clone https://github.com/Xerrion/servicenow-platform-mcp.git
cd servicenow-platform-mcp
uv sync --group dev
uv run pytest                  # Run tests
uv run ruff check .            # Lint
uv run ruff format .           # Format
uv run mypy src/               # Type check

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

servicenow_platform_mcp-0.9.1.tar.gz (274.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

servicenow_platform_mcp-0.9.1-py3-none-any.whl (120.5 kB view details)

Uploaded Python 3

File details

Details for the file servicenow_platform_mcp-0.9.1.tar.gz.

File metadata

File hashes

Hashes for servicenow_platform_mcp-0.9.1.tar.gz
Algorithm Hash digest
SHA256 c83eee3edf904ec23d85031c41890faa4e1db9410e5cc0feee73555e593fa165
MD5 54649de52633d5d2ef02acea355bd697
BLAKE2b-256 c7e593b602069ec471032224478b55c6e824746e01c27759e6c8da57c2b438f2

See more details on using hashes here.

File details

Details for the file servicenow_platform_mcp-0.9.1-py3-none-any.whl.

File metadata

File hashes

Hashes for servicenow_platform_mcp-0.9.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c1eeb844c6fb81eb18bc18c6daa0c1198cbc2138d25e7390b364a4b944a4fdb7
MD5 45a25eb5fe439568686219bf5754f3f6
BLAKE2b-256 953cc5d0ed18d31fbfdd36d1af9992b530bf7daa18d72752f36e2aad20a166d9

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page