rootly-mcp-server 2.0.15__py3-none-any.whl → 2.1.0__py3-none-any.whl

rootly_mcp_server/utils.py

@@ -2,9 +2,9 @@
 Shared utilities for Rootly MCP Server.
 """
 
-import re
 import logging
-from typing import Dict, Any
+import re
+from typing import Any
 
 logger = logging.getLogger(__name__)
 
@@ -12,57 +12,57 @@ logger = logging.getLogger(__name__)
 def sanitize_parameter_name(name: str) -> str:
     """
     Sanitize parameter names to match MCP property key pattern ^[a-zA-Z0-9_.-]{1,64}$.
-    
+
     Args:
         name: Original parameter name
-        
+
     Returns:
         Sanitized parameter name
     """
     # Replace square brackets with underscores: filter[kind] -> filter_kind
-    sanitized = re.sub(r'\[([^\]]+)\]', r'_\1', name)
-    
+    sanitized = re.sub(r"\[([^\]]+)\]", r"_\1", name)
+
     # Replace any remaining invalid characters with underscores
-    sanitized = re.sub(r'[^a-zA-Z0-9_.-]', '_', sanitized)
-    
+    sanitized = re.sub(r"[^a-zA-Z0-9_.-]", "_", sanitized)
+
     # Remove multiple consecutive underscores
-    sanitized = re.sub(r'_{2,}', '_', sanitized)
-    
+    sanitized = re.sub(r"_{2,}", "_", sanitized)
+
     # Remove leading/trailing underscores
-    sanitized = sanitized.strip('_')
-    
+    sanitized = sanitized.strip("_")
+
     # Ensure the name doesn't exceed 64 characters
     if len(sanitized) > 64:
-        sanitized = sanitized[:64].rstrip('_')
-    
+        sanitized = sanitized[:64].rstrip("_")
+
     # Ensure the name is not empty and starts with a letter or underscore
     if not sanitized or sanitized[0].isdigit():
         sanitized = "param_" + sanitized if sanitized else "param"
-    
+
     return sanitized
 
 
-def sanitize_parameters_in_spec(spec: Dict[str, Any]) -> Dict[str, str]:
+def sanitize_parameters_in_spec(spec: dict[str, Any]) -> dict[str, str]:
     """
     Sanitize all parameter names in an OpenAPI specification.
-    
-    This function modifies the spec in-place and builds a mapping 
+
+    This function modifies the spec in-place and builds a mapping
     of sanitized names to original names.
-    
+
     Args:
         spec: OpenAPI specification dictionary
