Skip to main content

MCP server for LLM agents to interact with PagerDuty SaaS

Project description

PagerDuty MCP Server

A server that exposes PagerDuty API functionality to LLMs. This server is designed to be used programmatically, with structured inputs and outputs.

PagerDuty Server MCP server

PyPI Downloads Python Versions GitHub Contributors PyPI version License

Overview

The PagerDuty MCP Server provides a set of tools for interacting with the PagerDuty API. These tools are designed to be used by LLMs to perform various operations on PagerDuty resources such as incidents, services, teams, and users.

Getting Started

  1. Initialize your local Python environment:
cd pagerduty-mcp-server
brew install uv
uv sync
  1. Configure authentication (see Authentication below).

Authentication

Priority: X-PagerDuty-Token HTTP header > PAGERDUTY_API_TOKEN environment variable > OAuth 2.0 PKCE

Option 1: X-PagerDuty-Token Header (Platform Integration)

When running as part of a platform that injects per-request credentials, the server reads the X-PagerDuty-Token HTTP header. This takes highest priority and does not require any local configuration.

Option 2: API Token (Recommended for Most Users)

Set the PAGERDUTY_API_TOKEN environment variable, or add it to a .env file in the project root. The server will automatically load environment variables from the .env file if present.

Environment variable:

export PAGERDUTY_API_TOKEN=your_api_token_here

.env file (recommended):

echo "PAGERDUTY_API_TOKEN=your_api_token_here" > .env

Option 3: OAuth 2.0 PKCE (Local Interactive Use)

OAuth is available for local standalone usage. It opens a browser for authentication and stores tokens securely in the OS keyring. OAuth is opt-in — it only activates when PAGERDUTY_CLIENT_ID is set and no API token is present.

Setup:

  1. Register a PagerDuty OAuth application at Integrations → Developer Tools → My Apps.
  2. Set the required scope to read write.
  3. Set the redirect URI to http://localhost:5173/oauth/pagerduty (default port).
  4. Set the PAGERDUTY_CLIENT_ID environment variable to your application's client ID.

Optional configuration:

  • Set PAGERDUTY_CLIENT_SECRET to enable token refresh (confidential client).
  • Set PAGERDUTY_OAUTH_CALLBACK_PORT to override the default callback port (5173).

Usage

Claude/Cursor

{
  "mcpServers": {
    "pagerduty-mcp-server": {
      "command": "uvx",
      "args": ["pagerduty-mcp-server"],
      "env": {
          "PAGERDUTY_API_TOKEN": "<PAGERDUTY_API_TOKEN>"
      }
    }
  }
}

As Standalone Server

uv run path/to/repo/pagerduty-mcp-server/.venv/bin/pagerduty-mcp-server

Available Tools

Read Tools

  • get_escalation_policies — List or get details for escalation policies
  • get_incidents — List or get details for incidents (supports filtering by status, urgency, service, team, and time range)
  • get_oncalls — List on-call entries for a time range
  • get_schedules — List or get details for schedules
  • get_services — List or get details for services
  • get_teams — List or get details for teams
  • get_users — List or get details for users
  • list_users_oncall — List users on call for a specific schedule
  • build_user_context — Build a context object for the current authenticated user

Write Tools

  • acknowledge_incident — Acknowledge an incident (signals active investigation)
  • resolve_incident — Resolve an incident (stops further escalations)
  • add_incident_note — Add a note to an incident (for recording investigation progress or context)

The include Parameter

Most read tools accept an optional include parameter — a list of field names to return. When specified, only those fields are included in each response object, which reduces token usage in LLM contexts.

# Return only id, title, and status for each incident
get_incidents(include=["id", "title", "status"])

# Return only id and name for each service
get_services(include=["id", "name"])

See the tool documentation for the full list of available fields per tool.

Response Format

All API responses follow a consistent format:

{
  "metadata": {
    "count": "<int>",
    "description": "<str>"
  },
  "<resource_type>": [
    {
      "...": "..."
    }
  ],
  "error": {
    "message": "<str>",
    "code": "<str>"
  }
}

The error field is only present when an error occurs. Resource names in responses are always pluralized for consistency, even when a single item is returned.

Error Handling

When an error occurs, the response will include an error object with the following structure:

{
  "metadata": {
    "count": 0,
    "description": "Error occurred while processing request"
  },
  "error": {
    "message": "Invalid user ID provided",
    "code": "INVALID_USER_ID"
  }
}

Common error scenarios include:

  • Invalid resource IDs (e.g., user_id, team_id, service_id)
  • Missing required parameters
  • Invalid parameter values
  • API request failures
  • Response processing errors

