Click on "Install Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@Vectra AI MCP ServerSummarize the most critical threat detections from the last 24 hours"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
Vectra AI MCP Server
This project implements an MCP server for the Vectra AI Platform.
What is Vectra AI MCP?
An MCP server that connects AI assistants to your Vectra AI security platform, enabling intelligent analysis of threat detection data, security insights, and automated incident response workflows. Compatible with Claude, ChatGPT, Cursor, VS Code and other MCP-enabled AI tools.
What can you do with Vectra AI MCP?
Investigate threats in natural language
Take response actions in Vectra directly from your AI agent
Correlate and analyze security data using prompts
Dynamically build advanced visulizations for analysis
Generate investigation reports from natural language
Setup - Host Locally
Prerequisites
Install Python Check .python-version file for the required version
Install uv - Python package manager
Setup Steps
Clone/Download the project to your local machine
Navigate to the project directory:
Configure environment variables:
Then edit the .env file with your actual Vectra AI Platform credentials. Required variables to update:
VECTRA_BASE_URL: Your Vectra portal URLVECTRA_CLIENT_ID: Your client ID from VectraVECTRA_CLIENT_SECRET: Your client secret from Vectra
Create and activate a virtual environment:
Install dependencies:
This will install all dependencies specified in pyproject.toml using the exact versions from uv.lock.
Run the application:
The server supports multiple transport protocols:
Transport Options:
stdio: Standard input/output communication (default, used by Claude Desktop)
sse: Server-Sent Events over HTTP (good for web-based clients)
streamable-http: Streamable HTTP transport (recommended for production HTTP deployments)
Environment Variables: You can also configure the server using environment variables:
MCP Configuration for Claude Desktop
Add MCP Server to Claude Desktop:
Add the following configuration to the mcpServers section (update the paths to match your setup):
Example with actual paths:
Debug - Find your uv installation path:
Debug - Get your project's absolute path:
Restart Claude Desktop to load the new MCP server configuration.
Other MCP Client Setup
Once configured, you should be able to use Vectra AI Platform capabilities directly within Claude Desktop or other MCP clients through this MCP server!
For other MCP clients besides Claude Desktop, refer to the documentation links below:
MCP Client | Documentation Link |
General MCP Setup | |
Cursor | |
VS Code | https://code.visualstudio.com/docs/copilot/chat/mcp-servers#_add-an-mcp-server |
For other MCP clients, refer to their respective documentation. The general pattern is similar - you'll need to specify the command and arguments to run the MCP server with the same configuration structure.
Setup - Docker Deployment
For production deployments or easier setup, you can run the Vectra AI MCP Server using Docker. We provide two options:
Option 1: Using Pre-built Images (Recommended)
The easiest way to get started is using our pre-built Docker images from GitHub Container Registry.
Prerequisites
Docker Desktop or Docker Engine
Quick Start Steps
Configure environment variables:
Then edit the .env file with your actual Vectra AI Platform credentials.
Run with pre-built image:
Streamable HTTP Transport (Recommended for Production)
SSE Transport (Server-Sent Events)
Stdio Transport (For Local MCP Clients)
Or use Docker Compose (Alternative):
Create a docker-compose.yml file:
Then run:
Available Tags:
latest: Latest stable build from main branchmain: Latest build from main branch (same as latest)v*: Specific version tags (e.g., v1.0.0)
💡 Tip: Pre-built images are automatically built and published via GitHub Actions whenever code is pushed to the main branch or when releases are tagged. This ensures you always get the latest tested version without needing to build locally.
Option 2: Build from Source
For development or customization, you can build the Docker image from source.
Prerequisites
Install Docker and Docker Compose
Docker Desktop (includes Docker Compose)
Or install Docker Engine and Docker Compose separately on Linux
Build from Source Steps
Clone/Download the project to your local machine
Navigate to the project directory:
Configure environment variables:
Then edit the .env file with your actual Vectra AI Platform credentials.
Build and run with Docker:
Run the locally built image:
Choose your transport mode and run with the locally built image:
Streamable HTTP Transport
SSE Transport
Stdio Transport
Docker Environment Variables
The Docker container supports all the same environment variables as the local setup, plus additional MCP server configuration:
MCP Server Configuration
VECTRA_MCP_TRANSPORT: Transport protocol (stdio,sse, orstreamable-http) - default:stdioVECTRA_MCP_HOST: Host to bind to for HTTP transports - default:0.0.0.0VECTRA_MCP_PORT: Port for HTTP transports - default:8000VECTRA_MCP_DEBUG: Enable debug logging - default:false
Accessing the HTTP Server
When running with HTTP transports (sse or streamable-http), the MCP server will be available at:
Streamable HTTP:
http://localhost:8000/mcpSSE:
http://localhost:8000/sse
MCP Client Configuration for Docker
For HTTP-based MCP clients connecting to the Dockerized server, use the appropriate endpoint:
Docker Health Checks
The Docker container includes health checks that will verify the server is running properly:
For
stdiotransport: Always reports healthy (no HTTP endpoint to check)For HTTP transports: Checks HTTP endpoint availability
Note: MCP (Model Context Protocol) is an emerging and rapidly evolving technology. Exercise caution when using this server and follow security best practices, including proper credential management and network security measures.