Gradient MSP MCP

Creates an account. Returns array of UpdateMappingPropertyResponse.

Get Organization Accounts. Optional: accountIds, returnUnmapped. Returns array of GetMappingPropertyResponse.

Updates 1 or more fields per Account. Returns the updated UpdateMappingPropertyResponse.

Updates 1 or more fields of a single Account. Required: accountId. Optional: description, id, isActive (plus 2 more). Returns the updated UpdateMappingPropertyResponse.

alert subcommands: send, trace

Use this command to dispatch an alert and wait for its PSA ticket. Do NOT use this command to re-check an alert you already dispatched; use 'alert trace'. Do NOT use it to inspect a raw debug response for a known messageId; use 'ticket-events'. Dispatch is asynchronous upstream: the API queues the alert and returns a messageId; the PSA ticket is created later. With --wait this command polls the ticket-event debug route until the ticket exists or --timeout-wait elapses. Every dispatch (and its outcome) is recorded in the local alert ledger that powers 'alert trace'.

Use this command to review past alert dispatches and find ones that never became tickets. Do NOT use this command to dispatch a new alert; use 'alert send'. The Synthesize API has no list route for dispatched alerts; the local alert ledger written by 'alert send' is the only record. Each entry carries the messageId, account, dispatch time, and last-known ticket state. --stuck filters to alerts still pending or timed out - the queue-debugging work queue.

Adds an alert to the alerting queue. Required: accountId, alertId, description, priority (default: 1), status (default: 1), title. Optional: dueDateTime, serviceId. Returns the new AlertCreatedDto.

Analyze locally synced data with count, group-by, and summary operations. Data must be synced first with the sync command.

Set route for adding new unit count for one account, and one service. Subsequent calls will debounce until calls are complete. After which billing views will update. Required: serviceId, unitCount. Optional: no_build, accountId, clientOId. Returns the new ResponseDto.

DEPRECATED - This route is used to get the Client data needed to handling mapping externally. Optional: search, previousId. Returns array of string.

Get API domain context: resource taxonomy, auth requirements, query tips, and unique capabilities. Call this first.

hygiene subcommands: unmapped

Use this command for the full mapping-hygiene work queue (unmapped accounts AND service/SKU gaps) in one rollup. Do NOT use this command to fetch a raw filtered account list; use 'accounts list'. Joins two live reads - the integration's accounts (isMapped flag) and the vendor profile's SKU catalog - into one agent-shaped rollup: every account the MSP has not mapped yet, plus every SKU missing the description/category metadata that mapping in the Synthesize UI relies on.

Import data from a JSONL file by issuing POST requests for each record. Each line must be a valid JSON object. Failed records are logged to stderr but do not stop the import.

Preferred route for checking credentials. Returns the IntegrationData.

Update the integration status for a partner. Set as pending when ready for inital mapping. Set as active when ready for sync. Required: status (default: active). Returns the updated UpdateIntegrationStatusResponse.

Analyze locally synced data to show how many items are assigned to each person. Helps identify overloaded team members and unbalanced workload.

Create Service for a Vendor for an Organization. Returns array of UpdateMappingPropertyResponse.

Updates 1 or more fields of a single Service. Required: serviceId. Optional: description, id, isActive (plus 2 more). Returns the updated UpdateMappingPropertyResponse.

Updates 1 or more fields for each Service. Returns the updated UpdateMappingPropertyResponse.

Scan locally synced data for items that are missing important fields such as assignee, project, priority, or labels. Useful for triaging unowned work.

Full-text search across all synced data. Faster than paginating list endpoints. Requires sync first.

Create Service for a Vendor. Required: category, description, name, subcategory. Optional: supportArticle, supportContact. Returns the new VendorData.

Retrieves Vendor with VendorSku[] filtered by service id. Required: serviceId. Returns the GetServiceResponse.

Run read-only SQL against local database. Use for ad-hoc analysis, aggregations, and joins across synced resources. Requires sync first.

Scan locally synced data for items that have not been updated within the specified number of days. Useful for identifying forgotten or blocked work.

status subcommands: ready

Use this command to decide whether the integration is ready to flip to active. Do NOT use this command to change the status; use 'integration update-status'. Joins the live integration record (status, lastSyncedAt) with the live account mapping state into a single go/no-go verdict: ready means every account is mapped and the integration is in a state where activating makes sense (pending, or already active with a recent sync).

Sync data from the API into a local SQLite database. Supports resumable incremental sync (only fetches new data since last sync) and full resync. Once synced, use the 'search' command for instant full-text search. Exit codes & warnings: Resources the API denies access to (HTTP 403, or HTTP 400 with an access-policy body) are reported as warnings rather than failing the run. In --json mode each is emitted as a {"event":"sync_warning",...} line carrying status, reason, and message fields, and a final {"event":"sync_summary",...} aggregates the run. Exit 0 when at least one resource synced and no resource flagged in the spec as critical (x-critical: true) failed; non-critical failures emit {"event":"sync_warning","reason":"exit_policy_default_changed", ...} so callers can detect that a partial failure was tolerated. Pass --strict to exit non-zero on any per-resource failure. Exit is always non-zero when every selected resource failed, regardless of --strict. Resource scoping: --resources runs the named top-level resources, plus any parent-keyed dependent whose own name is listed OR whose parent table is listed. Naming a parent therefore cascades to its dependents (so "sync this parent and its children" works without listing every nested resource by hand). There is no flag today to suppress the cascade for a named parent. To run a dependent without re-syncing its parent, list only the dependent by name; the parent table must already be populated from a prior sync.

Tail streams live data changes by polling the API at configurable intervals. Events are emitted as NDJSON to stdout for piping to other tools. Gracefully shuts down on SIGTERM/SIGINT. Note: For APIs with WebSocket or SSE support, a future version will use native streaming instead of polling.

Checks for a ticket Event with the provided messageId to have created a ticket in the PSA. Required: messageId. Returns array of string.

usage subcommands: drift, push

Use this command to see which accounts' usage actually changed since the previous push - the reconciliation pre-flight. Do NOT use this command to send counts; use 'usage push'. The Synthesize API has no read-back for pushed unit counts, so the local push ledger written by 'usage push' is the only history that exists anywhere. This command joins the two most recent push runs per account x service and emits only the rows that moved (plus pairs added or removed between runs).

Use this command to push many unit counts from a file with a single billing rebuild. Do NOT use this command to send one ad-hoc count; use the 'billing' command. Do NOT use it to compare against the prior push; use 'usage drift'. Reads a CSV (header: accountId,serviceId,unitCount) or a JSON array of {accountId, serviceId, unitCount} objects, fans out one POST /vendor-api/service/{serviceId}/count per row with no_build=true on every call except the last (so Gradient rebuilds billing exactly once), and records each row in the local push ledger that powers 'usage drift'.

Get Vendor Details. Returns the GetVendorResponse.

Update details for a vendor. Optional: description, integrationPortalUrl, name (plus 1 more). Returns the updated UpdateVendorResponse.