Parameter Validation

  • All ID parameters must be valid PagerDuty resource IDs
  • Date parameters must be valid ISO8601 timestamps
  • List parameters (e.g., statuses, team_ids) must contain valid values
  • Invalid values in list parameters will be ignored
  • Required parameters cannot be None or empty strings
  • For statuses in get_incidents, only triggered, acknowledged, and resolved are valid values
  • For urgency in incidents, only high and low are valid values
  • The limit parameter can be used to restrict the number of results returned by list operations

Rate Limiting and Pagination

  • The server respects PagerDuty's rate limits
  • The server automatically handles pagination for you
  • The limit parameter can be used to control the number of results returned by list operations
  • If no limit is specified, the server will return up to pagerduty_mcp_server.utils.RESPONSE_LIMIT results by default

User Context

Many functions accept a current_user_context parameter (defaults to True) which automatically filters results based on this context. When current_user_context is True, you cannot use certain filter parameters as they would conflict with the automatic filtering:

  • For all resource types:
    • user_ids cannot be used with current_user_context=True
  • For incidents:
    • team_ids and service_ids cannot be used with current_user_context=True
  • For services:
    • team_ids cannot be used with current_user_context=True
  • For escalation policies:
    • team_ids cannot be used with current_user_context=True
  • For on-calls:
    • user_ids cannot be used with current_user_context=True
    • schedule_ids can still be used to filter by specific schedules
    • The query will show on-calls for all escalation policies associated with the current user's teams
    • This is useful for answering questions like "who is currently on-call for my team?"
    • The current user's ID is not used as a filter, so you'll see all team members who are on-call

Development

Running Tests

The test suite includes both unit tests and integration tests. Integration tests require a real connection to the PagerDuty API, while unit tests can run without API access.

The pytest-cov args are optional, use them to include a test coverage report in the output.

To run all tests (integration tests will be automatically skipped if PAGERDUTY_API_TOKEN is not set):

uv run pytest [--cov=src --cov-report=term-missing]

To run only unit tests (no API token required):

uv run pytest -m unit [--cov=src --cov-report=term-missing]

To run only integration tests (requires PAGERDUTY_API_TOKEN set in environment):

uv run pytest -m integration [--cov=src --cov-report=term-missing]

To run only parser tests:

uv run pytest -m parsers [--cov=src --cov-report=term-missing]

To run only tests related to a specific submodule:

uv run pytest -m <client|escalation_policies|...> [--cov=src --cov-report=term-missing]

Debug Server with MCP Inspector

npx @modelcontextprotocol/inspector uv run path/to/repo/pagerduty-mcp-server/.venv/bin/pagerduty-mcp-server

Documentation

Tool Documentation - Detailed information about available tools including parameters, return types, and example queries

Conventions

  • All API responses follow the standard format with metadata, resource list, and optional error
  • Resource names in responses are always pluralized for consistency
  • All functions that return a single item still return a list with one element
  • Error responses include both a message and a code
  • All timestamps are in ISO8601 format
  • Tests are marked with pytest markers to indicate their type (unit/integration), the resource they test (incidents, teams, etc.), and whether they test parsing functionality ("parsers" marker)

Example Queries

  • Are there any incidents assigned to me currently in pagerduty?
  • Do I have any upcoming on call schedule in next 2 weeks?
  • Who else is a member of the personalization team?

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

pagerduty_mcp_server-4.0.0.tar.gz (45.2 kB view details)

Uploaded Source

Built Distribution

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

pagerduty_mcp_server-4.0.0-py3-none-any.whl (56.4 kB view details)

Uploaded Python 3

File details

Details for the file pagerduty_mcp_server-4.0.0.tar.gz.

File metadata

  • Download URL: pagerduty_mcp_server-4.0.0.tar.gz
  • Upload date:
  • Size: 45.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for pagerduty_mcp_server-4.0.0.tar.gz
Algorithm Hash digest
SHA256 142f5c342a23a9667fb5d906b35af4e33d269995e273cad87d63ef38107bc061
MD5 22c38949a3f961049f5b8a8751686302
BLAKE2b-256 c6048d85e78f858622b99e4dfc6fa253416e2b59b1d5eecf128d9e48d8f86dff

See more details on using hashes here.

File details

Details for the file pagerduty_mcp_server-4.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for pagerduty_mcp_server-4.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e7e9ff5b251d1d5992f50175a8692d8442a121757cf6a336b5013034cff67be5
MD5 2807f76209b051685e943b7f79938548
BLAKE2b-256 21fceba18e1c174b2646e1741e0f461abe4f61c1fa47be2fa1c590283700fa58

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