rootly-mcp-server 0.0.5__tar.gz → 2.0.0__tar.gz

rootly_mcp_server-2.0.0/.github/workflows/pypi-release.yml

@@ -0,0 +1,33 @@
+name: Publish Python 🐍 distribution 📦 to PyPI on tag
+
+on:
+  push:
+    tags:
+      - '*'
+
+jobs:
+  build-and-publish:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+
+      - name: Install uv and build tools
+        run: |
+          pip install build twine
+
+      - name: Build package
+        run: |
+          python -m build
+
+      - name: Publish to PyPI
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
+        run: |
+          twine upload dist/* 

{rootly_mcp_server-0.0.5 → rootly_mcp_server-2.0.0}/.gitignore

@@ -77,6 +77,7 @@ target/
 
 # Jupyter Notebook
 .ipynb_checkpoints
+*.ipynb
 
 # IPython
 profile_default/
@@ -173,4 +174,17 @@ cython_debug/
 # PyPI configuration file
 .pypirc
 
-.cursor
+# IDE/Editor files
+.cursor
+.vscode/
+*.swp
+*.swo
+*~
+
+# MCP Server specific
+# Downloaded swagger.json files (auto-fetched from URL)
+swagger.json
+
+# Test outputs and temporary files
+test_output/
+*.tmp

rootly_mcp_server-2.0.0/.semaphore/deploy.yml

@@ -0,0 +1,55 @@
+version: v1.0
+name: Build and Deploy
+
+queue:
+  name: Deployment Queue
+  scope: project
+
+agent:
+  machine:
+    type: r1-standard-4
+    os_image: ubuntu2204
+
+blocks:
+  - name: 'Deploy'
+    dependencies: []
+    task:
+      secrets:
+        - name: 'AWS Credentials'
+      prologue:
+        commands:
+          - export AWS_PROFILE=production
+          - export AWS_ACCOUNT_ID=$(aws sts get-caller-identity --query Account --output text)
+          - aws ecr get-login-password --region us-east-1 | docker login --username AWS --password-stdin ${AWS_ACCOUNT_ID}.dkr.ecr.us-east-1.amazonaws.com
+      jobs:
+        - name: Deploy
+          commands:
+            - checkout
+            - |
+              export TASK_FAMILY=rootly-mcp-server
+              export CONTAINER_NAME=mcp
+              export IMAGE=657716690934.dkr.ecr.us-east-1.amazonaws.com/rootly/mcp:${SEMAPHORE_GIT_SHA}
+              NEW_TASK_DEFINITION_ARN=$(./.semaphore/update-task-definition.sh)
+
+              aws ecs update-service \
+                --cluster rootly-web \
+                --service rootly-mcp-server \
+                --task-definition "$NEW_TASK_DEFINITION_ARN" \
+                --deployment-configuration "deploymentCircuitBreaker={enable=true,rollback=true},maximumPercent=200,minimumHealthyPercent=100" \
+                --force-new-deployment >/dev/null
+
+              echo "Waiting for service to stabilize at the new revision..."
+
+              # Wait for the service to stabilize for up to 10 minutes
+              for i in {1..40}; do
+                if aws ecs describe-services --cluster rootly-web --service rootly-mcp-server --output json | jq -e \
+                  '.services | map(select((.deployments | length) != 1 or .runningCount != .desiredCount)) | length == 0' >/dev/null; then
+                  break
+                fi
+                sleep 15
+              done
+
+              if [ $i -eq 40 ]; then
+                echo "Service failed to stabilize after 10 minutes"
+                exit 1
+              fi

rootly_mcp_server-2.0.0/.semaphore/semaphore.yml

@@ -0,0 +1,45 @@
+version: v1.0
+name: Build and Deploy
+
+queue:
+  name: Build Queue
+  scope: project
+
+auto_cancel:
+  queued:
+    when: 'true'
+
+agent:
+  machine:
+    type: r1-standard-4
+    os_image: ubuntu2204
+
+blocks:
+  - name: 'Build'
+    dependencies: []
+    task:
+      secrets:
+        - name: 'AWS Credentials'
+      prologue:
+        commands:
+          - export AWS_PROFILE=production
+          - export AWS_ACCOUNT_ID=$(aws sts get-caller-identity --query Account --output text)
+          - aws ecr get-login-password --region us-east-1 | docker login --username AWS --password-stdin ${AWS_ACCOUNT_ID}.dkr.ecr.us-east-1.amazonaws.com
+      jobs:
+        - name: Build
+          commands:
+            - checkout
+            - export BUILDKIT_PROGRESS=plain
+            - |
+              docker build --push \
+                -t 657716690934.dkr.ecr.us-east-1.amazonaws.com/rootly/mcp:${SEMAPHORE_GIT_SHA} \
+                -t 657716690934.dkr.ecr.us-east-1.amazonaws.com/rootly/mcp:latest \
+                -t 657716690934.dkr.ecr.us-east-1.amazonaws.com/rootly/mcp:production .
+
+promotions:
+  - name: Deploy
+    pipeline_file: deploy.yml
+    deployment_target: production
+
+    auto_promote:
+      when: branch = 'main' AND result = 'passed'

rootly_mcp_server-2.0.0/.semaphore/update-task-definition.sh

@@ -0,0 +1,43 @@
+#!/bin/bash
+
+set -e
+
+# Updates a task definition with a new container image
+# Returns the new task definition ARN
+#
+# Required environment variables:
+# TASK_FAMILY - Task definition family
+# CONTAINER_NAME - Container name to update
+# IMAGE - New container image to deploy
+
+if [ -z "$TASK_FAMILY" ] || [ -z "$CONTAINER_NAME" ] || [ -z "$IMAGE" ]; then
+  echo "Error: TASK_FAMILY, CONTAINER_NAME, and IMAGE environment variables are required"
+  exit 1
+fi
+
+TASK_DEFINITION="$(aws ecs describe-task-definition --task-definition=$TASK_FAMILY | jq '.taskDefinition')"
+
+# Remove fields that can't be used in register-task-definition
+TASK_DEFINITION="$(jq 'del(.taskDefinitionArn, .revision, .status, .requiresAttributes, .compatibilities, .registeredAt, .registeredBy)' <<< "$TASK_DEFINITION")"
+
+# Find the index of the specified container
+CONTAINER_INDEX="$(jq --arg NAME "$CONTAINER_NAME" '.containerDefinitions | map(.name) | index($NAME)' <<< "$TASK_DEFINITION")"
+
+if [ "$CONTAINER_INDEX" = "null" ]; then
+  echo "Error: Container '$CONTAINER_NAME' not found in task definition"
+  exit 1
+fi
+
+# Update the container image
+NEW_TASK_DEFINITION="$(jq --arg INDEX "$CONTAINER_INDEX" --arg IMAGE "$IMAGE" '.containerDefinitions[$INDEX | tonumber].image = $IMAGE' <<< "$TASK_DEFINITION")"
+
+# Register the new task definition
+NEW_TASK_DEFINITION_ARN="$(aws ecs register-task-definition --cli-input-json "$NEW_TASK_DEFINITION" --output text --query 'taskDefinition.taskDefinitionArn')"
+
+echo "$TASK_DEFINITION" > task-definition.json
+echo "$NEW_TASK_DEFINITION" > new-task-definition.json
+
+echo "Applying update:" >&2
+diff -u task-definition.json new-task-definition.json >&2 || :
+
+echo "$NEW_TASK_DEFINITION_ARN"

rootly_mcp_server-2.0.0/CLAUDE.md

@@ -0,0 +1,68 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Development Commands
+
+### Environment Setup
+```bash
+# Install dependencies using uv
+uv pip install .
+
+# Create and activate virtual environment
+uv venv .venv
+source .venv/bin/activate
+```
+
+### Testing and Quality
+```bash
+# Run test client to verify setup
+python test_mcp_client.py
+
+# Linting and type checking (if you add dev dependencies)
+ruff check src/
+pyright src/
+```
+
+### Package Building
+```bash
+# Build the package
+uv build
+```
+
+## Architecture Overview
+
+This is an MCP (Model Context Protocol) server that provides AI agents access to the Rootly API for incident management. The project uses Python 3.12+ with `uv` for dependency management.
+
+### Core Components
+
+- **`server.py`**: Main MCP server implementation (`RootlyMCPServer` class)
+  - Dynamically generates MCP tools from Rootly's OpenAPI/Swagger specification
+  - Filters available endpoints via `allowed_paths` configuration for security and context management
+  - Implements automatic pagination (default 10 items) for incident endpoints
+  - Uses FastMCP framework with ERROR log level to prevent UI noise
+
+- **`client.py`**: Rootly API client (`RootlyClient` class)
+  - Handles authentication via `ROOTLY_API_TOKEN` environment variable
+  - Supports both JSON and JSON-API formats depending on endpoint requirements
+  - Base URL defaults to `https://api.rootly.com`
+  - Auto-prefixes paths with `/v1` if not present
+
+- **`data/swagger.json`**: Cached OpenAPI specification
+  - Falls back to downloading from `https://rootly-heroku.s3.amazonaws.com/swagger/v1/swagger.json`
+  - Server searches local directories before downloading
+
+### Key Design Patterns
+
+- **Dynamic Tool Generation**: Tools are created at runtime based on Swagger spec rather than hardcoded
+- **Path Whitelisting**: Only specific endpoints in `allowed_paths` are exposed to prevent context overflow and maintain security
+- **JSON-API Support**: Automatically wraps request bodies in JSON-API format for create/update operations
+- **Error Resilience**: Comprehensive error handling with structured JSON error responses
+
+### Configuration
+
+The `allowed_paths` array in `server.py:56-92` controls which Rootly API endpoints are available. Modify this list to expose additional endpoints. Paths should be specified without the `/v1` prefix.
+
+### Environment Variables
+
+- `ROOTLY_API_TOKEN`: Required authentication token for Rootly API access

rootly_mcp_server-2.0.0/Dockerfile

@@ -0,0 +1,28 @@
+# Use Python 3.12 slim image as base
+FROM python:3.12-slim
+
+# Set working directory
+WORKDIR /app
+
+# Install system dependencies
+RUN apt-get update && apt-get install -y --no-install-recommends \
+    gcc curl ca-certificates \
+    && rm -rf /var/lib/apt/lists/*
+
+# Install uv
+RUN pip install --no-cache-dir uv
+
+# Copy the entire project first for installation
+COPY . .
+
+# Install the package and its dependencies
+RUN uv pip install --system --no-cache-dir -e .
+
+# Expose the port the app runs on
+EXPOSE 8000
+
+# Set environment variables
+ENV PYTHONUNBUFFERED=1
+
+# Run the application
+CMD ["rootly-mcp-server", "--transport", "sse", "--log-level", "INFO", "--host", "0.0.0.0", "--port", "8000", "--hosted"]

rootly_mcp_server-2.0.0/PKG-INFO

@@ -0,0 +1,194 @@
+Metadata-Version: 2.4
+Name: rootly-mcp-server
+Version: 2.0.0
+Summary: A Model Context Protocol server for Rootly APIs using OpenAPI spec
+Project-URL: Homepage, https://github.com/Rootly-AI-Labs/Rootly-MCP-server
+Project-URL: Issues, https://github.com/Rootly-AI-Labs/Rootly-MCP-server/issues
+Author-email: Rootly AI Labs <support@rootly.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: automation,incidents,llm,mcp,rootly
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Build Tools
+Requires-Python: >=3.12
+Requires-Dist: fastmcp==2.4.0
+Requires-Dist: httpx>=0.24.0
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: requests>=2.28.0
+Provides-Extra: dev
+Requires-Dist: black>=23.0.0; extra == 'dev'
+Requires-Dist: isort>=5.0.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# Rootly MCP Server
+
+An MCP server for [Rootly API](https://docs.rootly.com/api-reference/overview) that you can plug into your favorite MCP-compatible editors like Cursor, Windsurf, and Claude. Resolve production incidents in under a minute without leaving your IDE.
+
+[![Install MCP Server](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/install-mcp?name=rootly&config=eyJjb21tYW5kIjoibnB4IC15IG1jcC1yZW1vdGUgaHR0cHM6Ly9tY3Aucm9vdGx5LmNvbS9zc2UgLS1oZWFkZXIgQXV0aG9yaXphdGlvbjoke1JPT1RMWV9BVVRIX0hFQURFUn0iLCJlbnYiOnsiUk9PVExZX0FVVEhfSEVBREVSIjoiQmVhcmVyIDxZT1VSX1JPT1RMWV9BUElfVE9LRU4%2BIn19)
+
+![Demo GIF](rootly-mcp-server-demo.gif)
+
+## Prerequisites
+
+- Python 3.12 or higher
+- `uv` package manager
+  ```bash
+  curl -LsSf https://astral.sh/uv/install.sh | sh
+  ```
+- [Rootly API token](https://docs.rootly.com/api-reference/overview#how-to-generate-an-api-key%3F)
+
+## Run it in your IDE
+
+Install with our [PyPi package](https://pypi.org/project/rootly-mcp-server/) or by cloning this repo.
+
+To set it up in your favorite MCP-compatible editor (we tested it with Cursor and Windsurf), here is the config :
+
+```json
+{
+  "mcpServers": {
+    "rootly": {
+      "command": "uvx",
+      "args": ["--from", "rootly-mcp-server", "rootly-mcp-server"],
+      "env": {
+        "ROOTLY_API_TOKEN": "<YOUR_ROOTLY_API_TOKEN>"
+      }
+    }
+  }
+}
+```
+
+If you want to customize `allowed_paths` to access more Rootly API paths, clone the package and use this config.
+
+```json
+{
+  "mcpServers": {
+    "rootly": {
+      "command": "uv",
+      "args": [
+        "run",
+        "--directory",
+        "/path/to/rootly-mcp-server",
+        "rootly-mcp-server"
+      ],
+      "env": {
+        "ROOTLY_API_TOKEN": "<YOUR_ROOTLY_API_TOKEN>"
+      }
+    }
+  }
+}
+```
+
+## Features
+
+This server dynamically generates MCP resources based on Rootly's OpenAPI (Swagger) specification:
+
+- Dynamically generated MCP tools based on Rootly's OpenAPI specification
+- Default pagination (10 items) for incident endpoints to prevent context window overflow
+- Limits the number of API paths exposed to the AI agent
+
+### Whitelisted Endpoints
+
+By default, the following Rootly API endpoints are exposed to the AI agent (see `allowed_paths` in `src/rootly_mcp_server/server.py`):
+
+```
+/v1/incidents
+/v1/incidents/{incident_id}/alerts
+/v1/alerts
+/v1/alerts/{alert_id}
+/v1/severities
+/v1/severities/{severity_id}
+/v1/teams
+/v1/teams/{team_id}
+/v1/services
+/v1/services/{service_id}
+/v1/functionalities
+/v1/functionalities/{functionality_id}
+/v1/incident_types
+/v1/incident_types/{incident_type_id}
+/v1/incident_action_items
+/v1/incident_action_items/{incident_action_item_id}
+/v1/incidents/{incident_id}/action_items
+/v1/workflows
+/v1/workflows/{workflow_id}
+/v1/workflow_runs
+/v1/workflow_runs/{workflow_run_id}
+/v1/environments
+/v1/environments/{environment_id}
+/v1/users
+/v1/users/{user_id}
+/v1/users/me
+/v1/status_pages
+/v1/status_pages/{status_page_id}
+```
+
+We limited the number of API paths exposed for 2 reasons:
+
+- Context size: because [Rootly's API](https://docs.rootly.com/api-reference/overview) is very rich in paths, AI agents can get overwhelmed and not perform simple actions properly.
+- Security: if you want to limit the type of information or actions that users can access through the MCP server
+
+If you want to make more paths available, edit the variable `allowed_paths` in `src/rootly_mcp_server/server.py`.
+
+## About the Rootly AI Labs
+
+This project was developed by the [Rootly AI Labs](https://labs.rootly.ai/). The AI Labs is building the future of system reliability and operational excellence. We operate as an open-source incubator, sharing ideas, experimenting, and rapidly prototyping. We're committed to ensuring our research benefits the entire community.
+![Rootly AI logo](https://github.com/Rootly-AI-Labs/EventOrOutage/raw/main/rootly-ai.png)
+
+## Developer Setup & Troubleshooting
+
+### 1. Install dependencies with `uv`
+
+This project uses [`uv`](https://github.com/astral-sh/uv) for fast dependency management. To install all dependencies from your `pyproject.toml`:
+
+```bash
+uv pip install .
+```
+
+### 2. Using a virtual environment
+
+It is recommended to use a virtual environment for development:
+
+```bash
+uv venv .venv
+source .venv/bin/activate
+```
+
+### 3. Running the test client
+
+To run the test client and verify your setup:
+
+```bash
+python test_mcp_client.py
+```
+
+### 5. General tips
+
+- Always activate your virtual environment before running scripts.
+- If you add new dependencies, use `uv pip install <package>` to keep your environment up to date.
+- If you encounter issues, check your Python version and ensure it matches the project's requirements.
+
+### 6. Connecting to Our MCP Server
+
+You can configure your client to connect directly to our hosted MCP server:
+
+```json
+{
+  "mcpServers": {
+    "rootly": {
+      "command": "npx",
+      "args": [
+        "-y",
+        "mcp-remote",
+        "https://mcp.rootly.com/sse",
+        "--header",
+        "Authorization:${ROOTLY_AUTH_HEADER}"
+      ],
+      "env": {
+        "ROOTLY_AUTH_HEADER": "Bearer <YOUR_ROOTLY_API_TOKEN>"
+      }
+    }
+  }
+}
+```

rootly_mcp_server-2.0.0/README.md

@@ -0,0 +1,169 @@
+# Rootly MCP Server
+
+An MCP server for [Rootly API](https://docs.rootly.com/api-reference/overview) that you can plug into your favorite MCP-compatible editors like Cursor, Windsurf, and Claude. Resolve production incidents in under a minute without leaving your IDE.
+
+[![Install MCP Server](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/install-mcp?name=rootly&config=eyJjb21tYW5kIjoibnB4IC15IG1jcC1yZW1vdGUgaHR0cHM6Ly9tY3Aucm9vdGx5LmNvbS9zc2UgLS1oZWFkZXIgQXV0aG9yaXphdGlvbjoke1JPT1RMWV9BVVRIX0hFQURFUn0iLCJlbnYiOnsiUk9PVExZX0FVVEhfSEVBREVSIjoiQmVhcmVyIDxZT1VSX1JPT1RMWV9BUElfVE9LRU4%2BIn19)
+
+![Demo GIF](rootly-mcp-server-demo.gif)
+
+## Prerequisites
+
+- Python 3.12 or higher
+- `uv` package manager
+  ```bash
+  curl -LsSf https://astral.sh/uv/install.sh | sh
+  ```
+- [Rootly API token](https://docs.rootly.com/api-reference/overview#how-to-generate-an-api-key%3F)
+
+## Run it in your IDE
+
+Install with our [PyPi package](https://pypi.org/project/rootly-mcp-server/) or by cloning this repo.
+
+To set it up in your favorite MCP-compatible editor (we tested it with Cursor and Windsurf), here is the config :
+
+```json
+{
+  "mcpServers": {
+    "rootly": {
+      "command": "uvx",
+      "args": ["--from", "rootly-mcp-server", "rootly-mcp-server"],
+      "env": {
+        "ROOTLY_API_TOKEN": "<YOUR_ROOTLY_API_TOKEN>"
+      }
+    }
+  }
+}
+```
+
+If you want to customize `allowed_paths` to access more Rootly API paths, clone the package and use this config.
+
+```json
+{
+  "mcpServers": {
+    "rootly": {
+      "command": "uv",
+      "args": [
+        "run",
+        "--directory",
+        "/path/to/rootly-mcp-server",
+        "rootly-mcp-server"
+      ],
+      "env": {
+        "ROOTLY_API_TOKEN": "<YOUR_ROOTLY_API_TOKEN>"
+      }
+    }
+  }
+}
+```
+
+## Features
+
+This server dynamically generates MCP resources based on Rootly's OpenAPI (Swagger) specification:
+
+- Dynamically generated MCP tools based on Rootly's OpenAPI specification
+- Default pagination (10 items) for incident endpoints to prevent context window overflow
+- Limits the number of API paths exposed to the AI agent
+
+### Whitelisted Endpoints
+
+By default, the following Rootly API endpoints are exposed to the AI agent (see `allowed_paths` in `src/rootly_mcp_server/server.py`):
+
+```
+/v1/incidents
+/v1/incidents/{incident_id}/alerts
+/v1/alerts
+/v1/alerts/{alert_id}
+/v1/severities
+/v1/severities/{severity_id}
+/v1/teams
+/v1/teams/{team_id}
+/v1/services
+/v1/services/{service_id}
+/v1/functionalities
+/v1/functionalities/{functionality_id}
+/v1/incident_types
+/v1/incident_types/{incident_type_id}
+/v1/incident_action_items
+/v1/incident_action_items/{incident_action_item_id}
+/v1/incidents/{incident_id}/action_items
+/v1/workflows
+/v1/workflows/{workflow_id}
+/v1/workflow_runs
+/v1/workflow_runs/{workflow_run_id}
+/v1/environments
+/v1/environments/{environment_id}
+/v1/users
+/v1/users/{user_id}
+/v1/users/me
+/v1/status_pages
+/v1/status_pages/{status_page_id}
+```
+
+We limited the number of API paths exposed for 2 reasons:
+
+- Context size: because [Rootly's API](https://docs.rootly.com/api-reference/overview) is very rich in paths, AI agents can get overwhelmed and not perform simple actions properly.
+- Security: if you want to limit the type of information or actions that users can access through the MCP server
+
+If you want to make more paths available, edit the variable `allowed_paths` in `src/rootly_mcp_server/server.py`.
+
+## About the Rootly AI Labs
+
+This project was developed by the [Rootly AI Labs](https://labs.rootly.ai/). The AI Labs is building the future of system reliability and operational excellence. We operate as an open-source incubator, sharing ideas, experimenting, and rapidly prototyping. We're committed to ensuring our research benefits the entire community.
+![Rootly AI logo](https://github.com/Rootly-AI-Labs/EventOrOutage/raw/main/rootly-ai.png)
+
+## Developer Setup & Troubleshooting
+
+### 1. Install dependencies with `uv`
+
+This project uses [`uv`](https://github.com/astral-sh/uv) for fast dependency management. To install all dependencies from your `pyproject.toml`:
+
+```bash
+uv pip install .
+```
+
+### 2. Using a virtual environment
+
+It is recommended to use a virtual environment for development:
+
+```bash
+uv venv .venv
+source .venv/bin/activate
+```
+
+### 3. Running the test client
+
+To run the test client and verify your setup:
+
+```bash
+python test_mcp_client.py
+```
+
+### 5. General tips
+
+- Always activate your virtual environment before running scripts.
+- If you add new dependencies, use `uv pip install <package>` to keep your environment up to date.
+- If you encounter issues, check your Python version and ensure it matches the project's requirements.
+
+### 6. Connecting to Our MCP Server
+
+You can configure your client to connect directly to our hosted MCP server:
+
+```json
+{
+  "mcpServers": {
+    "rootly": {
+      "command": "npx",
+      "args": [
+        "-y",
+        "mcp-remote",
+        "https://mcp.rootly.com/sse",
+        "--header",
+        "Authorization:${ROOTLY_AUTH_HEADER}"
+      ],
+      "env": {
+        "ROOTLY_AUTH_HEADER": "Bearer <YOUR_ROOTLY_API_TOKEN>"
+      }
+    }
+  }
+}
+```