MCP server for the Avanan MSP SmartAPI — manage child MSPs, users, tenants, licenses, and usage.
Runs on your machine from its package; the steps are below.
At most: creates or changes data: records, files, settings.
Odel charges nothing per call. The publisher may charge for its own service.
Runs locally over stdio
This server isn't hosted — your MCP client launches it from a package registry. Use one of the commands below, or drop the config into your client (e.g. Claude Desktop).
Run
docker run -i --rm ghcr.io/wyre-technology/avanan-legacy-mcp:v1.1.0
MCP client config
{
"mcpServers": {
"avanan-msp-legacy-smartapi": {
"command": "docker",
"args": [
"run",
"-i",
"--rm",
"ghcr.io/wyre-technology/avanan-legacy-mcp:v1.1.0"
]
}
}
}MCP server for the legacy Avanan SmartAPI on smart-api-production-*.avanan.net:
MSP tenant management plus per-tenant security (events, entities, exceptions, remediation).
Distinct from avanan-mcp, which targets the Check Point Infinity Portal HEC API.
Implements the Avanan MSP SmartAPI Reference Guide (22 July 2026) and the Avanan SmartAPI Reference Guide (Feb 2024):
| Group | Tools |
|---|---|
| Diagnostics | avanan_test_connection (auth handshake, key scopes, MSP-access probe; run this first), avanan_list_scopes |
| Security events | avanan_query_events, avanan_get_event |
| Secured entities | avanan_search_emails, avanan_get_email |
| Exceptions | avanan_list_exceptions, avanan_get_exception, avanan_add_exception, avanan_update_exception, avanan_delete_exception |
| Remediation | avanan_quarantine_events, avanan_restore_events, avanan_quarantine_emails, avanan_restore_emails, avanan_get_task_status |
| Child MSPs | avanan_list_msp_partners, avanan_create_msp_partner, avanan_delete_msp_partner |
| MSP users | avanan_list_msp_users, avanan_get_msp_user, avanan_create_msp_user, avanan_update_msp_user, avanan_delete_msp_user |
| Customer tenants | avanan_list_tenants, avanan_get_tenant, avanan_create_tenant, avanan_delete_tenant |
| Licenses | avanan_list_licenses, avanan_list_addons, avanan_assign_license |
| Usage | avanan_get_monthly_usage, avanan_get_daily_usage |
avanan_get_tenant renders as an
interactive card in MCP Apps hosts (Claude Desktop/web) showing domain, status,
deployment mode, license package, protected users, PoC dates, and add-ons. The card is
read-only, neutral by default, and brandable via window.__BRAND__ injection or
MCP_BRAND_* env vars (MCP_BRAND_NAME, MCP_BRAND_LOGO_URL, MCP_BRAND_PRIMARY_COLOR,
MCP_BRAND_ACCENT_COLOR, MCP_BRAND_BG, MCP_BRAND_TEXT). Plain-JSON behavior is
unchanged in other hosts. Rebuild the embedded card HTML after editing ui/ with
npm run build:ui.| Env var | Required | Description |
|---|---|---|
AVANAN_CLIENT_ID | For stdio and AUTH_MODE=env | SmartAPI Client ID (sent as x-av-app-id). MSP or customer-tenant key; see below. |
AVANAN_CLIENT_SECRET | For stdio and AUTH_MODE=env | SmartAPI Client Secret. Only ever used to sign requests; never sent on the wire. |
AVANAN_REGION | no | us (default) | eu | ca | ap | euw2 | aps1. Avanan issues one key per region. Not a credential. |
MCP_TRANSPORT | no | stdio (default) or http. |
AUTH_MODE | no | env (default) or gateway. The container image and Compose set gateway. Gateway mode requires X-Avanan-Client-Id and X-Avanan-Client-Secret on each request and never falls back to AVANAN_*. |
MCP_HTTP_HOST | no | Bind address when MCP_TRANSPORT=http. Defaults to 127.0.0.1. Honored only when CONDUIT_S2S_SECRET is set. The container image sets 0.0.0.0. |
MCP_HTTP_PORT | no | HTTP transport port (default 8080). |
LOG_LEVEL | no | debug | info | warn | error (default info). |
CONDUIT_S2S_SECRET | Yes for HTTP | Service-to-service secret. HTTP logs an error and exits non-zero when this is empty or a known placeholder (changeme, secret, your-s2s-secret, and the other example values). Compose will not start when it is unset. Never commit a real value. |
MCP_ALLOW_INSECURE_DEV | no | Set to exactly 1 only for local development to start HTTP without CONDUIT_S2S_SECRET. The process logs a warning, does not enforce X-Gateway-S2S, and listens on 127.0.0.1 only. A non-loopback MCP_HTTP_HOST (including 0.0.0.0) is ignored. A placeholder secret is still rejected. |
Copy .env.example. Leave CONDUIT_S2S_SECRET empty there.
/health stays unauthenticated and does not read credentials. The stdio transport does not use CONDUIT_S2S_SECRET or X-Gateway-S2S.
With MCP_TRANSPORT=http and a real CONDUIT_S2S_SECRET, every request except /health must include X-Gateway-S2S:
t=<unix seconds>,v1=<hex>
v1 is HMAC-SHA256 over the ASCII string t=<unix seconds> (the same t= prefix that starts the header), keyed with CONDUIT_S2S_SECRET, encoded as 64 lowercase hex characters. The timestamp must be within 300 seconds of the server clock. The comparison is timing-safe. A missing or invalid header returns 401 and does not touch Avanan credentials. The secret is never logged.
In AUTH_MODE=gateway, the request must also include X-Avanan-Client-Id and X-Avanan-Client-Secret (X-Avanan-Region is optional). Those headers are the only credential source. A request missing either one returns 401 and does not fall back to AVANAN_CLIENT_ID / AVANAN_CLIENT_SECRET.
In AUTH_MODE=env, /mcp still requires a valid X-Gateway-S2S header. Vendor credentials come from the environment when the request does not carry both client headers.
The image listens on 0.0.0.0 inside the container (MCP_HTTP_HOST) and sets AUTH_MODE=gateway. Publish the port on loopback and pass the S2S secret. In gateway mode, Avanan credentials arrive on each request as headers; they are not read from the environment.
docker build -t avanan-legacy-mcp .
docker run \
-e CONDUIT_S2S_SECRET="$CONDUIT_S2S_SECRET" \
-p 127.0.0.1:8080:8080 \
avanan-legacy-mcp
Compose refuses to start when CONDUIT_S2S_SECRET is unset, sets AUTH_MODE=gateway, publishes 127.0.0.1:8080:8080, and does not put AVANAN_CLIENT_ID or AVANAN_CLIENT_SECRET in the service environment:
CONDUIT_S2S_SECRET="$CONDUIT_S2S_SECRET" docker compose up
Single-tenant HTTP (AUTH_MODE=env) still requires the S2S secret, then uses AVANAN_CLIENT_ID and AVANAN_CLIENT_SECRET. That is separate from the gateway Compose service.
docker run \
-e CONDUIT_S2S_SECRET="$CONDUIT_S2S_SECRET" \
-e AUTH_MODE=env \
-e AVANAN_CLIENT_ID=your-client-id \
-e AVANAN_CLIENT_SECRET=your-client-secret \
-e AVANAN_REGION=us \
-p 127.0.0.1:8080:8080 \
avanan-legacy-mcp
Local HTTP without a secret is development-only. It binds 127.0.0.1 even if MCP_HTTP_HOST is 0.0.0.0, and logs a warning:
MCP_TRANSPORT=http MCP_ALLOW_INSECURE_DEV=1 npm start
Generate a secret with openssl rand -hex 32. Do not leave a placeholder in CONDUIT_S2S_SECRET; startup treats those values as unset and exits.
The server performs the token handshake itself: it calls GET /v1.0/auth, caches the
one-hour JWT per client ID, and refreshes it a minute before expiry.
Important
The MSP-management tools need an MSP API key. These are not self-service: Check
Point/Avanan Support issues them on request, through your distributor if you buy Avanan
through the channel, one per region. A key generated inside a customer tenant
authenticates successfully, but every /msp/* endpoint then answers
403 MSP endpoint, access denied. The security tools (events, entities, exceptions,
remediation) work with either kind of key. avanan_test_connection reports which kind
you have.
With an MSP key, the security tools cover every managed customer; pass scopes (query
and search) or scope (actions) with values from avanan_list_scopes to target one.
Parent MSPs can scope list and create calls to a child MSP with the optional MSPId
argument (msp_ids on the usage tools), as in Check Point's reference client.
The wire format was verified against the live US endpoint in September 2026 and is pinned
by tests/client.test.ts. Two details differ from the reference guide:
x-av-date must not end in Z (2026-09-09T16:49:12.123). The documented
.000Z form makes the API return HTTP 500.x-av-sig is sha256(base64(reqId + clientId + date + path?query + secret)) as hex.
The path is omitted on the /auth call only, and the /auth response body is the raw
JWT rather than JSON.Both match Check Point's reference
client.py.
npm install
npm run build
npm start
| Region | Base |
|---|---|
us | https://smart-api-production-1-us.avanan.net |
eu | https://smart-api-production-1-eu.avanan.net |
ca | https://smart-api-production-1-ca.avanan.net |
ap | https://smart-api-production-5-ap.avanan.net |
euw2 (UK) | https://smart-api-production-1-euw2.avanan.net |
aps1 (India) | https://smart-api-production-1-aps1.avanan.net |
All endpoints sit under /v1.0/msp/....