Velociraptor
БесплатноНе проверенA proof-of-concept MCP bridge that exposes Velociraptor's forensic triage tools to LLMs, enabling natural language querying of Windows endpoints for artifacts l
Описание
A proof-of-concept MCP bridge that exposes Velociraptor's forensic triage tools to LLMs, enabling natural language querying of Windows endpoints for artifacts like network connections and suspicious processes.
README
Velociraptor MCP is a POC Model Context Protocol bridge for exposing LLMs to MCP clients.
Initial version has several Windows orientated triage tools deployed. Best use is querying usecase to target machine name.
e.g
can you give me all network connections on MACHINENAME and look for suspicious processes?
can you tell me which artifacts target the USN journal
Installation
1. Setup an API account
https://docs.velociraptor.app/docs/server_automation/server_api/
Generate an api config file:
velociraptor --config /etc/velociraptor/server.config.yaml config api_client --name api --role administrator,api api_client.yaml
2. Clone mcp-velociraptor repo and test API
- Copy
api_client.yamlto the repo root, or keep it anywhere local and setVELOCIRAPTOR_API_CONFIG=/path/to/api_client.yaml. - Copy
example.envto.envfor local development, then setVELOCIRAPTOR_API_CONFIGto your realapi_client.yamlpath. The bridge, smoke script, and agent load dotenv config automatically without overriding variables already supplied by your shell or MCP client. api_client.yamlis gitignored and should not be committed.- Run
.venv/bin/python test_api.pyto confirm the API works when.envis configured, or useVELOCIRAPTOR_API_CONFIG=/path/to/api_client.yaml .venv/bin/python test_api.pyto override it for a single run. - The MCP bridge reads the same
VELOCIRAPTOR_API_CONFIGenvironment variable after loading dotenv config. - For multi-tenant deployments, optionally set
VELOCIRAPTOR_ORG_IDto choose a default org context. - Set
VELOCIRAPTOR_DEBUG_VQL=1only when you want raw VQL request logging on stderr for debugging. - Set
ENABLE_DANGEROUS_TOOLS=trueonly when you explicitly want to enable raw VQL, quarantine, and remote process-kill tools. - The agent POC defaults to local Ollama summaries. Set
VELOCIRAPTOR_MODEL_PROVIDER=azure,AZURE_OPENAI_ENDPOINT,AZURE_OPENAI_API_KEY, andAZURE_OPENAI_MODELwhen you explicitly want Azure OpenAI summaries.
3. Connect to MCP client of choice
The easiest configuration is to run your venv python directly calling
mcp_velociraptor_bridge.py. You can either put values directly in the MCP
client config:
{
"mcpServers": {
"velociraptor": {
"command": "/path/to/venv/bin/python",
"env": {
"VELOCIRAPTOR_API_CONFIG": "/path/to/api_client.yaml",
"VELOCIRAPTOR_ORG_ID": "O123"
},
"args": [
"/path/to/mcp_velociraptor_bridge.py"
]
}
}
}
Or point the MCP client at a dotenv file:
{
"mcpServers": {
"velociraptor": {
"command": "/path/to/venv/bin/python",
"env": {
"VELOCIRAPTOR_ENV_FILE": "/path/to/mcp-velociraptor/.env"
},
"args": [
"/path/to/mcp_velociraptor_bridge.py"
]
}
}
}
Config precedence is: direct environment values from the MCP client or shell,
then VELOCIRAPTOR_ENV_FILE if set, then repo-local .env, then fallback
paths such as ./api_client.yaml and ~/.config/api_client.yaml.
The separate agent proof-of-concept now lives under agent_poc/. It now
includes an engagement manager that fans out to isolated, dynamically
allowlisted analysts in parallel. The engagement profile runs bounded
process, network, persistence, execution, user-activity, and system-inventory
roles; deep also opts into heavier filesystem and security roles. Evidence
collection is deterministic and synthesis is model-only per role. It supports local
Ollama summaries by default and opt-in Azure OpenAI API summaries via
environment configuration. Azure OpenAI mode sends collected evidence bundles
to the configured Azure API account for summarization. See
agent_poc/README.md for agent-specific usage and automation examples,
including verbose collection progress output with artifact names and row counts.
4. Tool Response Format
MCP tool responses are emitted as JSON text envelopes so stdio clients do not
need to parse Python repr() output:
{"ok": true, "data": {...}}
or
{"ok": false, "error": "message"}
collect_artifact and hunt_across_fleet accept parameters as a structured
JSON object with scalar values or lists of scalar values, for example
{"PathRegex": ".*", "Targets": ["_BasicCollection"]}. Legacy compatibility
input can be supplied via legacy_parameters with simple scalar assignments or
list literals such as PathRegex='.*',Targets=['_BasicCollection']; raw VQL
fragments are no longer passed through.
Parameterized hunts are validated against Velociraptor's compiled collector
args; if the requested artifact env does not land, the hunt is stopped and the
tool returns an error.
collect_forensic_triage wraps Windows.Triage.Targets with
Targets='["_BasicCollection"]' and a collection timeout of 2400 seconds.
5. Tool Inventory
The bridge now exposes the original Windows/Linux triage tools plus expanded fleet, Linux, macOS, Windows, YARA, and response helpers:
- Fleet:
list_orgs,client_info,list_clients,hunt_across_fleet,get_hunt_results_tool,run_vql. - Artifact discovery:
list_windows_artifacts,list_linux_artifacts, andlist_macos_artifactsacceptname_regexfilters andinclude_parameter_details=truefor full live parameter metadata fromartifact_definitions(). - Linux: process, group, mount, network, users, crontab, services, SSH keys/logins, shell history, last login, ARP cache, journal search, file finder, and YARA process scanning.
- macOS: process, users, network, LaunchAgents/Daemons, login items, shell history, browser history, quarantine events, TCC database, file finder, and artifact discovery.
- Windows: process, network, scheduled tasks, services, RecentDocs, Shellbags, USB/mount evidence, execution traces, MFT, USN, SRUM, EVTX, PowerShell, autoruns, WMI persistence, RDP, DNS cache, Recycle Bin, browser history, memory/malfind/mutant checks, shadow copies, timestomp checks, and file/YARA hunting with optional hash calculation.
- Generic response/collection:
collect_artifact,get_collection_results,collect_forensic_triage,collect_file,quarantine_host,unquarantine_host, andkill_process.
Thanks to @snoe-findley for sharing a fork that expanded available tools and some of the newer cross-platform additions.
6. Caveats
Due to the nature of DFIR, results depend on amount of data returned, model use and context window.
I have included a function to find artifacts and dynamically create collections but had mixed results. I have been pleasantly surprised with some results and disappointed when running other collections that cause lots of rows.
Check licencing - Anthropic's DPA is only tied to their Commercial Terms, which means that for client/production endpoint data you would need commercial licencing to leverage this MCP. Other MCP clients work just fine.
Please let me know how you go and feel free to add PR!
can you give me all network connections on MACHINENAME and look for suspicious processes?
can you tell me which artifacts target the USN journal
Установка Velociraptor
У этого сервера нет опубликованного пакета — он собирается из исходников. Открой репозиторий и следуй инструкции в README.
▸ github.com/mgreen27/mcp-velociraptorFAQ
Velociraptor MCP бесплатный?
Да, Velociraptor MCP бесплатный — установка в пару кликов через Unyly без оплаты.
Нужен ли API-ключ для Velociraptor?
Нет, Velociraptor работает без API-ключей и переменных окружения.
Velociraptor — hosted или self-hosted?
Self-hosted: сервер запускается локально на твоей машине командой из раздела установки.
Как установить Velociraptor в Claude Desktop, Claude Code или Cursor?
Открой Velociraptor на unyly.org, выбери вкладку своего клиента (Claude Desktop, Claude Code, Cursor) и нажми Install — конфиг сгенерируется автоматически, без правки JSON.
Похожие MCP
GitHub
PRs, issues, code search, CI status
автор: GitHubFilesystem
Secure file operations with configurable access controls.
Memory
Knowledge graph-based persistent memory system.
Template MCP Server
A CLI tool to create a new Model Context Protocol server project with TypeScript support, dual transport options, and an extensible structure
автор: mcpdotdirectCompare Velociraptor with
Не уверен что выбрать?
Найди свой стек за 60 секунд
Автор?
Embed-бейдж для README
Похожее
Все в категории development
