Pagerduty MCP Server

🚀 分頁Duty 服務器端

PagerDuty Server 是一個用於與PagerDuty API交互的Python客戶端庫，它能簡化從PagerDuty獲取數據的流程，並提供多種工具輔助處理和分析這些數據。

🚀 快速開始

PagerDuty Server 可幫助您輕鬆與PagerDuty API交互。以下是一些基本操作示例：

分頁示例

獲取所有事件的分頁：

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

事件功能

列出事件

列出當前用戶的團隊中的所有事件：

incidents_list = incidents.list_incidents()

# 列出特定服務的事件
service_incidents = incidents.list_incidents(service_ids=['SERVICE-1', 'SERVICE-2'])

# 根據狀態篩選事件
active_incidents = incidents.list_incidents(statuses=['triggered', 'acknowledged'])

時間範圍篩選

根據時間範圍過濾事件：

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

事件上下文

當 current_user_context=True 時，自動過濾與當前用戶相關的團隊和服務：

my_incidents = incidents.list_incidents(current_user_context=True)

團隊功能

列出團隊

獲取所有團隊：

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

服務功能

列出服務

列出特定團隊的服務：

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

命令行工具

PagerDuty Server 提供了一個命令行界面（CLI）來執行常見任務。

安裝 CLI

使用 pip 安裝：

pip install pagerduty-mcp-server-cli

使用 CLI

列出所有事件：

pagerduty-server incidents list

獲取特定事件的詳細信息：

pagerduty-server incidents get --id INCIDENT-123

✨ 主要特性

• 分頁：自動處理PagerDuty API的分頁，使您可以輕鬆獲取大量數據。
• 用戶上下文：根據當前用戶上下文過濾結果，提供更相關的數據。
• 多種資源支持：支持多種資源類型，包括事件、團隊、服務和策略等。

📦 安裝指南

使用 pip 安裝：

pip install pagerduty-mcp-server

💻 使用示例

基礎用法

以下是獲取所有事件分頁的基礎代碼示例：

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

高級用法

事件功能高級用法

# 列出特定服務的事件
service_incidents = incidents.list_incidents(service_ids=['SERVICE-1', 'SERVICE-2'])

# 根據狀態篩選事件
active_incidents = incidents.list_incidents(statuses=['triggered', 'acknowledged'])

# 根據時間範圍過濾事件
date_range_incidents = incidents.list_incidents(
    since='2024-03-01T00:00:00Z',
    until='2024-03-14T23:59:59Z'
)

團隊和服務功能高級用法

# 列出所有團隊
teams = teams.list_teams()
for team in teams:
    print(team.id)

# 列出特定團隊的服務
services = services.list_services(team_id='TEAM-1')
for service in services:
    print(service.id)

命令行工具高級用法

# 列出所有事件
pagerduty-server incidents list

# 獲取特定事件的詳細信息
pagerduty-server incidents get --id INCIDENT-123

🔧 技術細節

用戶上下文限制

• 當 current_user_context=True 時，不能使用以下參數：
  • user_ids
  • team_ids
  • service_ids

📚 詳細文檔

開發

安裝依賴

使用 pip 安裝開發依賴：

pip install -r requirements.txt

測試

運行單元測試：

pytest tests/

提交代碼

遵循 Git Flow 工作流進行提交。

貢獻指南

提交規範

遵循標準的提交規範，確保您的提交清晰且易於理解。

發佈流程

使用 poetry 進行版本管理：

poetry lock --no-update && poetry install

文檔編寫

文檔位於 docs/ 目錄下，使用 Markdown 格式編寫。

問題報告

遇到問題？在 GitHub Issues 中報告。

PagerDuty Server 是一個強大的工具，幫助您更高效地與PagerDuty API交互。希望這個文檔能為您提供清晰的指導！