Velociraptor MCP 服务器

构建者: mgreen27/mcp-velociraptor
贡献者: Snoe Findley

Velociraptor 模型上下文协议 (MCP) 服务器是一个专为数字取证和事件响应 (DFIR) 设计的集成接口。它使 LLM 框架（如 Claude、Gemini、Open WebUI 和 n8n）能够以编程方式与 Velociraptor 端点监控引擎进行交互。

概述

此 MCP 服务器向 AI 智能体公开了标准的 Velociraptor 功能，允许它们：

• 使用 YARA 进行文件和内存扫描。

• 执行补救操作，包括网络隔离和进程终止。

• 在 Windows、macOS 和 Linux 上执行工件收集（例如：MFT 解析、事件日志提取、USN 日志分析和进程内存检查）。

安全说明： 服务器强制执行数据限制和 VQL 字符串清理，以减轻令牌溢出并防止 VQL 注入。它依赖于标准的内置 Velociraptor 工件来确保端点稳定性，而不是执行任意命令行脚本。

Related MCP server: Velociraptor MCP Server

1. 先决条件

需要一个正在运行的 Velociraptor 服务器和相应的 API 配置文件。此外：

• 对于本地 (stdio) 部署： 必须安装 Python 3.10+。

• 对于网络 (SSE) 部署： 必须安装 Docker 和 Docker Compose。

1. 在您的 Velociraptor 服务器上创建一个专用的 API 用户：

   velociraptor --config /etc/velociraptor/server.config.yaml config api_client --name mcp_agent --role administrator,api api_client.yaml

2. 将 api_client.yaml 复制到此项目的根目录。

3. 将 .env.example 重命名为 .env 并映射配置环境变量：

   VELOCIRAPTOR_API_CONFIG=api_client.yaml

2. 本地部署 (stdio)

通过标准输入/输出 (stdio) 部署是本地桌面客户端（如 Claude Desktop、Claude Code 或 Gemini CLI）的推荐配置。

设置

1. 确保已安装 Python 3.10+。

2. 初始化并激活虚拟环境：

   python -m venv .venv
   # Windows
   .venv\Scripts\activate 
   # Mac/Linux
   source .venv/bin/activate

3. 安装依赖项：

   pip install -r requirements.txt

连接您的客户端

使用 stdio 传输方式将连接添加到您的 MCP 客户端配置文件中。直接指向您虚拟环境的 python 可执行文件：

{
  "mcpServers": {
    "velociraptor-dfir": {
      "command": "/path/to/repo/.venv/bin/python",
      "args": ["/path/to/repo/mcp_velociraptor_bridge.py"]
    }
  }
}

3. 网络部署 (Docker / SSE)

对于 Open WebUI 或 n8n 等基于服务器的平台，可以通过包含的 Docker Compose 配置，使用服务器发送事件 (SSE) 在本地网络上公开 MCP 服务器。

设置

此存储库利用 FastMCP HTTP 服务器来提供 SSE REST 端点。

1. 确保 api_client.yaml 和 .env 放置在根目录中。

2. 构建并启动 Docker 容器：

   docker compose up -d

3. 服务器将通过 http://<your-host-ip>:8088/sse 的 SSE 访问。

⚠️ 安全与加固要求

**[!CAUTION] 此 MCP 服务器在 Velociraptor 中拥有“管理员”权限。它有能力终止进程、检索文件并访问整个部署中敏感的端点数据。

当通过 Docker 在网络上公开服务器时：

• 无原生身份验证： 内置的 SSE 服务器不提供强大的 HTTP 身份验证机制。

• 减少暴露： 不要将端口 8088 暴露给公共互联网或不受信任的网络。

• 网络代理： 您必须在容器前部署反向代理（例如 Nginx、Traefik）以强制执行 双向 TLS (mTLS)、严格的 IP 白名单或同等的网络级身份验证。流量应明确限制为仅限授权的 LLM 使用节点。

文档

有关支持的 macOS、Linux 和 Windows 取证工具、配置详细信息和架构图的完整列表，请参考 综合文档。