# Panther MCP Server [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff) Panther's Model Context Protocol (MCP) server provides functionality to: 1. **Write and tune detections from your IDE** 2. **Interactively query security logs using natural language** 3. **Triage, comment, and resolve one or many alerts**

## Available Tools

Alerts

| Tool Name | Description | Sample Prompt | |-----------|-------------|---------------| | `add_alert_comment` | Add a comment to a Panther alert | "Add comment 'Looks pretty bad' to alert abc123" | | `get_alert_by_id` | Get detailed information about a specific alert | "What's the status of alert 8def456?" | | `get_alert_events` | Get a small sampling of events for a given alert | "Show me events associated with alert 8def456" | | `list_alerts` | List alerts with comprehensive filtering options (date range, severity, status, etc.) | "Show me all high severity alerts from the last 24 hours" | | `update_alert_assignee_by_id` | Update the assignee of one or more alerts | "Assign alerts abc123 and def456 to John" | | `update_alert_status` | Update the status of one or more alerts | "Mark alerts abc123 and def456 as resolved" | | `list_alert_comments` | List all comments for a specific alert | "Show me all comments for alert abc123" |

Data

| Tool Name | Description | Sample Prompt | |-----------|-------------|---------------| | `execute_data_lake_query` | Execute SQL queries against Panther's data lake | "Query AWS CloudTrail logs for failed login attempts in the last day" | | `get_data_lake_query_results` | Get results from a previously executed data lake query | "Get results for query ID abc123" | | `list_data_lake_queries` | List previously executed data lake queries with comprehensive filtering options | "Show me all running queries from the last hour" | | `cancel_data_lake_query` | Cancel a running data lake query to free up resources and prevent system overload | "Cancel query abc123 that's taking too long" | | `get_table_schema` | Get schema information for a specific table | "Show me the schema for the AWS_CLOUDTRAIL table" | | `list_databases` | List all available data lake databases in Panther | "List all available databases" | | `list_log_sources` | List log sources with optional filters (health status, log types, integration type) | "Show me all healthy S3 log sources" | | `list_database_tables` | List all available tables for a specific database in Panther's data lake | "What tables are in the panther_logs database" | | `summarize_alert_events` | Analyze patterns and relationships across multiple alerts by aggregating their event data | "Show me patterns in events from alerts abc123 and def456" |

Rules

| Tool Name | Description | Sample Prompt | |-----------|-------------|---------------| | `disable_rule` | Disable a rule by setting enabled to false | "Disable rule abc123" | | `get_global_helper_by_id` | Get detailed information about a specific global helper | "Get details for global helper ID panther_github_helpers" | | `get_policy_by_id` | Get detailed information about a specific policy | "Get details for policy ID AWS.S3.Bucket.PublicReadACP" | | `get_rule_by_id` | Get detailed information about a specific rule | "Get details for rule ID abc123" | | `get_scheduled_rule_by_id` | Get detailed information about a specific scheduled rule | "Get details for scheduled rule abc123" | | `get_simple_rule_by_id` | Get detailed information about a specific simple rule | "Get details for simple rule abc123" | | `list_global_helpers` | List all Panther global helpers with optional pagination | "Show me all global helpers for CrowdStrike events" | | `list_policies` | List all Panther policies with optional pagination | "Show me all policies for AWS resources" | | `list_rules` | List all Panther rules with optional pagination | "Show me all enabled rules" | | `list_scheduled_rules` | List all scheduled rules with optional pagination | "List all scheduled rules in Panther" | | `list_simple_rules` | List all simple rules with optional pagination | "Show me all simple rules in Panther" | | `list_data_models` | List data models that control UDM mappings in rules | "Show me all data models for log parsing" | | `get_data_model_by_id` | Get detailed information about a specific data model | "Get the complete details for the 'AWS_CloudTrail' data model" | | `list_globals` | List global helper functions with filtering options | "Show me global helpers containing 'aws' in the name" | | `get_global_by_id` | Get detailed information and code for a specific global helper | "Get the complete code for global helper 'AWSUtilities'" |

Schemas

| Tool Name | Description | Sample Prompt | |-----------|-------------|---------------| | `list_log_type_schemas` | List available log type schemas with optional filters | "Show me all AWS-related schemas" | | `get_panther_log_type_schema` | Get detailed information for specific log type schemas | "Get full details for AWS.CloudTrail schema" |

Metrics

| Tool Name | Description | Sample Prompt | |-----------|-------------|---------------| | `get_rule_alert_metrics` | Get metrics about alerts grouped by rule | "Show top 10 rules by alert count" | | `get_severity_alert_metrics` | Get metrics about alerts grouped by severity | "Show alert counts by severity for the last week" | | `get_bytes_processed_per_log_type_and_source` | Get data ingestion metrics by log type and source | "Show me data ingestion volume by log type" |

Users & Access Management

| Tool Name | Description | Sample Prompt | |-----------|-------------|---------------| | `list_panther_users` | List all Panther user accounts | "Show me all active Panther users" | | `get_user_by_id` | Get detailed information about a specific user | "Get details for user ID 'john.doe@company.com'" | | `get_permissions` | Get the current user's permissions | "What permissions do I have?" | | `list_roles` | List all roles with filtering options (name search, role IDs, sort direction) | "Show me all roles containing 'Admin' in the name" | | `get_role_by_id` | Get detailed information about a specific role including permissions | "Get complete details for the 'Admin' role" |

