Tools

ON THIS PAGE

OpenSolar MCP exposes tools, plus documentation resources and guided prompts.

note

This is a non-exhaustive list. For the most up-to-date list of tools, please ask the agent.

note

Most tools require Raw Data API Access. The only exception is whoami, which returns token claims locally.

Conventions

• Scopes — Each tool requires READ, WRITE, or DELETE.
• Org scope — Calls run against the organisation on the MCP token.
• List pages — List tools are bounded (max 50 items per page).
• Deletes — Require DELETE and confirm=true.

Tool catalogue

Account & organisation

Tool	Scope	Description
whoami	READ	Token identity claims (no API call; burst-only)
organizations_list	READ	Organisations accessible to the current grant
organization_get	READ	Get organisation details
organization_update	WRITE	Update organisation details

Projects

Tool	Scope	Description
projects_list / projects_get	READ	List or get projects
projects_create / projects_update	WRITE	Create or update projects
projects_delete	DELETE	Delete a project (confirm=true)
projects_generate_document	WRITE	Generate project documents
geocode_address	READ	Geocode an address (consumes daily MCP tokens)
events_create	WRITE	Create notes, tasks, or appointments
projects_submit_site_visit	WRITE	Submit site-visit fields on a project

Auto-design

Tool	Scope	Description
auto_proposal_start	WRITE	Start persisted auto-design / auto proposal
projects_auto_design_status	READ	Poll auto-design status
system_templates_*	READ / WRITE / DELETE	Auto Design Template CRUD

Contacts & files

Tool	Scope	Description
contacts_*	READ / WRITE / DELETE	Contact CRUD
files_* (files_get_metadata)	READ / WRITE / DELETE	Private file metadata CRUD

Systems & proposal

Tool	Scope	Description
systems_list / systems_get	READ	List or get systems
systems_details_get	READ	System details (may include Raw Data fields)
systems_image_get	READ	System image URL
proposal_data_get	READ	Proposal data

Config, pricing & components

Tool	Scope	Description
workflows_*	READ / WRITE / DELETE	Workflow CRUD
roles_list / roles_get	READ	Roles
pricing_schemes_*	READ / WRITE / DELETE	Pricing scheme CRUD
payment_options_*	READ / WRITE / DELETE	Payment option CRUD
costings_*	READ / WRITE / DELETE	Costing CRUD
module_activations_* / inverter_activations_* / battery_activations_* / other_activations_*	READ / WRITE / DELETE	Hardware activation CRUD
components_search	READ	Component catalogue search

Teams & webhooks

Tool	Scope	Description
connected_orgs_*	READ / WRITE / DELETE	Connected org CRUD and team actions
permissions_role_create	WRITE	Custom permission set for teams
bulk_share_entities	WRITE	Bulk-share entities to a connected org
webhooks_*	READ / WRITE	Webhook CRUD
webhook_queue_list / webhook_logs_list	READ	Webhook queue and logs

REST ↔ MCP coverage for many of these tools mirrors the Developer API.

Resources

MCP resources provide live reference docs the agent can read:

URI	Purpose
opensolar://status	Server status
opensolar://scopes	Scope reference
opensolar://docs/tools	Live tool catalogue
opensolar://docs/orgs	Organisation guidance
opensolar://docs/errors	Error codes and recovery
opensolar://docs/raw-data	Raw Data gate / MCP_0011
opensolar://docs/throttles	Throttle guidance
opensolar://docs/design-workflow	Design workflow notes
opensolar://docs/system-templates	System template notes
opensolar://reference/event-types	Event type IDs
opensolar://reference/roof-types	Roof type IDs
opensolar://reference/file-tags	File tag IDs

Prompts

Built-in prompts help agents follow recommended workflows:

• getting-started
• explore-projects
• working-with-orgs
• manage-contacts
• upload-project-files
• configure-webhooks
• teams-and-sharing
• proposal-and-design-data
• run-auto-design
• create-project-and-design