Pagerduty MCP Server

🚀 PagerDuty Server

PagerDuty Server is a Python client library for interacting with the PagerDuty API. It simplifies the process of retrieving data from PagerDuty and offers various tools to assist you in processing and analyzing this data.

🚀 Quick Start

Pagination Example

Get paginated results for all incidents:

from pagerduty_mcp_server import incidents
incidents = incidents.get_all_incidents()
for incident in incidents:
    print(incident.id)

✨ Features

• Pagination: Automatically handle pagination of the PagerDuty API, allowing you to easily retrieve large amounts of data.
• User Context: Filter results based on the current user context to provide more relevant data.
• Multiple Resource Support: Support various resource types, including incidents, teams, services, and policies.

📦 Installation

Install using pip:

pip install pagerduty-mcp-server

💻 Usage Examples

Incident Features

List Incidents

List all incidents in the current user's team:

incidents_list = incidents.list_incidents()

# List incidents for a specific service
service_incidents = incidents.list_incidents(service_ids=['SERVICE-1', 'SERVICE-2'])

# Filter incidents by status
active_incidents = incidents.list_incidents(statuses=['triggered', 'acknowledged'])

Time Range Filtering

Filter incidents by a time range:

date_range_incidents = incidents.list_incidents(
    since='2024-03-01T00:00:00Z',
    until='2024-03-14T23:59:59Z'
)

Incident Context

When current_user_context=True, automatically filter teams and services related to the current user:

my_incidents = incidents.list_incidents(current_user_context=True)

User Context Limitations

• When current_user_context=True, the following parameters cannot be used:
  • user_ids
  • team_ids
  • service_ids

Team Features

List Teams

Get all teams:

teams = teams.list_teams()
for team in teams:
    print(team.id)

Service Features

List Services

List services for a specific team:

services = services.list_services(team_id='TEAM-1')
for service in services:
    print(service.id)

Command Line Interface

PagerDuty Server provides a command-line interface (CLI) to perform common tasks.

Install the CLI

Install using pip:

pip install pagerduty-mcp-server-cli

Use the CLI

List all incidents:

pagerduty-server incidents list

Get detailed information for a specific incident:

pagerduty-server incidents get --id INCIDENT-123

🔧 Technical Details

Development

Install Dependencies

Install development dependencies using pip:

pip install -r requirements.txt

Testing

Run unit tests:

pytest tests/

Code Submission

Follow the Git Flow workflow for submissions.

Contribution Guidelines

Submission Specification

Follow standard submission specifications to ensure your submissions are clear and easy to understand.

Release Process

Use poetry for version management:

poetry lock --no-update && poetry install

Documentation Writing

Documentation is located in the docs/ directory and is written in Markdown format.

Issue Reporting

Encountered an issue? Report it on GitHub Issues.

PagerDuty Server is a powerful tool that helps you interact with the PagerDuty API more efficiently. We hope this documentation provides clear guidance for you!