Overview
ON THIS PAGE
OpenSolar MCP (Model Context Protocol) lets AI agents and MCP hosts call OpenSolar tools securely on behalf of your organisation. Agents can list projects, update contacts, run auto-design, configure webhooks, and more, without writing custom API clients.
info
MCP is complementary to the OpenSolar REST API. Use the API for application integrations; use MCP when you want an AI assistant to operate on your OpenSolar data through a governed tool allowlist.
What you get
- API-parity tools — MCP tools map to the same OpenSolar capabilities as the REST API. Agents use published tools rather than calling arbitrary URLs or the database.
- Usage visibility — Organisation admins can review MCP sessions and usage in Control → Integrations → MCP.
Environments
| Environment | MCP URL | Login | API |
|---|---|---|---|
| Production | https://mcp.opensolar.com/mcp | https://app.opensolar.com/login | https://api.opensolar.com |
Quick start
- Enable MCP for your organisation (MCP Access + role permission).
- Enable Raw Data API Access if you need tools that call OpenSolar API (almost all tools except
whoami). - Connect with Clients (Gemini CLI, Claude Code, Codex, Cursor, or another MCP host) to
https://mcp.opensolar.com/mcp. - Complete OAuth login, pick your organisation and scopes, then start calling tools.
Access layers
Each layer must allow the request. If any layer denies it, the tool cannot run.
| Layer | What it controls |
|---|---|
| MCP Access | Organisation is entitled to use MCP |
Role permission MCP Access (view) | Which users may connect and use MCP |
| OAuth scopes (READ / WRITE / DELETE) | What the token may do |
| Raw Data API Access | Required for tools that call OpenSolar API (all except whoami) |
See How to Enable and Authentication for details.