# OpenSolar MCP [Health: Active]

**Category:** 💻 Developer Tools  
**Repository:** https://github.com/Align-Software-Company/opensolar-mcp  
**GitHub Stars:** 0  
**Views:** 0  
**Installs:** 0  
**Upvotes:** 0  
**Directory Page:** https://allmcps.com/mcp/opensolar-mcp

## Description
Unofficial, self-hosted MCP server for the documented OpenSolar API.

## Claude Desktop Quick Installation
Install path detected from listing signals. Uses `npx` (confidence: high):

```json
"mcpServers": {
  "opensolar-mcp": {
    "command": "npx",
    "args": ["-y","@alignco/opensolar-mcp"],
    "env": {
      "OPENSOLAR_API_TOKEN": "",
      "OPENSOLAR_ORG_ID": ""
    }
  }
}
```

**Requires environment variables:** `OPENSOLAR_API_TOKEN`, `OPENSOLAR_ORG_ID` — the values above are empty placeholders; fill in real credentials before running (see the repository for what each one is for).

## Documentation

## What OpenSolar MCP MCP server does

OpenSolar MCP provides an unofficial, self-hosted bridge between MCP clients and the documented OpenSolar API. It runs on your machine or infrastructure and authenticates with your OpenSolar organisation ID and bearer token. The server does not provide a shared OpenSolar environment and is not affiliated with OpenSolar Pty Ltd.

The default profile contains 31 tools, while 75 registered tools can be enabled through configuration. Supported areas include projects, contacts, systems, files, commercial settings, proposal information, and Teams sharing. The tools are designed around common operations rather than exposing only raw API endpoints. Examples include project and contact search, project snapshots, system comparison, stage changes by name, proposal summaries, document generation, and read-only share checks.

## How it works

An MCP client communicates with the local process through stdio or with a deployed instance through stateless Streamable HTTP. The server then makes HTTPS requests to `api.opensolar.com` with the configured bearer token. It uses the official MCP TypeScript SDK v2 and targets the 2026-07-28 MCP specification, with fallback support for clients using earlier protocol versions.

Search operations report whether a result is unique, ambiguous, or incomplete, allowing an agent to avoid guessing between records. Mutation requests are not automatically retried. Read-only mode disables all mutations. Tool responses use published schemas, and credentials, signed URLs, design blobs, and other raw or sensitive fields are filtered before reaching the model.

## Setup and configuration

OpenSolar MCP MCP server requires Node.js 24 or newer, an OpenSolar organisation with API Access enabled, an organisation ID, and a bearer token. Set these environment variables:

- `OPENSOLAR_API_TOKEN`: OpenSolar bearer token.
- `OPENSOLAR_ORG_ID`: OpenSolar organisation ID.

Run `npx -y @alignco/opensolar-mcp --list-tools` to inspect the available tools without credentials. Use `--check` to validate the configuration and perform one organisation read, or add `--no-probe` to validate settings without contacting OpenSolar.

Standard user tokens expire after seven days. OpenSolar machine users can provide a token that does not expire, but configuring that account is outside this server's scope. Raw Data API Access is additionally required for `get_proposal_data` and `get_project_design`.

## Tools and capabilities

The documented examples support workflows such as:

- Finding projects and reading their workflow stage, systems, and files.
- Comparing project systems by size, annual output, price, price per watt, and hardware without ranking them.
- Resolving a workflow stage by name while rejecting ambiguous or archived matches.
- Reading payback year, NPV, IRR, and ROI from proposal data when the required API access is enabled.
- Searching for an existing contact before creating a new one.
- Asking OpenSolar to generate a proposal PDF as a private file and returning its file ID.
- Checking project sharing connections and entities without changing them.

## Limitations and notes

OpenSolar MCP MCP server is unofficial and depends on the documented OpenSolar API. Its writes are exposed only where the request body is established from documentation or live verification. The server does not change an OpenSolar account into a machine user, and some capabilities require additional OpenSolar API access. Protect the bearer token because it is the credential used for API requests from the server to OpenSolar.

_Full upstream README: https://allmcps.com/mcp/opensolar-mcp/readme_