Sherweb MCP

Compute the projected monthly cost delta of changing a subscription to a new seat quantity, using the unit price stored from the subscription pricing-information endpoint. Read-only — it never sends an amendment. Use 'service-provider amend-subscriptions' to actually apply the change. Run 'sherweb-cli deep-sync' first so the subscription and its unit price are in the store.

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

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

Iterate every synced customer and pull their subscriptions (with pricing), receivable charges, and metered usage from the Service Provider API into the local store, then append payable, receivable, and subscription snapshots for drift/trend/churn tracking. Run 'sherweb-cli sync' first to populate customers + payable charges. The transcendence commands (margin, orphans, fleet-subs, right-size, amend-preview, drift, margin-trend, sub-changes, usage-leak) read what this command writes.

Returns the charges you are billed by Sherweb for a billing period: products, quantities, list/net pricing, fees, taxes, and deductions. Optional: date.

Diff the two most recent payable-charges snapshots in the local store. Each 'sherweb-cli deep-sync' run appends a snapshot, so drift needs at least two syncs to compare. Charges are keyed by customer + SKU + charge name; entries sort by absolute dollar delta descending.

The Service Provider API returns subscriptions one customer at a time. This command aggregates the whole book from the local store: total seats, customer count, and subscription count per product/SKU, sorted by total seats. Run 'sherweb-cli deep-sync' first to populate per-customer subscriptions.

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.

Compute net margin per customer = what the customer owes you (receivable charges) minus what you owe Sherweb (payable charges), from the local SQLite store. Run 'sherweb-cli sync' (payable charges + customers) and 'sherweb-cli deep-sync' (per-customer receivable charges) first. Rows sort worst-margin-first so leaks surface at the top.

Use this command for a per-customer margin time-series across multiple monthly snapshots. Do NOT use this command for a single month's margin; use 'margin' instead. Do NOT use this command for line-item charge changes; use 'drift' instead. Each month's margin pairs the latest payable snapshot with the latest receivable snapshot from that month (both written by 'sherweb-cli deep-sync'). Months missing either fleet-wide snapshot are skipped so an unrecorded snapshot never reads as a loss; within a kept month, a customer absent from one side still shows that side as 0 (same semantics as 'margin'). Rows sort steepest-decline-first.

Anti-join the local subscriptions against receivable charges: any active subscription whose customer billed zero receivable charges in the latest period is an orphan you pay Sherweb for but are not billing the customer for. Run 'sherweb-cli sync' and 'sherweb-cli deep-sync' first.

Join local subscriptions (seats paid) against platform meter-usage (seats used) and flag over- and under-provisioned subscriptions. Only subscriptions with a usage signal are returned; rows sort by absolute seat delta descending. Run 'sherweb-cli deep-sync' first to populate subscriptions + usage.

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

Submit one or more subscription quantity changes. Returns a tracking id. Required: customerId, subscriptionAmendmentParameters.

Cancel one or more of a customer's subscriptions. Required: customerId, subscriptionIds. Returns the new TrackingRef.

Get the product catalog available to a specific customer. Required: customerId. Returns the CustomerCatalog.

Get pricing for specific catalog items for a customer. Required: customerId, skus. Returns the new ServiceProviderGetCustomerCatalogItemsPricingResponse.

Get details for one provisioned platform of a customer. Required: customerId, platformId. Returns the ServiceProviderGetCustomerPlatformDetailsResponse.

Get metered usage for a customer's platform. Required: customerId, platformId. Returns the ServiceProviderGetCustomerPlatformMeterUsagesResponse.

Get the platform configurations provisioned for a customer. Required: customerId. Returns the ServiceProviderGetCustomerPlatformsConfigurationsResponse.

Get the required provisioning parameters for given SKUs/platform. Required: skus. Returns the new ServiceProviderGetPlatformRequiredParametersResponse.

Resolve which platforms can fulfill given SKUs. Required: skus. Returns the new ServiceProviderGetPlatformsForSkusResponse.

Get receivable charges (what a customer owes you) for a date. Required: customerId. Optional: date. Returns the ServiceProviderGetReceivableChargesResponse.

Get metered subscriptions for a customer. Required: customerId. Returns the ServiceProviderGetSubscriptionMetersResponse.

Get pricing information for a customer's subscriptions. Required: customerId. Returns the ServiceProviderGetSubscriptionsPricingResponse.

Get the status of an order or amendment by tracking id. Required: trackingId. Returns the ServiceProviderGetTrackingStatusResponse.

List the customers under your reseller account. Optional: page, pageSize. Returns array of Customer.

List the provisioning platforms available to you. Returns the ServiceProviderListPlatformsResponse.

List a customer's subscriptions with details. Required: customerId. Returns array of Subscription.

Place a marketplace order for a customer. Required: customerId, cartItems. Returns the new TrackingRef.

Validate an order cart for a customer before placing it. Required: customerId, cartItems. Returns the new ServiceProviderValidateOrderResponse.

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

Use this command for subscriptions added, cancelled, or quantity-changed between two syncs across all customers. Do NOT use this command for payable-charge changes; use 'drift' instead. Do NOT use this command for current total seats by product; use 'fleet-subs' instead. Diffs the latest subscription snapshot (written by 'sherweb-cli deep-sync') against the prior one — or, with --since, against the most recent snapshot at least that old (e.g. --since 30d). The biggest seat swings sort first.

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.

Use this command for metered platform usage with NO matching receivable charge. Do NOT use this command for subscriptions billed to no one; use 'orphans' instead. Do NOT use this command for paid-vs-metered seat counts; use 'right-size' instead. Anti-joins the usage rows against receivable charges in the local store (both populated by 'sherweb-cli deep-sync'). A row leaks when its customer+SKU pair has no receivable charge; unresolvable SKUs only leak when the customer has no receivable charges at all. The biggest absorbed consumption sorts first.

Compound workflows that combine multiple API operations

Archive fetches all syncable resources from the API and stores them in a local SQLite database. Supports incremental sync (only new data since last run) and full resync. After archiving, use 'search' for instant full-text search.

Show local archive status and sync state for all resources