fronius-mcp-server
v1.1.1
Published
MCP Server for Fronius Solar API - enables Claude Desktop access to solar inverter data
Maintainers
Readme
Fronius MCP Server
A Model Context Protocol (MCP) server for the Fronius Solar API. This server enables access to Fronius inverter data through the MCP protocol for direct use in Claude Desktop or any other MCP Host Application.
Features
- ✅ Full TypeScript implementation with strong typing
- ✅ Comprehensive Fronius Solar API v1 coverage - all major endpoints
- ✅ Configurable settings via environment variables
- ✅ Both Resources and Tools for maximum flexibility
- ✅ Connection testing on startup and via tools
- ✅ Claude Desktop integration with network permissions guide
Supported Fronius API Endpoints
System & Status
GetAPIVersion.cgi- API VersionGetLoggerInfo.cgi- System StatusGetLoggerLEDInfo.cgi- LED StatusGetActiveDeviceInfo.cgi- Active Devices
Inverter
GetInverterInfo.cgi- Static inverter informationGetInverterRealtimeData.cgi- Real-time data (various DataCollections)
Smart Meter & Power Flow
GetMeterRealtimeData.cgi- Smart meter real-time dataGetPowerFlowRealtimeData.fcgi- Energy flow visualization
Battery Storage
GetStorageRealtimeData.cgi- Battery storage system data (state of charge, power, temperature)
Smart Home Integration
GetOhmPilotRealtimeData.cgi- OhmPilot smart heating element controller data
Extended Features
GetArchiveData.cgi- Archive data with flexible time rangesGetSensorRealtimeData.cgi- Environmental sensors (temperature, irradiance)GetStringRealtimeData.cgi- DC string data (voltage, current per string)
Requirements
- Node.js 20+ (tested with Node.js 24)
- npm or yarn
Installation
# Clone repository
git clone https://github.com/huber/fronius-mcp-server.git
cd fronius-mcp-server
# Install dependencies
npm install
# Build TypeScript
npm run buildConfiguration
Environment Variables
Copy .env.example to .env and adjust values:
cp .env.example .envAvailable configuration options:
FRONIUS_HOST- Hostname or IP of Fronius device (default:fronius-inverter)FRONIUS_PORT- Port (default:80)FRONIUS_PROTOCOL- Protocol:httporhttps(default:http)FRONIUS_TIMEOUT- Request timeout in ms (default:10000)FRONIUS_DEVICE_ID- Default device ID (default:1)FRONIUS_RETRIES- Number of retry attempts (default:3)FRONIUS_RETRY_DELAY- Delay between retries in ms (default:1000)LOG_LEVEL- Log level:error,warn,info,debug(default:info)
Example Configurations
Local Fronius device with hostname:
FRONIUS_HOST=fronius-inverter.localWith IP address:
FRONIUS_HOST=192.168.1.100HTTPS (newer models):
FRONIUS_HOST=192.168.1.100
FRONIUS_PROTOCOL=https
FRONIUS_PORT=443Installation Options
Option 1: NPM Package (Easiest)
The simplest way to install and use the Fronius MCP Server is via npm:
Global Installation
1. Install globally:
npm install -g fronius-mcp-server2. Run directly:
# Basic usage
fronius-mcp-server --host fronius-inverter.local
# Advanced usage with HTTPS
fronius-mcp-server --host 192.168.1.100 --protocol https --port 443
# Test connection
fronius-mcp-server --test-connection --host fronius-inverter.localClaude Desktop Configuration
Edit your Claude Desktop configuration file:
- macOS:
~/Library/Application Support/Claude/claude_desktop_config.json - Windows:
%APPDATA%\Claude\claude_desktop_config.json
Basic Configuration:
{
"mcpServers": {
"fronius-solar": {
"command": "fronius-mcp-server",
"args": ["--host", "fronius-inverter.local"]
}
}
}Advanced Configuration:
{
"mcpServers": {
"fronius-solar": {
"command": "fronius-mcp-server",
"args": [
"--host", "192.168.1.100",
"--protocol", "https",
"--port", "443",
"--timeout", "15000"
]
}
}
}CLI Options
fronius-mcp-server --help
Options:
-h, --host <host> Fronius inverter hostname or IP address
-p, --port <port> Fronius inverter port (default: 80)
--protocol <protocol> Protocol http|https (default: http)
-t, --timeout <timeout> Request timeout in ms (default: 10000)
-d, --device-id <deviceId> Default device ID (default: 1)
-r, --retries <retries> Number of retry attempts (default: 3)
--retry-delay <delay> Delay between retries in ms (default: 1000)
-l, --log-level <level> Log level (default: info)
--test-connection Test connection and exit
--stdio Use stdio transport (default for MCP)
--version Show version informationAdvantages of NPM Installation
- ✅ Zero setup - No Docker or Node.js project setup required
- ✅ Global availability - Use
fronius-mcp-serverfrom anywhere - ✅ Easy updates -
npm update -g fronius-mcp-server - ✅ Built-in CLI - Rich command-line interface with help
- ✅ Cross-platform - Works on Windows, macOS, Linux
Option 2: Pre-built Docker Image
The easiest way to run the Fronius MCP Server is using the pre-built Docker image from Docker Hub:
Setup Steps
1. Pull the Pre-built Image
# No build required - use the pre-built image
docker pull dirkhuber/fronius-mcp-server:latestClaude Desktop Configuration
Basic Configuration (Hostname):
{
"mcpServers": {
"fronius-solar": {
"command": "docker",
"args": [
"run", "--rm", "-i",
"-e", "FRONIUS_HOST=fronius-inverter.local",
"dirkhuber/fronius-mcp-server:latest"
]
}
}
}Advanced Configuration (IP with HTTPS):
{
"mcpServers": {
"fronius-solar": {
"command": "docker",
"args": [
"run", "--rm", "-i",
"-e", "FRONIUS_HOST=192.168.1.100",
"-e", "FRONIUS_PROTOCOL=https",
"-e", "FRONIUS_PORT=443",
"-e", "FRONIUS_TIMEOUT=15000",
"dirkhuber/fronius-mcp-server:latest"
]
}
}
}That's it! No need to clone the repository or build anything. The pre-built Docker image contains everything needed.
Advantages of Pre-built Image
- ✅ Zero setup - No cloning, building, or Node.js required
- ✅ Always up-to-date - Latest stable version
- ✅ Multi-platform - Supports both AMD64 and ARM64 architectures
- ✅ Automatic updates - Pull new versions with
docker pull dirkhuber/fronius-mcp-server:latest
Option 3: Build Docker Image Yourself
If you prefer to build the image yourself or want to modify the code:
Setup Steps
1. Build the Docker Image
# Clone and build the container image
git clone https://github.com/huber/fronius-mcp-server.git
cd fronius-mcp-server
npm run docker:build2. Configure Claude Desktop
Edit your Claude Desktop configuration file:
- macOS:
~/Library/Application Support/Claude/claude_desktop_config.json - Windows:
%APPDATA%\Claude\claude_desktop_config.json
Use the locally built image name fronius-mcp-server instead of the Docker Hub image:
Basic Configuration (Hostname):
{
"mcpServers": {
"fronius-solar": {
"command": "docker",
"args": [
"run", "--rm", "-i",
"-e", "FRONIUS_HOST=fronius-inverter.local",
"fronius-mcp-server"
]
}
}
}Advanced Configuration (IP with HTTPS):
{
"mcpServers": {
"fronius-solar": {
"command": "docker",
"args": [
"run", "--rm", "-i",
"-e", "FRONIUS_HOST=192.168.1.100",
"-e", "FRONIUS_PROTOCOL=https",
"-e", "FRONIUS_PORT=443",
"-e", "FRONIUS_TIMEOUT=15000",
"fronius-mcp-server"
]
}
}
}How Docker Integration Works
- Automatic Lifecycle: Claude Desktop starts a fresh container for each session
- Environment Variables: Environment variables are passed directly as
-eparameters in theargsarray- Each environment variable needs its own
-eparameter - Format:
"-e", "VARIABLE_NAME=value"
- Each environment variable needs its own
- Auto-Cleanup:
--rmflag removes container when session ends - No Manual Management: No need to manually start/stop containers
Equivalent Docker Command:
# For the basic configuration, Claude Desktop effectively runs:
docker run --rm -i \
-e FRONIUS_HOST=fronius-inverter.local \
dirkhuber/fronius-mcp-server:latest
# For the advanced configuration, it would run:
docker run --rm -i \
-e FRONIUS_HOST=192.168.1.100 \
-e FRONIUS_PROTOCOL=https \
-e FRONIUS_PORT=443 \
-e FRONIUS_TIMEOUT=15000 \
dirkhuber/fronius-mcp-server:latestFinal Steps (for both options):
- Edit your Claude Desktop configuration file with one of the configurations above
- Completely quit Claude Desktop and restart it
- Begin a new conversation
- Test with: "How much power is my solar system producing?"
Alternative: Long-Running Container
If you prefer a long-running container approach:
Docker Compose Setup:
# Use docker-compose for easier management
cp .env.docker .env
# IMPORTANT: Edit .env and set FRONIUS_HOST to your device IP/hostname
# Example: FRONIUS_HOST=fronius-inverter.local or FRONIUS_HOST=192.168.1.100
docker-compose up -d
# Test the setup
./scripts/test-container.shClaude Desktop config for long-running container:
{
"mcpServers": {
"fronius-solar": {
"command": "docker",
"args": ["exec", "-i", "fronius-mcp-server", "node", "dist/server.js"],
"env": {}
}
}
}Note: For long-running containers, the FRONIUS_HOST is configured when starting the container (via docker-compose.yml or docker run), not in the Claude Desktop config. The docker exec command uses the environment from the running container.
Option 4: Local Development
For development or if you want to build from source:
Claude Desktop Setup
1. MCP Server Configuration
Edit the Claude Desktop configuration file:
- macOS:
~/Library/Application Support/Claude/claude_desktop_config.json - Windows:
%APPDATA%\\Claude\\claude_desktop_config.json
{
"mcpServers": {
"fronius-solar": {
"command": "node",
"args": ["/absolute/path/to/fronius-mcp-server/dist/server.js"],
"env": {
"FRONIUS_HOST": "fronius-inverter.local"
}
}
}
}Important: Replace /absolute/path/to/fronius-mcp-server with your actual installation path!
Finding the correct paths:
# Find your installation path
pwd
# Find your node path (if Claude Desktop can't find node)
which node
# Example with full node path:
{
"mcpServers": {
"fronius-solar": {
"command": "/usr/local/bin/node",
"args": ["/Users/yourname/fronius-mcp-server/dist/server.js"],
"env": {
"FRONIUS_HOST": "fronius-inverter.local"
}
}
}
}2. 🔐 Network Permissions (macOS)
Claude Desktop requires access to the local network to communicate with the Fronius inverter.
How to enable permissions:
- System Settings → Privacy & Security → Network
- Find Claude in the app list
- ✅ Enable Network access for Claude Desktop
- Completely restart Claude Desktop
With macOS Firewall enabled, additionally:
- System Settings → Network → Firewall → Options
- Add Claude Desktop to exceptions list or create rule
3. Start and Test
After configuration:
- ⚠️ Completely quit Claude Desktop and restart
- Start new conversation
- Test with: "How much power is my solar system currently producing?"
Development & Testing
Development Mode
npm run devProduction
npm run build
npm startTesting & Debugging
# Full connection test
npm run test-connection
# Linting & Type Checking
npm run lint
npm run typecheckMCP Resources
The server provides these resources:
fronius://api/version- API Versionfronius://system/status- System Statusfronius://system/led- LED Statusfronius://inverter/info- Inverter Informationfronius://inverter/realtime- Inverter Real-time Datafronius://meter/realtime- Smart Meter Datafronius://powerflow/realtime- Power Flow Datafronius://sensors/realtime- Sensor Datafronius://strings/realtime- String Datafronius://storage/realtime- Battery Storage Datafronius://ohmpilot/realtime- OhmPilot Datafronius://devices/active- Active Devices
MCP Tools
Available tools for interactive queries:
get_api_version- Get API versionget_system_status- Get system statusget_logger_led_info- Get LED statusget_inverter_info- Get inverter informationget_inverter_realtime- Get inverter real-time dataget_meter_realtime- Get smart meter dataget_powerflow_realtime- Get power flow dataget_archive_data- Get historical dataget_sensor_realtime- Get sensor dataget_string_realtime- Get string dataget_storage_realtime- Get battery storage dataget_ohmpilot_realtime- Get OhmPilot dataget_active_devices- Get active devicestest_connection- Test connection
Tool Parameter Examples
Query specific inverter:
{
"name": "get_inverter_realtime",
"arguments": {
"deviceId": 1,
"dataCollection": "CommonInverterData"
}
}Get archive data:
{
"name": "get_archive_data",
"arguments": {
"startDate": "2024-01-01",
"endDate": "2024-01-31",
"channel": "EnergyReal_WAC_Sum_Produced"
}
}Get battery storage data:
{
"name": "get_storage_realtime",
"arguments": {
"deviceId": 0
}
}Get OhmPilot heating data:
{
"name": "get_ohmpilot_realtime",
"arguments": {
"deviceId": 0
}
}Troubleshooting
Connection Issues
Check hostname/IP:
ping fronius-inverter.local # or ping 192.168.1.100Test API access:
curl \"http://fronius-inverter.local/solar_api/GetAPIVersion.cgi\"Fronius Solar API enabled?
- In Fronius web interface: System → Hardware → Datamanager
- Solar API must be enabled
Claude Desktop Network Permissions (macOS):
- System Settings → Privacy & Security → Network
- Allow Claude Desktop network access
Firewall/Router:
- Port 80/443 must be accessible
- No firewall blocking between Claude Desktop and Fronius
Debugging
Enable debug logging:
LOG_LEVEL=debug npm run devTest API endpoints systematically:
FRONIUS_HOST=fronius-inverter.local npm run debug-froniusConnection test:
FRONIUS_HOST=fronius-inverter.local npm run test-connectionCompatibility
Unsupported Features
- Some older Fronius devices don't support all API endpoints
- Archive data is not available on all models
Architecture
src/
├── types/ # TypeScript definitions
│ ├── fronius.ts # Fronius API response types
│ └── config.ts # Configuration types
├── services/ # Business logic
│ ├── fronius-api.ts # Fronius API client with retry logic
│ └── config.ts # Configuration service
├── handlers/ # MCP request handlers
│ ├── resources.ts # Resource-based data access
│ └── tools.ts # Tool-based interactions
└── server.ts # Main server with lifecycle managementRelease Process
This project uses centralized version management - the version in package.json is the single source of truth for all components (MCP server config, User-Agent headers, etc.).
Creating a Release
1. Update Version
# Bump version in package.json (patch/minor/major)
npm version patch # 1.0.0 -> 1.0.1
npm version minor # 1.0.1 -> 1.1.0
npm version major # 1.1.0 -> 2.0.02. Build and Test
# Verify everything builds and tests pass
npm run build
npm run typecheck
npm run lint
npm run test-connection # If Fronius device available3. Create Git Tag and Release
# The npm version command automatically creates a git tag
# Push the tag to trigger GitHub Actions release workflow
git push origin main --tags4. GitHub Actions will automatically:
- ✅ Run full test suite on multiple Node.js versions
- ✅ Build and test Docker image
- ✅ Create GitHub release with changelog
- ✅ Build and push multi-platform Docker images to Docker Hub
- ✅ Create release archives (.tar.gz and .zip)
5. Docker Hub Update Once the GitHub release is published, users can update to the latest version:
docker pull dirkhuber/fronius-mcp-server:latest
# or specific version
docker pull dirkhuber/fronius-mcp-server:v1.0.1Version Management
The version is centrally managed in package.json and automatically used by:
- MCP Server Config (
src/services/config.ts) - Server name and version - HTTP User-Agent (
src/services/fronius-api.ts) - API client identification - Docker Tags (
.github/workflows/ci.yml) - Container versioning - Release Assets (GitHub Actions) - Archive naming
Versioning Strategy
- Patch (1.0.0 → 1.0.1): Bug fixes, small improvements
- Minor (1.0.0 → 1.1.0): New features, API additions, non-breaking changes
- Major (1.0.0 → 2.0.0): Breaking changes, API changes, major refactoring
Contributing
- Fork the repository
- Create a feature branch
- Commit your changes
- Push to the branch
- Create a Pull Request
License
MIT License - see LICENSE file for details.
Support
- GitHub Issues: For bugs and feature requests
- Fronius API Documentation: Official Fronius Solar API
- MCP Protocol: Model Context Protocol Spec
