|
| 1 | +# Prowler MCP Server |
| 2 | + |
| 3 | +Access the entire Prowler ecosystem through the Model Context Protocol (MCP), the supported capabilities right now are: |
| 4 | + |
| 5 | +- Prowler Hub for checking the current covering in checks, fixers and compliance frameworks in Prowler. |
| 6 | + |
| 7 | +## Requirements |
| 8 | + |
| 9 | +- Python 3.12+ |
| 10 | +- Network access to `https://hub.prowler.com` |
| 11 | + |
| 12 | +## Installation |
| 13 | + |
| 14 | +### From Sources |
| 15 | + |
| 16 | +It is needed to have [uv](https://docs.astral.sh/uv/) installed. |
| 17 | + |
| 18 | +```bash |
| 19 | +git clone https://github.com/prowler-cloud/prowler.git |
| 20 | +``` |
| 21 | + |
| 22 | +## Running |
| 23 | + |
| 24 | +After installation, start the MCP server via the console script: |
| 25 | + |
| 26 | +```bash |
| 27 | +cd prowler/mcp_server |
| 28 | +uv run prowler-mcp |
| 29 | +``` |
| 30 | + |
| 31 | +Alternatively, you can run from wherever you want using `uvx` command: |
| 32 | + |
| 33 | +```bash |
| 34 | +uvx /path/to/prowler/mcp_server/ |
| 35 | +``` |
| 36 | + |
| 37 | +## Available Tools |
| 38 | + |
| 39 | +### Prowler Hub |
| 40 | + |
| 41 | +All tools are exposed under the `prowler_hub` prefix. |
| 42 | + |
| 43 | +- prowler_hub_get_check_filters: Return available filter values for checks (providers, services, severities, categories, compliances). Call this before `prowler_hub_get_checks` to build valid queries. |
| 44 | +- prowler_hub_get_checks: List checks with option of advanced filtering. |
| 45 | +- prowler_hub_search_checks: Full‑text search across check metadata. |
| 46 | +- prowler_hub_get_compliance_frameworks: List/filter compliance frameworks. |
| 47 | +- prowler_hub_search_compliance_frameworks: Full-text search across frameworks. |
| 48 | +- prowler_hub_list_providers: List Prowler official providers and their services. |
| 49 | +- prowler_hub_get_artifacts_count: Return total artifact count (checks + frameworks). |
| 50 | + |
| 51 | +## MCP Client Configuration |
| 52 | + |
| 53 | +Configure your MCP client to launch the server with the `uvx` command. Below is a generic snippet; consult your client's documentation for exact locations. |
| 54 | + |
| 55 | +```json |
| 56 | +{ |
| 57 | + "mcpServers": { |
| 58 | + "prowler": { |
| 59 | + "command": "uvx", |
| 60 | + "args": ["/path/to/prowler/mcp_server/"] |
| 61 | + } |
| 62 | + } |
| 63 | +} |
| 64 | +``` |
| 65 | + |
| 66 | +### Claude Desktop (macOS/Windows) |
| 67 | + |
| 68 | +Add the server to Claude Desktop’s config file, then restart the app. |
| 69 | + |
| 70 | +- macOS: `~/Library/Application Support/Claude/claude_desktop_config.json` |
| 71 | +- Windows: `%AppData%\Claude\claude_desktop_config.json` (e.g. `C:\\Users\\<you>\\AppData\\Roaming\\Claude\\claude_desktop_config.json`) |
| 72 | + |
| 73 | +Example content to append/merge: |
| 74 | + |
| 75 | +```json |
| 76 | +{ |
| 77 | + "mcpServers": { |
| 78 | + "prowler": { |
| 79 | + "command": "uvx", |
| 80 | + "args": ["/path/to/prowler/mcp_server/"] |
| 81 | + } |
| 82 | + } |
| 83 | +} |
| 84 | +``` |
| 85 | + |
| 86 | +## License |
| 87 | + |
| 88 | +This project follows the repository’s main license. See the [LICENSE](../LICENSE) file at the repository root. |
0 commit comments