Skip to content

Victron VRM MCP Server — 44 tools

The Victron VRM DADL turns Victron VRM's API into an MCP server that Claude, GPT or any MCP-compatible agent can consume directly. One YAML file declares all 44 tools — widget, data, installation, alarm, diagnostic, dynamic, and more — and ToolMesh serves them at runtime. No Python boilerplate, no per-endpoint code, no separate MCP server process.

Below: the endpoint coverage matrix, a two-block ToolMesh setup, the full tool reference grouped by Victron VRM feature area.

Source: Victron Energy VRM REST API v2

Credits: Dunkel Cloud GmbH -- maintainerUpdated: 2026-03-31

Which Victron VRM endpoints are covered?

82% (41 of ~50 endpoints)

Focus: auth, users, installations, stats, widgets, diagnostics, alarms, data export, GPS, tags, dynamic ESS, firmware, data attributes

Missing: admin endpoints, access token CRUD, installation settings write, alarm acknowledgement

Last reviewed: 2026-03-31

How do you configure the Victron VRM DADL?

  1. Log in to the VRM Portal at https://vrm.victronenergy.com
  2. Navigate to Preferences → Integrations → Access tokens
  3. Click 'New token', give it a descriptive name
  4. Copy the generated token immediately -- it is shown only once
  5. Store the token prefixed with 'Token ' (e.g. 'Token abc123def456') in the credential store

Environment variable: CREDENTIAL_VICTRON_VRM_TOKEN

Authentication docs ↗

Personal Access Tokens bypass the login flow entirely. Use /users/me to get your idUser, then /users/{idUser}/installations to discover your sites. The token has full access to all installations the VRM user can see.

How do you install the Victron VRM MCP server with ToolMesh?

Add to your backends.yaml:

- name: victron-vrm
  transport: rest
  dadl: /app/dadl/victron-vrm.dadl

Set the credential:

CREDENTIAL_VICTRON_VRM_TOKEN=your-token-here

What 44 tools does the Victron VRM DADL expose?

POSTloginAuthenticate with username/password and receive a bearer token. Prefer Personal Access Tokens for automation.
GETlogin_as_demoLog in as the demo user to explore the API without credentials
GETlogoutInvalidate the current session token
GETget_current_userGet the current authenticated user's profile and idUser. Essential first call when using Personal Access Tokens.
GETlist_installationsList all installations accessible to a user. Returns idSite, name, and system overview for each.
GETget_installationGet high-level system overview for a specific installation including current power flow
GETsearch_installationsSearch through the user's installations by name, notes, or address
GETget_installation_tagsGet tags/labels assigned to an installation
GETget_statsGet time-series statistics for an installation. Types: venus, live_feed, consumption, kwh, solar_yield, forecast.
GETget_overall_statsGet aggregated lifetime totals for an installation (total kWh generated, consumed, etc.)
GETdownload_dataDownload historical data as CSV or Excel for an installation
GETdownload_gps_dataDownload GPS tracking data for a mobile installation (e.g. boat, RV)
GETget_alarmsGet active and historical alarms for an installation. Also returns device list and user notification settings.
GETget_diagnosticsGet the most recent diagnostic data points for all devices at an installation
GETget_widgetGet widget data for a specific device category. See hints for available widget types.
GETget_widget_graphGet graph widget data with time-series values for specific device instances and attributes
GETget_widget_batteryGet battery summary: voltage, current, state of charge (SoC), temperature, and health
GETget_widget_solar_chargerGet MPPT solar charger data: PV voltage, current, yield, and charger state
GETget_widget_vebus_stateGet VE.Bus system state: inverter/charger mode, input voltage, output power
GETget_widget_inverter_charger_stateGet inverter/charger operational mode and status
GETget_widget_statusGet general system status overview for the installation
GETget_widget_pv_inverterGet PV inverter AC output: power, voltage, current per phase
GETget_widget_ev_chargerGet EV charger status: charging power, session energy, and state
GETget_widget_tankGet tank level and capacity for fuel, water, or waste tanks
GETget_widget_temperatureGet temperature sensor readings and graphical data
GETget_widget_dc_meterGet DC power meter readings (voltage, current, power)
GETget_widget_motorGet motor drive summary: RPM, power, and temperature
GETget_widget_gpsGet current GPS position for mobile installations (boats, RVs)
GETget_widget_global_linkGet GlobalLink 520 device summary and connectivity status
GETget_widget_vebus_warningsGet VE.Bus system warnings and alarm conditions
GETget_widget_inverter_warningsGet inverter/charger warning and alarm conditions
GETget_widget_bms_diagnosticsGet BMS cell voltages, balancing data, and battery management diagnostics
GETget_widget_lithium_bmsGet lithium battery BMS details: cell voltages, temperatures, and balancing
GETget_widget_historic_dataGet historic data trend analysis for device performance over time
GETget_widget_io_extenderGet IO extender digital and analog input/output signals
GETget_widget_charger_relayGet charger relay switching status
GETget_widget_solar_charger_relayGet solar charger relay state
GETget_widget_gateway_relayGet primary gateway (GX device) relay state
GETget_widget_gateway_relay_twoGet secondary gateway (GX device) relay state
GETget_widget_customGet custom widget configuration and data
GETget_dynamic_essGet Dynamic ESS (Energy Storage System) settings and schedule for optimized battery usage
GETget_data_attributesGet all available data attribute definitions (codes, labels, units) used across the VRM API
GETget_firmwaresList available firmware versions for Victron devices
GETreset_forecastsGet forecast reset timestamps for recalculation scheduling