OpenSolar MCP
mcpkey · packageio.github.Align-Software-Company/opensolar-mcp · v0.1.3
Unofficial, self-hosted MCP server for the documented OpenSolar API.
run it
on your own machines, one way per deploy methodgenerated from the record, not tested yet
#!/usr/bin/env bash # opensolar (io.github.Align-Software-Company/opensolar-mcp), recipe baremetal (generated). # Generated by Hub for toolset "my-agent"; started by mcp-my-agent-opensolar.service. set -euo pipefail export HOST=127.0.0.1 PORT=8101 exec npx -y supergateway@4 --stdio 'npx -y @alignco/[email protected]' --outputTransport streamableHttp --stateful --host 127.0.0.1 --port 8101 --streamableHttpPath /mcp --healthEndpoint /healthz [Unit] Description=MCP server opensolar (toolset my-agent), generated by Hub After=network-online.target Wants=network-online.target [Service] Type=simple User=mcp Group=mcp EnvironmentFile=/etc/mcp/my-agent.env Environment=HOME=/var/lib/mcp/opensolar WorkingDirectory=/var/lib/mcp/opensolar ExecStart=/opt/mcp/my-agent/bin/opensolar.sh Restart=on-failure RestartSec=5 NoNewPrivileges=true ProtectSystem=strict ProtectHome=true PrivateTmp=true ReadWritePaths=/var/lib/mcp/opensolar [Install] WantedBy=multi-user.target
generated from the record, not tested yet
docker run --rm -p 127.0.0.1:8101:8000 -e OPENSOLAR_API_TOKEN -e OPENSOLAR_ORG_ID -e OPENSOLAR_PROFILE -e OPENSOLAR_READ_ONLY -e OPENSOLAR_PLAN -e OPENSOLAR_TOOLSETS -e OPENSOLAR_UPLOAD_ROOT node:22-alpine sh -c 'npx -y supergateway@4 --stdio '"'"'npx -y @alignco/[email protected]'"'"' --outputTransport streamableHttp --stateful --host 0.0.0.0 --port 8000 --streamableHttpPath /mcp --healthEndpoint /healthz'
generated from the record, not tested yet
# Generated by Hub for toolset "my-agent" (2026-10-18T11:52:01+00:00).
# Each package server runs behind a stdio->HTTP bridge and listens on localhost only.
# cp .env.example .env # fill the ${VAR}s
# docker compose up -d && bash smoke.sh
# Remote servers are not here: clients reach them directly (see clients/).
name: mcp-my-agent
services:
opensolar:
image: node:22-alpine
command:
- sh
- -c
- npx -y supergateway@4 --stdio 'npx -y @alignco/[email protected]' --outputTransport streamableHttp
--stateful --host 0.0.0.0 --port 8000 --streamableHttpPath /mcp --healthEndpoint /healthz
ports:
- 127.0.0.1:8101:8000
volumes:
- npm-cache:/root/.npm
healthcheck:
test:
- CMD-SHELL
- wget -qO- http://127.0.0.1:8000/healthz || exit 1
interval: 30s
timeout: 5s
retries: 5
start_period: 2m
restart: unless-stopped
environment:
OPENSOLAR_API_TOKEN: ${OPENSOLAR_API_TOKEN}
OPENSOLAR_ORG_ID: ${OPENSOLAR_ORG_ID}
OPENSOLAR_PROFILE: ${OPENSOLAR_PROFILE}
OPENSOLAR_READ_ONLY: ${OPENSOLAR_READ_ONLY}
OPENSOLAR_PLAN: ${OPENSOLAR_PLAN}
OPENSOLAR_TOOLSETS: ${OPENSOLAR_TOOLSETS}
OPENSOLAR_UPLOAD_ROOT: ${OPENSOLAR_UPLOAD_ROOT}
volumes:
npm-cache: {}
uv-cache: {}
generated from the record, not tested yet
# Generated by Hub for toolset "my-agent" (2026-10-18T11:52:01+00:00).
# kubectl create namespace mcp
# kubectl -n mcp create secret generic mcp-credentials --from-env-file=.env
# kubectl apply -f kubernetes.yaml
# Services are cluster-internal: <name>.mcp.svc.cluster.local:8000/mcp. Put an ingress
# with auth in front before exposing any of them.
apiVersion: v1
kind: Namespace
metadata:
name: mcp
---
apiVersion: apps/v1
kind: Deployment
metadata:
name: opensolar
namespace: mcp
labels: &id001
app: opensolar
spec:
replicas: 1
selector:
matchLabels: *id001
template:
metadata:
labels: *id001
spec:
containers:
- name: opensolar
image: node:22-alpine
ports:
- containerPort: 8000
name: http
env:
- name: OPENSOLAR_API_TOKEN
valueFrom:
secretKeyRef:
name: mcp-credentials
key: OPENSOLAR_API_TOKEN
- name: OPENSOLAR_ORG_ID
valueFrom:
secretKeyRef:
name: mcp-credentials
key: OPENSOLAR_ORG_ID
- name: OPENSOLAR_PROFILE
valueFrom:
secretKeyRef:
name: mcp-credentials
key: OPENSOLAR_PROFILE
- name: OPENSOLAR_READ_ONLY
valueFrom:
secretKeyRef:
name: mcp-credentials
key: OPENSOLAR_READ_ONLY
- name: OPENSOLAR_PLAN
valueFrom:
secretKeyRef:
name: mcp-credentials
key: OPENSOLAR_PLAN
- name: OPENSOLAR_TOOLSETS
valueFrom:
secretKeyRef:
name: mcp-credentials
key: OPENSOLAR_TOOLSETS
- name: OPENSOLAR_UPLOAD_ROOT
valueFrom:
secretKeyRef:
name: mcp-credentials
key: OPENSOLAR_UPLOAD_ROOT
command:
- sh
- -c
- npx -y supergateway@4 --stdio 'npx -y @alignco/[email protected]' --outputTransport streamableHttp
--stateful --host 0.0.0.0 --port 8000 --streamableHttpPath /mcp --healthEndpoint /healthz
readinessProbe:
httpGet:
path: /healthz
port: http
initialDelaySeconds: 10
---
apiVersion: v1
kind: Service
metadata:
name: opensolar
namespace: mcp
spec:
selector:
app: opensolar
ports:
- port: 8000
targetPort: http
name: http
generated from the record, not tested yet
# Generated by Hub for toolset "my-agent" (2026-10-18T11:52:01+00:00).
# Credentials come from the Secret 'mcp-credentials' (kubectl create secret generic ... --from-env-file=.env).
# Each server under `servers` is one Deployment + Service; the keys after it configure
# upstream charts a worker verified.
servers:
opensolar:
enabled: true
replicas: 1
port: 8000
path: /mcp
container:
name: opensolar
image: node:22-alpine
ports:
- containerPort: 8000
name: http
env:
- name: OPENSOLAR_API_TOKEN
valueFrom:
secretKeyRef:
name: mcp-credentials
key: OPENSOLAR_API_TOKEN
- name: OPENSOLAR_ORG_ID
valueFrom:
secretKeyRef:
name: mcp-credentials
key: OPENSOLAR_ORG_ID
- name: OPENSOLAR_PROFILE
valueFrom:
secretKeyRef:
name: mcp-credentials
key: OPENSOLAR_PROFILE
- name: OPENSOLAR_READ_ONLY
valueFrom:
secretKeyRef:
name: mcp-credentials
key: OPENSOLAR_READ_ONLY
- name: OPENSOLAR_PLAN
valueFrom:
secretKeyRef:
name: mcp-credentials
key: OPENSOLAR_PLAN
- name: OPENSOLAR_TOOLSETS
valueFrom:
secretKeyRef:
name: mcp-credentials
key: OPENSOLAR_TOOLSETS
- name: OPENSOLAR_UPLOAD_ROOT
valueFrom:
secretKeyRef:
name: mcp-credentials
key: OPENSOLAR_UPLOAD_ROOT
command:
- sh
- -c
- npx -y supergateway@4 --stdio 'npx -y @alignco/[email protected]' --outputTransport streamableHttp
--stateful --host 0.0.0.0 --port 8000 --streamableHttpPath /mcp --healthEndpoint /healthz
readinessProbe:
httpGet:
path: /healthz
port: http
initialDelaySeconds: 10
# helm install my-agent helm/my-agent -n mcp
in the cloud
one click: the provider's deploy form opens filled in, in your own account- koyeb
-
The form opens with CHANGE_ME for each value you supply: OPENSOLAR_API_TOKEN, OPENSOLAR_ORG_ID, OPENSOLAR_PROFILE, OPENSOLAR_READ_ONLY, OPENSOLAR_PLAN, OPENSOLAR_TOOLSETS, OPENSOLAR_UPLOAD_ROOT. Fill them in before you deploy.
Clients connect to the service's https://…koyeb.app address plus /mcp.
- azure
-
A Container Apps environment with one app per server, each with HTTPS ingress and one replica. The portal asks for each value you supply as a secure parameter; the deployment's outputs list the endpoints.
connect to it
copy what your client needsnpx -y @alignco/[email protected] # env: OPENSOLAR_API_TOKEN, OPENSOLAR_ORG_ID, OPENSOLAR_PROFILE, OPENSOLAR_READ_ONLY, OPENSOLAR_PLAN, OPENSOLAR_TOOLSETS, OPENSOLAR_UPLOAD_ROOT
{
"mcpServers": {
"opensolar": {
"command": "npx",
"args": [
"-y",
"@alignco/[email protected]"
],
"env": {
"OPENSOLAR_API_TOKEN": "${OPENSOLAR_API_TOKEN}",
"OPENSOLAR_ORG_ID": "${OPENSOLAR_ORG_ID}",
"OPENSOLAR_PROFILE": "${OPENSOLAR_PROFILE}",
"OPENSOLAR_READ_ONLY": "${OPENSOLAR_READ_ONLY}",
"OPENSOLAR_PLAN": "${OPENSOLAR_PLAN}",
"OPENSOLAR_TOOLSETS": "${OPENSOLAR_TOOLSETS}",
"OPENSOLAR_UPLOAD_ROOT": "${OPENSOLAR_UPLOAD_ROOT}"
}
}
}
}
#!/usr/bin/env bash
# Registers every server with Claude Code (run once; `claude mcp list` to check).
set -euo pipefail
set -a; [ -f .env ] && source .env; set +a
claude mcp add opensolar -e "OPENSOLAR_API_TOKEN=${OPENSOLAR_API_TOKEN}" -e "OPENSOLAR_ORG_ID=${OPENSOLAR_ORG_ID}" -e "OPENSOLAR_PROFILE=${OPENSOLAR_PROFILE}" -e "OPENSOLAR_READ_ONLY=${OPENSOLAR_READ_ONLY}" -e "OPENSOLAR_PLAN=${OPENSOLAR_PLAN}" -e "OPENSOLAR_TOOLSETS=${OPENSOLAR_TOOLSETS}" -e "OPENSOLAR_UPLOAD_ROOT=${OPENSOLAR_UPLOAD_ROOT}" -- npx -y @alignco/[email protected]
{
"mcpServers": {
"opensolar": {
"command": "npx",
"args": [
"-y",
"@alignco/[email protected]"
],
"env": {
"OPENSOLAR_API_TOKEN": "${OPENSOLAR_API_TOKEN}",
"OPENSOLAR_ORG_ID": "${OPENSOLAR_ORG_ID}",
"OPENSOLAR_PROFILE": "${OPENSOLAR_PROFILE}",
"OPENSOLAR_READ_ONLY": "${OPENSOLAR_READ_ONLY}",
"OPENSOLAR_PLAN": "${OPENSOLAR_PLAN}",
"OPENSOLAR_TOOLSETS": "${OPENSOLAR_TOOLSETS}",
"OPENSOLAR_UPLOAD_ROOT": "${OPENSOLAR_UPLOAD_ROOT}"
}
}
}
}
{
"servers": {
"opensolar": {
"type": "stdio",
"command": "npx",
"args": [
"-y",
"@alignco/[email protected]"
],
"env": {
"OPENSOLAR_API_TOKEN": "${OPENSOLAR_API_TOKEN}",
"OPENSOLAR_ORG_ID": "${OPENSOLAR_ORG_ID}",
"OPENSOLAR_PROFILE": "${OPENSOLAR_PROFILE}",
"OPENSOLAR_READ_ONLY": "${OPENSOLAR_READ_ONLY}",
"OPENSOLAR_PLAN": "${OPENSOLAR_PLAN}",
"OPENSOLAR_TOOLSETS": "${OPENSOLAR_TOOLSETS}",
"OPENSOLAR_UPLOAD_ROOT": "${OPENSOLAR_UPLOAD_ROOT}"
}
}
}
}
name: my-agent target: local servers: - hub: io.github.Align-Software-Company/opensolar-mcp
- not probed yet: tools unpinned, ingest lists them
tools
Not probed yetThe tools appear once the hub or its worker has listed this entry. Running it still works: your client lists them on first start.