Server Configuration
Describes the environment variables required to run the server.
| Name | Required | Description | Default |
|---|---|---|---|
| ALPHA_ESS_APP_ID | Yes | Your Alpha ESS API App ID obtained from https://open.alphaess.com/ | |
| ALPHA_ESS_APP_SECRET | Yes | Your Alpha ESS API App Secret obtained from https://open.alphaess.com/ |
Tools
Functions exposed to the LLM to take actions
| Name | Description |
|---|---|
| authenticate_alphaess | Authenticate with the Alpha ESS Open API to validate credentials.
Returns:
dict: Authentication result with success status and message |
| get_alpha_ess_data | Get statistical energy data for all registered Alpha ESS systems.
Returns:
dict: Energy data with success status and system information |
| get_ess_list | Get list of registered Alpha ESS systems with auto-selection logic.
Returns enhanced system information with structured metadata.
Returns:
dict: Enhanced response with system list and auto-selection recommendations |
| get_last_power_data | Get the latest real-time power data for a specific Alpha ESS system.
Returns structured snapshot with clear field names and units.
If no serial provided, auto-selects if only one system exists.
Args:
serial: The serial number of the Alpha ESS system (optional)
Returns:
dict: Enhanced response with structured real-time power data |
| get_one_day_power_data | Get one day's power data for a specific Alpha ESS system.
Returns structured timeseries data with hourly intervals and summary statistics.
If no serial provided, auto-selects if only one system exists.
Args:
query_date: Date in YYYY-MM-DD format
serial: The serial number of the Alpha ESS system (optional)
Returns:
dict: Enhanced response with structured timeseries data and analytics |
| get_one_date_energy_data | Get energy data for a specific date and Alpha ESS system.
If no serial provided, auto-selects if only one system exists.
Args:
query_date: Date in YYYY-MM-DD format
serial: The serial number of the Alpha ESS system (optional)
Returns:
dict: Energy data for the specified date with success status |
| get_charge_config | Get battery charging configuration for a specific Alpha ESS system.
Returns structured configuration with clear period definitions and status.
If no serial provided, auto-selects if only one system exists.
Args:
serial: The serial number of the Alpha ESS system (optional)
Returns:
dict: Enhanced response with structured charging configuration |
| get_discharge_config | Get battery discharge configuration for a specific Alpha ESS system.
Returns structured configuration with clear period definitions and status.
If no serial provided, auto-selects if only one system exists.
Args:
serial: The serial number of the Alpha ESS system (optional)
Returns:
dict: Enhanced response with structured discharge configuration |
| set_battery_charge | Set battery charging configuration for a specific Alpha ESS system.
If no serial provided, auto-selects if only one system exists.
Args:
enabled: True to enable charging from grid, False to disable
dp1_start: Start time for charging period 1 (HH:MM format, minutes must be :00, :15, :30, :45)
dp1_end: End time for charging period 1 (HH:MM format, minutes must be :00, :15, :30, :45)
dp2_start: Start time for charging period 2 (HH:MM format, minutes must be :00, :15, :30, :45)
dp2_end: End time for charging period 2 (HH:MM format, minutes must be :00, :15, :30, :45)
charge_cutoff_soc: Percentage to stop charging from grid at (0-100)
serial: The serial number of the Alpha ESS system (optional)
Returns:
dict: Result of charge configuration update with success status |
| set_battery_discharge | Set battery discharge configuration for a specific Alpha ESS system.
If no serial provided, auto-selects if only one system exists.
Args:
enabled: True to enable battery discharge, False to disable
dp1_start: Start time for discharge period 1 (HH:MM format, minutes must be :00, :15, :30, :45)
dp1_end: End time for discharge period 1 (HH:MM format, minutes must be :00, :15, :30, :45)
dp2_start: Start time for discharge period 2 (HH:MM format, minutes must be :00, :15, :30, :45)
dp2_end: End time for discharge period 2 (HH:MM format, minutes must be :00, :15, :30, :45)
discharge_cutoff_soc: Percentage to stop discharging battery at (0-100)
serial: The serial number of the Alpha ESS system (optional)
Returns:
dict: Result of discharge configuration update with success status |
Prompts
Interactive templates invoked by user choice
| Name | Description |
|---|---|
No prompts | |
Resources
Contextual data attached and managed by the client
| Name | Description |
|---|---|
No resources | |