Avanan MSP (Legacy SmartAPI)

io.github.wyre-technology由 GitHub 帳號 wyre-technology 發布v1.1.0更新於 Oct 26, 2026

MCP server for the Avanan MSP SmartAPI — manage child MSPs, users, tenants, licenses, and usage.

已驗證STDIO僅桌面安全與監控商業與電商

概覽

AI 產生的概覽

面向舊版 Avanan MSP SmartAPI 的 MCP 伺服器,讓助理管理 MSP 合作夥伴、租用戶、使用者與授權,並處理各租用戶的安全事件與處置作業。

可以做什麼
  • 測試連線並列出金鑰權限範圍,判斷所用 API 金鑰類型
  • 查詢與讀取安全事件,搜尋或取得受保護郵件
  • 列出、讀取、新增、更新與刪除例外規則
  • 隔離或還原事件與郵件,並查詢處置任務狀態
  • 列出、建立與刪除子 MSP、MSP 使用者與客戶租用戶
  • 列出授權與附加元件、指派授權,並讀取每月或每日用量
適用情境
適合使用 Avanan/Check Point 郵件安全的託管服務商或安全團隊,希望助理統一完成事件研判、例外與處置作業,以及租用戶、使用者與授權管理。
執行需求
以容器映像在本機透過 stdio 執行,或設定 MCP_TRANSPORT=http 走 HTTP。需要 Avanan SmartAPI 的用戶端 ID 與密鑰(AVANAN_CLIENT_ID、AVANAN_CLIENT_SECRET)及區域;MSP 管理類工具需要 MSP 核發的金鑰。HTTP 模式需要 CONDUIT_S2S_SECRET,閘道模式還需每次請求攜帶用戶端標頭。需能連線到對應區域的 Avanan 端點。
安裝前請注意
憑證屬於機密:AVANAN_CLIENT_SECRET 用於簽署請求,CONDUIT_S2S_SECRET 用於保護 HTTP 存取,兩者都不應提交到版本庫,也不要使用預留值。許多工具會寫入或刪除資料,包括刪除租用戶、MSP 與使用者,修改例外規則,以及隔離或還原郵件與事件。無密鑰的 HTTP 模式僅供開發,應只綁定本機回環位址。

安裝

在 SourceWeft 中

  1. 開啟 儀表板中的 Avanan MSP (Legacy SmartAPI),將其新增到工作區。
  2. 為需要使用其工具的對話啟用該服務。

Desktop only,透過 STDIO。 STDIO 服務會啟動本機處理程序,因此需要 SourceWeft 桌面主機。

其他 MCP 客戶端

參照 儲存庫 中的啟動說明。

README

avanan-legacy-mcp

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):

GroupTools
Diagnosticsavanan_test_connection (auth handshake, key scopes, MSP-access probe; run this first), avanan_list_scopes
Security eventsavanan_query_events, avanan_get_event
Secured entitiesavanan_search_emails, avanan_get_email
Exceptionsavanan_list_exceptions, avanan_get_exception, avanan_add_exception, avanan_update_exception, avanan_delete_exception
Remediationavanan_quarantine_events, avanan_restore_events, avanan_quarantine_emails, avanan_restore_emails, avanan_get_task_status
Child MSPsavanan_list_msp_partners, avanan_create_msp_partner, avanan_delete_msp_partner
MSP usersavanan_list_msp_users, avanan_get_msp_user, avanan_create_msp_user, avanan_update_msp_user, avanan_delete_msp_user
Customer tenantsavanan_list_tenants, avanan_get_tenant, avanan_create_tenant, avanan_delete_tenant
Licensesavanan_list_licenses, avanan_list_addons, avanan_assign_license
Usageavanan_get_monthly_usage, avanan_get_daily_usage

Features

  • Interactive tenant card (MCP Apps, SEP-1865): 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.

Configuration

Env varRequiredDescription
AVANAN_CLIENT_IDFor stdio and AUTH_MODE=envSmartAPI Client ID (sent as x-av-app-id). MSP or customer-tenant key; see below.
AVANAN_CLIENT_SECRETFor stdio and AUTH_MODE=envSmartAPI Client Secret. Only ever used to sign requests; never sent on the wire.
AVANAN_REGIONnous (default) | eu | ca | ap | euw2 | aps1. Avanan issues one key per region. Not a credential.
MCP_TRANSPORTnostdio (default) or http.
AUTH_MODEnoenv (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_HOSTnoBind 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_PORTnoHTTP transport port (default 8080).
LOG_LEVELnodebug | info | warn | error (default info).
CONDUIT_S2S_SECRETYes for HTTPService-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_DEVnoSet 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.

HTTP authentication

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.

Docker

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.

bash
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:

bash
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.

bash
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:

bash
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.

Authentication details

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.

Build

bash
npm installnpm run buildnpm start

Regional endpoints

RegionBase
ushttps://smart-api-production-1-us.avanan.net
euhttps://smart-api-production-1-eu.avanan.net
cahttps://smart-api-production-1-ca.avanan.net
aphttps://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/....

來源:README.md,提交 48d55e9

工具

0
SourceWeft 尚未在沙箱中啟動過該軟體包,因此其工具未知。

版本歷史

1
  1. v1.1.0最新Sep 16, 2026

評分

已滿足適用檢查項的 50%

該評分衡量此收錄條目的完整程度,依據註冊中心條目、端點與公開來源計算得出。它不是對伺服器本身的評價,也不表示伺服器安全或目前可用:可連通性是帶日期的檢查結果,評分也不包含安裝量或使用者評價。

  • 近 30 天內可連通25 分

    請保持端點能夠回應 MCP 握手;SourceWeft 每 30 天探測一次。

  • 已宣告認證方式10 分

    請在註冊中心條目中宣告憑證請求標頭,或保持端點能夠回應探測,以便判定其認證方式。

  • 已列出工具15 分

    請讓伺服器在無憑證時回應 tools/list,或發布可在沙箱中無憑證啟動的軟體包。

  • 描述必需15 分
  • 圖示10 分
  • 文件15 分
  • 授權條款10 分