-        
+
     Returns:
         Dictionary mapping sanitized names to original names
     """
     parameter_mapping = {}
-    
+
     # Sanitize parameters in paths
     if "paths" in spec:
-        for path, path_item in spec["paths"].items():
+        for _path, path_item in spec["paths"].items():
             if not isinstance(path_item, dict):
                 continue
-                
+
             # Sanitize path-level parameters
             if "parameters" in path_item:
                 for param in path_item["parameters"]:
@@ -70,36 +70,51 @@ def sanitize_parameters_in_spec(spec: Dict[str, Any]) -> Dict[str, str]:
                         original_name = param["name"]
                         sanitized_name = sanitize_parameter_name(original_name)
                         if sanitized_name != original_name:
-                            logger.debug(f"Sanitized path-level parameter: '{original_name}' -> '{sanitized_name}'")
+                            logger.debug(
+                                f"Sanitized path-level parameter: '{original_name}' -> '{sanitized_name}'"
+                            )
                             param["name"] = sanitized_name
                             parameter_mapping[sanitized_name] = original_name
-            
+
             # Sanitize operation-level parameters
             for method, operation in path_item.items():
-                if method.lower() not in ["get", "post", "put", "delete", "patch", "options", "head", "trace"]:
+                if method.lower() not in [
+                    "get",
+                    "post",
+                    "put",
+                    "delete",
+                    "patch",
+                    "options",
+                    "head",
+                    "trace",
+                ]:
                     continue
                 if not isinstance(operation, dict):
                     continue
-                    
+
                 if "parameters" in operation:
                     for param in operation["parameters"]:
                         if "name" in param:
                             original_name = param["name"]
                             sanitized_name = sanitize_parameter_name(original_name)
                             if sanitized_name != original_name:
-                                logger.debug(f"Sanitized operation parameter: '{original_name}' -> '{sanitized_name}'")
+                                logger.debug(
+                                    f"Sanitized operation parameter: '{original_name}' -> '{sanitized_name}'"
+                                )
                                 param["name"] = sanitized_name
                                 parameter_mapping[sanitized_name] = original_name
-    
+
     # Sanitize parameters in components (OpenAPI 3.0)
     if "components" in spec and "parameters" in spec["components"]:
-        for param_name, param_def in spec["components"]["parameters"].items():
+        for _param_name, param_def in spec["components"]["parameters"].items():
             if isinstance(param_def, dict) and "name" in param_def:
                 original_name = param_def["name"]
                 sanitized_name = sanitize_parameter_name(original_name)
                 if sanitized_name != original_name:
-                    logger.debug(f"Sanitized component parameter: '{original_name}' -> '{sanitized_name}'")
+                    logger.debug(
+                        f"Sanitized component parameter: '{original_name}' -> '{sanitized_name}'"
+                    )
                     param_def["name"] = sanitized_name
                     parameter_mapping[sanitized_name] = original_name
-    
-    return parameter_mapping
+
+    return parameter_mapping

rootly_mcp_server/validators.py

@@ -0,0 +1,147 @@
+"""
+Input validation utilities for the Rootly MCP Server.
+
+This module provides validation functions for API inputs, parameters,
+and data structures.
+"""
+
+from typing import Any
+
+from .exceptions import RootlyValidationError
+
+
+def validate_positive_integer(value: int, field_name: str, min_value: int = 1) -> int:
+    """
+    Validate that a value is a positive integer.
+
+    Args:
+        value: The value to validate
+        field_name: Name of the field for error messages
+        min_value: Minimum allowed value
+
+    Returns:
+        The validated value
+
+    Raises:
+        RootlyValidationError: If validation fails
+    """
+    if not isinstance(value, int):
+        raise RootlyValidationError(f"{field_name} must be an integer, got {type(value).__name__}")
+
+    if value < min_value:
+        raise RootlyValidationError(f"{field_name} must be >= {min_value}, got {value}")
+
+    return value
+
+
+def validate_string(
+    value: str,
+    field_name: str,
+    min_length: int = 0,
+    max_length: int | None = None,
+    pattern: str | None = None,
+) -> str:
+    """
+    Validate a string value.
+
+    Args:
+        value: The string to validate
+        field_name: Name of the field for error messages
+        min_length: Minimum allowed length
+        max_length: Maximum allowed length
+        pattern: Optional regex pattern to match
+
+    Returns:
+        The validated string
+
+    Raises:
+        RootlyValidationError: If validation fails
+    """
+    if not isinstance(value, str):
+        raise RootlyValidationError(f"{field_name} must be a string, got {type(value).__name__}")
+
+    if len(value) < min_length:
+        raise RootlyValidationError(f"{field_name} must be at least {min_length} characters")
+
+    if max_length and len(value) > max_length:
+        raise RootlyValidationError(f"{field_name} must be at most {max_length} characters")
+
+    if pattern:
+        import re
+
+        if not re.match(pattern, value):
+            raise RootlyValidationError(f"{field_name} does not match required pattern")
+
+    return value
+
+
+def validate_dict(value: dict, field_name: str, required_keys: list[str] | None = None) -> dict:
+    """
+    Validate a dictionary value.
+
+    Args:
+        value: The dict to validate
+        field_name: Name of the field for error messages
+        required_keys: Optional list of required keys
+
+    Returns:
+        The validated dict
+
+    Raises:
+        RootlyValidationError: If validation fails
+    """
+    if not isinstance(value, dict):
+        raise RootlyValidationError(f"{field_name} must be a dict, got {type(value).__name__}")
+
+    if required_keys:
+        missing_keys = set(required_keys) - set(value.keys())
+        if missing_keys:
+            raise RootlyValidationError(
+                f"{field_name} is missing required keys: {', '.join(missing_keys)}"
+            )
+
+    return value
+
+
+def validate_enum(value: Any, field_name: str, allowed_values: list[Any]) -> Any:
+    """
+    Validate that a value is one of the allowed values.
+
+    Args:
+        value: The value to validate
+        field_name: Name of the field for error messages
+        allowed_values: List of allowed values
+
+    Returns:
+        The validated value
+
+    Raises:
+        RootlyValidationError: If validation fails
+    """
+    if value not in allowed_values:
+        raise RootlyValidationError(f"{field_name} must be one of {allowed_values}, got {value}")
+
+    return value
+
+
+def validate_page_params(page_size: int, page_number: int) -> tuple[int, int]:
+    """
+    Validate pagination parameters.
+
+    Args:
+        page_size: Number of items per page
+        page_number: Page number (0 for all, 1+ for specific page)
+
+    Returns:
+        Tuple of validated (page_size, page_number)
+
+    Raises:
+        RootlyValidationError: If validation fails
+    """
+    page_size = validate_positive_integer(page_size, "page_size", min_value=1)
+    page_number = validate_positive_integer(page_number, "page_number", min_value=0)
+
+    if page_size > 100:
+        raise RootlyValidationError("page_size cannot exceed 100")
+
+    return page_size, page_number

{rootly_mcp_server-2.0.15.dist-info → rootly_mcp_server-2.1.0.dist-info}/METADATA

@@ -1,19 +1,27 @@
 Metadata-Version: 2.4
 Name: rootly-mcp-server
-Version: 2.0.15
-Summary: A Model Context Protocol server for Rootly APIs using OpenAPI spec
+Version: 2.1.0
+Summary: Secure Model Context Protocol server for Rootly APIs with AI SRE capabilities, comprehensive error handling, and input validation
 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
+Keywords: ai-sre,automation,devops,incident-management,incidents,llm,mcp,on-call,rate-limiting,rootly,security,sre
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Security
 Classifier: Topic :: Software Development :: Build Tools
-Requires-Python: >=3.12
+Classifier: Topic :: System :: Monitoring
+Classifier: Topic :: System :: Systems Administration
+Requires-Python: >=3.10
 Requires-Dist: brotli>=1.0.0
 Requires-Dist: fastmcp>=2.9.0
 Requires-Dist: httpx>=0.24.0
@@ -22,8 +30,11 @@ Requires-Dist: pydantic>=2.0.0
 Requires-Dist: requests>=2.28.0
 Requires-Dist: scikit-learn>=1.3.0
 Provides-Extra: dev
+Requires-Dist: bandit>=1.7.0; extra == 'dev'
 Requires-Dist: black>=23.0.0; extra == 'dev'
 Requires-Dist: isort>=5.0.0; extra == 'dev'
+Requires-Dist: mypy>=1.0.0; extra == 'dev'
+Requires-Dist: safety>=2.0.0; extra == 'dev'
 Description-Content-Type: text/markdown
 
 # Rootly MCP Server
@@ -31,12 +42,11 @@ Description-Content-Type: text/markdown
 [![PyPI version](https://badge.fury.io/py/rootly-mcp-server.svg)](https://pypi.org/project/rootly-mcp-server/)
 [![PyPI - Downloads](https://img.shields.io/pypi/dm/rootly-mcp-server)](https://pypi.org/project/rootly-mcp-server/)
 [![Python Version](https://img.shields.io/pypi/pyversions/rootly-mcp-server.svg)](https://pypi.org/project/rootly-mcp-server/)
+[![Install MCP Server](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/install-mcp?name=rootly&config=eyJjb21tYW5kIjoibnB4IC15IG1jcC1yZW1vdGUgaHR0cHM6Ly9tY3Aucm9vdGx5LmNvbS9zc2UgLS1oZWFkZXIgQXV0aG9yaXphdGlvbjoke1JPT1RMWV9BVVRIX0hFQURFUn0iLCJlbnYiOnsiUk9PVExZX0FVVEhfSEVBREVSIjoiQmVhcmVyIDxZT1VSX1JPT1RMWV9BUElfVE9LRU4%2BIn19)
 
 An MCP server for the [Rootly API](https://docs.rootly.com/api-reference/overview) that integrates seamlessly with 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)
+![Demo GIF](https://raw.githubusercontent.com/Rootly-AI-Labs/Rootly-MCP-server/refs/heads/main/rootly-mcp-server-demo.gif)
 
 ## Prerequisites
 
@@ -45,7 +55,17 @@ An MCP server for the [Rootly API](https://docs.rootly.com/api-reference/overvie
   ```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)
+- [Rootly API token](https://docs.rootly.com/api-reference/overview#how-to-generate-an-api-key%3F) with appropriate permissions (see below)
+
+### API Token Permissions
+
+The MCP server requires a Rootly API token. Choose the appropriate token type based on your needs:
+
+- **Global API Key** (Recommended): Full access to all entities across your Rootly instance. Required for organization-wide visibility across teams, schedules, and incidents.
+- **Team API Key**: Team Admin permissions with full read/edit access to entities owned by that team. Suitable for team-specific workflows.
+- **Personal API Key**: Inherits the permissions of the user who created it. Works for individual use cases but may have limited visibility.
+
+For full functionality of tools like `get_oncall_handoff_summary`, `get_oncall_shift_metrics`, and organization-wide incident search, a **Global API Key** is recommended.
 
 ## Installation
 
@@ -144,11 +164,38 @@ Alternatively, connect directly to our hosted MCP server:
 - **Smart Pagination**: Defaults to 10 items per request for incident endpoints to prevent context window overflow
 - **API Filtering**: Limits exposed API endpoints for security and performance
 - **Intelligent Incident Analysis**: Smart tools that analyze historical incident data
-  - **`find_related_incidents`**: Uses TF-IDF similarity analysis to find historically similar incidents  
+  - **`find_related_incidents`**: Uses TF-IDF similarity analysis to find historically similar incidents
   - **`suggest_solutions`**: Mines past incident resolutions to recommend actionable solutions
 - **MCP Resources**: Exposes incident and team data as structured resources for easy AI reference
 - **Intelligent Pattern Recognition**: Automatically identifies services, error types, and resolution patterns
 
+## Example Skills
+
+Want to get started quickly? We provide pre-built Claude Code skills that showcase the full power of the Rootly MCP server:
+
+### 🚨 [Rootly Incident Responder](examples/skills/rootly-incident-responder.md)
+
+An AI-powered incident response specialist that:
+- Analyzes production incidents with full context
+- Finds similar historical incidents using ML-based similarity matching
+- Suggests solutions based on past successful resolutions
+- Coordinates with on-call teams across timezones
+- Correlates incidents with recent code changes and deployments
+- Creates action items and remediation plans
+- Provides confidence scores and time estimates
+
+**Quick Start:**
+```bash
+# Copy the skill to your project
+mkdir -p .claude/skills
+cp examples/skills/rootly-incident-responder.md .claude/skills/
+
+# Then in Claude Code, invoke it:
+# @rootly-incident-responder analyze incident #12345
+```
+
+This skill demonstrates a complete incident response workflow using Rootly's intelligent tools combined with GitHub integration for code correlation.
+
 ### Available Tools
 
 **Alerts**
@@ -296,10 +343,6 @@ get_shift_incidents(
 
 Returns: `incidents` list + `summary` (counts, avg resolution time, grouping)
 
-## About Rootly AI Labs
-
-This project was developed by [Rootly AI Labs](https://labs.rootly.ai/), where we're building the future of system reliability and operational excellence. As an open-source incubator, we share ideas, experiment, and rapidly prototype solutions that benefit the entire community.
-![Rootly AI logo](https://github.com/Rootly-AI-Labs/EventOrOutage/raw/main/rootly-ai.png)
 
 ## Developer Setup & Troubleshooting
 
@@ -348,3 +391,13 @@ The server should now be ready to use with your MCP-compatible editor.
 
 **For developers:** Additional testing tools are available in the `tests/` directory.
 
+## Play with it on Postman
+[<img src="https://run.pstmn.io/button.svg" alt="Run In Postman" style="width: 128px; height: 32px;">](https://god.gw.postman.com/run-collection/45004446-1074ba3c-44fe-40e3-a932-af7c071b96eb?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D45004446-1074ba3c-44fe-40e3-a932-af7c071b96eb%26entityType%3Dcollection%26workspaceId%3D4bec6e3c-50a0-4746-85f1-00a703c32f24)
+
+
+## About Rootly AI Labs
+
+This project was developed by [Rootly AI Labs](https://labs.rootly.ai/), where we're building the future of system reliability and operational excellence. As an open-source incubator, we share ideas, experiment, and rapidly prototype solutions that benefit the entire community.
+![Rootly AI logo](https://github.com/Rootly-AI-Labs/EventOrOutage/raw/main/rootly-ai.png)
+
+

rootly_mcp_server-2.1.0.dist-info/RECORD

@@ -0,0 +1,18 @@
+rootly_mcp_server/__init__.py,sha256=LAXe2qmP6Yw5MMx-02NAIObwY6l4lKDf8SegYJ0jUhs,873
+rootly_mcp_server/__main__.py,sha256=mt74vaOpfHnX5rTO0CFAeulatR_9K3NBNCaLAhBLxlc,6886
+rootly_mcp_server/client.py,sha256=Qca2R9cgBxXcyobQj4RHl8gdxLB4Jphq0RIr61DAVKw,6542
+rootly_mcp_server/exceptions.py,sha256=67J_wlfOICg87eUipbkARzn_6u_Io82L-5cVnk2UPr0,4504
+rootly_mcp_server/monitoring.py,sha256=k1X7vK65FOTrCrOsLUXrFm6AJxKpXt_a0PzL6xdPuVU,11681
+rootly_mcp_server/pagination.py,sha256=2hZSO4DLUEJZbdF8oDfIt2_7X_XGBG1jIxN8VGmeJBE,2420
+rootly_mcp_server/security.py,sha256=YkMoVALZ3XaKnMu3yF5kVf3SW_jdKHllSMwVLk1OlX0,11556
+rootly_mcp_server/server.py,sha256=tJLRJgurdFlq-7m7jCsRYCeD1LFUbLff0YQ7yUQJWVc,115527
+rootly_mcp_server/smart_utils.py,sha256=c7S-8H151GfmDw6dZBDdLH_cCmR1qiXkKEYSKc0WwUY,23481
+rootly_mcp_server/texttest.json,sha256=KV9m13kWugmW1VEpU80Irp50uCcLgJtV1YT-JzMogQg,154182
+rootly_mcp_server/utils.py,sha256=TWG1MaaFKrU1phRhU6FgHuZAEv91JOe_1w0L2OrPJMY,4406
+rootly_mcp_server/validators.py,sha256=z1Lvel2SpOFLo1cPdQGSrX2ySt6zqR42w0R6QV9c2Cc,4092
+rootly_mcp_server/data/__init__.py,sha256=KdWD6hiRssHXt0Ywgj3wjNHY1sx-XSPEqVHqrTArf54,143
+rootly_mcp_server-2.1.0.dist-info/METADATA,sha256=0fXm7kY3z3npobc9BeEm-P0R6Et3yRGAisb-Wcr40vM,13560
+rootly_mcp_server-2.1.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+rootly_mcp_server-2.1.0.dist-info/entry_points.txt,sha256=NE33b8VgigVPGBkboyo6pvN1Vz35HZtLybxMO4Q03PI,70
+rootly_mcp_server-2.1.0.dist-info/licenses/LICENSE,sha256=c9w9ZZGl14r54tsP40oaq5adTVX_HMNHozPIH2ymzmw,11341
+rootly_mcp_server-2.1.0.dist-info/RECORD,,

{rootly_mcp_server-2.0.15.dist-info → rootly_mcp_server-2.1.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.27.0
+Generator: hatchling 1.28.0
 Root-Is-Purelib: true
 Tag: py3-none-any

rootly_mcp_server-2.0.15.dist-info/RECORD

@@ -1,13 +0,0 @@
-rootly_mcp_server/__init__.py,sha256=rvIuqIyuzgC7b9qSnylrdDP2zPO-7Ou9AoblR6re1co,629
-rootly_mcp_server/__main__.py,sha256=_F4p65_VjnN84RtmEdESVLLH0tO5tL9qBfb2Xdvbj2E,6480
-rootly_mcp_server/client.py,sha256=uit-YijR7OAJtysBoclqnublEDVkFfcb29wSzhpBv44,4686
-rootly_mcp_server/server.py,sha256=Qmsv-BKNhsEj8_7S1glBgLEN6OlSKqOvMRgJ40ZFeCg,98716
-rootly_mcp_server/smart_utils.py,sha256=lvGN9ITyJjBkm7ejpYagd8VWodLKnC6FmwECfCOcGwM,22973
-rootly_mcp_server/texttest.json,sha256=KV9m13kWugmW1VEpU80Irp50uCcLgJtV1YT-JzMogQg,154182
-rootly_mcp_server/utils.py,sha256=NyxdcDiFGlV2a8eBO4lKgZg0D7Gxr6xUIB0YyJGgpPA,4165
-rootly_mcp_server/data/__init__.py,sha256=fO8a0bQnRVEoRMHKvhFzj10bhoaw7VsI51czc2MsUm4,143
-rootly_mcp_server-2.0.15.dist-info/METADATA,sha256=stGxakp4C-3jGIZG7pqAm3wim_UxAlrTikO--kApdiE,10552
-rootly_mcp_server-2.0.15.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-rootly_mcp_server-2.0.15.dist-info/entry_points.txt,sha256=NE33b8VgigVPGBkboyo6pvN1Vz35HZtLybxMO4Q03PI,70
-rootly_mcp_server-2.0.15.dist-info/licenses/LICENSE,sha256=c9w9ZZGl14r54tsP40oaq5adTVX_HMNHozPIH2ymzmw,11341
-rootly_mcp_server-2.0.15.dist-info/RECORD,,