# SolarAssistant

> SolarAssistant monitors and controls solar inverters and batteries. A device on the
> installation's own network reads the hardware and reports to this cloud, which provides
> remote monitoring, fleet administration, an HTTP API and an OAuth-authenticated MCP server.
> Access is always limited to the sites and organizations the signed-in user is authorized
> to use.

## AI integration

- [MCP server](https://solar-assistant.io/mcp): JSON-RPC over HTTP POST, authenticated with a
  bearer token. Sign in with an existing SolarAssistant account through browser-based OAuth.
- [MCP protected resource metadata](https://solar-assistant.io/.well-known/oauth-protected-resource/mcp):
  where OAuth discovery for the MCP server starts
- [Cloud API documentation](https://solar-assistant.io/help/integration/cloud-api): the HTTP
  API, for building an application rather than for chat
- [OpenAPI specification](https://solar-assistant.io/openapi.json): machine-readable
  description of the Cloud API, also served as YAML at
  https://solar-assistant.io/openapi.yaml

## Licensing

- A licence is a one-time purchase for one SolarAssistant device and never expires. Software
  updates are free for every licensed device, forever; no renewal or subscription is needed
  to receive them. A new licence includes 12 months of Pro, an optional add-on that unlocks
  features marked "Pro" in the changelog; Pro features gained stay unlocked after Pro lapses.
- [Software updates and Pro](https://solar-assistant.io/help/updates/overview): current
  licensing model; supersedes /help/updates/terms-update-oct-2024, whose paid update terms
  no longer apply
- [Shop](https://solar-assistant.io/shop): licences and Pro
- [EULA](https://solar-assistant.io/register/eula)

## Supported hardware

- [Inverters](https://solar-assistant.io/help/inverters): supported inverter brands, each with
  its supported models and connection guides
- [Device requirements](https://solar-assistant.io/help/getting-started/supported-hardware):
  which Raspberry Pi and Orange Pi boards run SolarAssistant; virtual machines are not supported

## Optional

- [CLI](https://github.com/Solar-Assistant/sacli): command line client
- [JavaScript client](https://github.com/Solar-Assistant/js_solar_assistant): browser and Node
- [OAuth documentation](https://solar-assistant.io/help/integration/oauth): signing users in
  with their SolarAssistant account

## Guidance

- Use MCP for interactive access on a person's behalf; use the Cloud API and its OpenAPI
  specification when building an application.
- Never ask for a password or an API token in chat. Both integrations sign in through OAuth.
- Reading a site is safe. Changing inverter or battery settings reaches physical hardware at
  someone's home, so confirm the change with the person before applying it.
- Every MCP tool carries annotations saying whether it reads or writes. Treat anything not
  marked read-only as a change to the installation.