## Panther Configuration **Follow these steps to configure your API credentials and environment.** 1. Create an API token in Panther: - Navigate to Settings (gear icon) → API Tokens - Create a new token with the following permissions (recommended read-only approach to start): -

View Required Permissions

![Screenshot of Panther Token permissions](.github/panther-token-perms-1.png) ![Screenshot of Panther Token permissions](.github/panther-token-perms-2.png)

2. Store the generated token securely (e.g., 1Password) 3. Copy the Panther instance URL from your browser (e.g., `https://YOUR-PANTHER-INSTANCE.domain`) - Note: This must include `https://` ## MCP Server Installation **Choose one of the following installation methods:** ### Docker (Recommended) The easiest way to get started is using our pre-built Docker image: ```json { "mcpServers": { "mcp-panther": { "command": "docker", "args": [ "run", "-i", "-e", "PANTHER_INSTANCE_URL", "-e", "PANTHER_API_TOKEN", "--rm", "ghcr.io/panther-labs/mcp-panther" ], "env": { "PANTHER_INSTANCE_URL": "https://YOUR-PANTHER-INSTANCE.domain", "PANTHER_API_TOKEN": "YOUR-API-KEY" } } } } ``` ### UVX For Python users, you can run directly from PyPI using uvx: 1. [Install UV](https://docs.astral.sh/uv/getting-started/installation/) 2. Configure your MCP client: ```json { "mcpServers": { "mcp-panther": { "command": "uvx", "args": ["mcp-panther"], "env": { "PANTHER_INSTANCE_URL": "https://YOUR-PANTHER-INSTANCE.domain", "PANTHER_API_TOKEN": "YOUR-PANTHER-API-TOKEN" } } } } ``` ## MCP Client Setup ### Cursor [Follow the instructions here](https://docs.cursor.com/context/model-context-protocol#configuring-mcp-servers) to configure your project or global MCP configuration. **It's VERY IMPORTANT that you do not check this file into version control.** Once configured, navigate to Cursor Settings > MCP to view the running server:

**Tips:** * Be specific about where you want to generate new rules by using the `@` symbol and then typing a specific directory. * For more reliability during tool use, try selecting a specific model, like Claude 3.7 Sonnet. * If your MCP Client is failing to find any tools from the Panther MCP Server, try restarting the Client and ensuring the MCP server is running. In Cursor, refresh the MCP Server and start a new chat. ### Claude Desktop To use with Claude Desktop, manually configure your `claude_desktop_config.json`: 1. Open the Claude Desktop settings and navigate to the Developer tab 2. Click "Edit Config" to open the configuration file 3. Add the following configuration: ```json { "mcpServers": { "mcp-panther": { "command": "uvx", "args": ["mcp-panther"], "env": { "PANTHER_INSTANCE_URL": "https://YOUR-PANTHER-INSTANCE.domain", "PANTHER_API_TOKEN": "YOUR-PANTHER-API-TOKEN" } } } } ``` 4. Save the file and restart Claude Desktop If you run into any issues, [try the troubleshooting steps here](https://modelcontextprotocol.io/quickstart/user#troubleshooting). ### Goose Use with [Goose](https://block.github.io/goose/), Block's open-source AI agent: ```bash # Start Goose with the MCP server goose session --with-extension "uvx mcp-panther --compat-mode" ``` The `--compat-mode` flag enables compatibility mode for broader MCP client support, especially for clients using older MCP versions that may not support all the latest features. ## Security Best Practices We highly recommends the following MCP security best practices: - **Apply strict least-privilege to Panther API tokens.** Scope tokens to the minimal permissions required and bind them to an IP allow-list or CIDR range so they're useless if exfiltrated. Rotate credentials on a preferred interval (e.g., every 30d). - **Host the MCP server in a locked-down sandbox (e.g., Docker) with read-only mounts.** This confines any compromise to a minimal blast radius. - **Monitor credential access to Panther and monitor for anomalies.** Write a Panther rule! - **Run only trusted, officially signed MCP servers.** Verify digital signatures or checksums before running, audit the tool code, and avoid community tools from unofficial publishers. ## Troubleshooting Check the server logs for detailed error messages: `tail -n 20 -F ~/Library/Logs/Claude/mcp*.log`. Common issues and solutions are listed below. ### Running tools - If you get a `{"success": false, "message": "Failed to [action]: Request failed (HTTP 403): {\"error\": \"forbidden\"}"}` error, it likely means your API token lacks the particular permission needed by the tool. - Ensure your Panther Instance URL is correctly set. You can view this in the `config://panther` resource from your MCP Client. ## License This project is licensed under the Apache License 2.0 - see the LICENSE file for details. ## Contributors This project exists thanks to all the people who contribute. Special thanks to [Tomasz Tchorz](https://github.com/tomasz-sq) and [Glenn Edwards](https://github.com/glenn-sq) from [Block](https://block.xyz), who played a core role in launching MCP-Panther as a joint open-source effort with Panther. See our [CONTRIBUTORS.md](.github/CONTRIBUTORS.md) for a complete list of contributors. ## Contributing We welcome contributions to improve MCP-Panther! Here's how you can help: 1. **Report Issues**: Open an issue for any bugs or feature requests 2. **Submit Pull Requests**: Fork the repository and submit PRs for bug fixes or new features 3. **Improve Documentation**: Help us make the documentation clearer and more comprehensive 4. **Share Use Cases**: Let us know how you're using MCP-Panther and what could make it better Please ensure your contributions follow our coding standards and include appropriate tests and documentation. ---

mcp-panther

# mcpServer Config

# stdio

# `mcpServer` Config