Nue Admin
Nue Admin
The Nue Admin server is the administrative arm of the Nue MCP Gateway. Where the other servers help your teams sell, price, and bill, this one looks after the platform those activities run on: the system settings that govern how Nue behaves, the movement of data into and out of the tenant, and the webhook endpoints that keep your surrounding systems informed of what has happened.
Administrators have always been able to perform this work through the Nue Admin console. What the Nue Admin server changes is who, or what, can carry it out. An assistant connected to this server can be asked to capture the current configuration of a production tenant before a release, load a season's worth of catalog and pricing updates, report on whether last night's data import finished cleanly, or confirm that every webhook a downstream system depends on is still enabled. Each request is answered by the same platform APIs the console uses, so the outcome is identical to doing the work by hand.
The natural audience is the team responsible for keeping Nue healthy across environments. Configuration work tends to arrive in bursts — a sandbox refresh, a quarterly catalog load, an integration going live — and it tends to be repetitive, precise, and easy to get subtly wrong at two in the morning. Delegating the mechanical parts to an assistant, while keeping a person in the decision seat, is where this server earns its place.
Before you begin
- The Nue Admin server is available but not connected by default. An administrator enables it from the MCP Servers list in your Nue tenant before anyone can use it.
- Connection is made through the Nue MCP Gateway. See Connecting to Nue MCP for the one-click, per-user sign-in flow.
- Permissions follow the person or key that connected. The tools here read and change tenant-wide configuration, so grant access deliberately and to the smallest group that genuinely needs it.
- Because these operations affect the whole tenant rather than a single quote or invoice, we recommend rehearsing any unfamiliar sequence in a sandbox before running it against production.
What it covers
The server is deliberately compact. It exposes twenty-one tools, arranged in three areas of responsibility: system settings, data import and export, and webhook endpoints. Together they cover the administrative work that is most often repeated, most often scripted, and most often needed in a hurry.
Tools appear through the gateway under the admin_ prefix, so they are easy to distinguish from the lifecycle, pricing, and billing tools your assistant may also have available.
System settings
Nue's behaviour is shaped by settings that sit at the tenant level, and those settings are grouped by the part of the platform they govern. Each group can be exported to a portable definition and imported back again, which is what makes it practical to promote a configuration from one environment to another, keep a record of how a tenant was configured on a given date, or restore a known-good state after an experiment.
Tool | What it does |
|---|---|
exportSettings | Produces a complete export of the Nue on Salesforce system settings for the tenant. Use this to capture the current configuration before a change, or as the source when promoting settings to another environment. |
importSettings | Applies a previously exported set of Nue on Salesforce system settings to the tenant, bringing an environment into line with a known configuration. |
exportTenantOrderSettings | Produces an export of the order system settings, covering how orders are numbered, defaulted, and processed for the tenant. |
importTenantOrderSettings | Applies an exported set of order system settings, which is the usual way to move order behaviour from a sandbox into production once it has been agreed. |
exportTenantBillingSettings | Produces an export of the billing system settings that determine how billing runs behave across the tenant. |
importTenantBillingSettings | Applies an exported set of billing system settings, so a billing configuration proven in one environment can be reproduced faithfully in another. |
getTenantCreditSettings | Reports the tenant's credit settings, which govern how customer credit is handled. This is a read-only view, useful when confirming configuration without changing anything. |
Data import and export
Most substantial data work in Nue is handled as a job rather than a single instantaneous call, because the volumes involved are usually large enough to warrant it. The pattern is consistent: create a job, supply its contents, then check on its progress until it reports completion. These tools follow that shape, and an assistant can be asked to see a job through from start to finish and report the outcome in plain language.
Tool | What it does |
|---|---|
createImportJob | Opens a new import job, which is the first step in bringing a set of records into the tenant. |
addJobContent | Supplies the file contents for an import job that has already been opened, so the platform has the data it needs to process. |
findImportJobById | Reports the current status of an import job, including whether it has finished and whether it encountered problems along the way. |
createAndStartRevenueBuilderDataImportJob | Opens and immediately begins an import of products and pricing data. This is the route used for catalog and price-book loads, where the data belongs to the Revenue Builder side of the platform. |
findRevenueBuilderDataImportJobById | Reports the status of a products-and-pricing import, so an assistant can confirm that a catalog load completed as expected before anyone relies on the new prices. |
createExportJob | Opens a data export job, which is how records are extracted from the tenant for reporting, migration, or archival purposes. |
createExportGraphqlJob | Opens an export job that is narrowed by a query, so the extract contains only the records that meet the conditions you describe rather than an entire object. |
findExportJobById | Reports the status of an export job and confirms when the extract is ready. |
Webhook endpoints
Webhooks are how Nue tells the rest of your estate that something has happened. Keeping them accurate matters: an endpoint left disabled after an incident, or pointing at a decommissioned service, produces silence that is easily mistaken for calm. These tools let an assistant take inventory of what is registered, stand up a new endpoint, and turn delivery on or off without a person navigating the console.
Tool | What it does |
|---|---|
listRegistries | Lists every webhook endpoint registered for the tenant, together with its current state. This is the natural starting point for any review of outbound integrations. |
register | Registers a new webhook endpoint, so a downstream system begins receiving the events it subscribes to. |
updateRegistration | Amends an existing webhook endpoint, which is how a changed address or an adjusted subscription is applied without removing and recreating the registration. |
enable | Turns on delivery for a webhook endpoint that is currently paused. |
disable | Pauses delivery for a webhook endpoint while leaving its registration in place, which is the safe way to stop traffic to a system that is undergoing maintenance. |
delete | Removes a webhook endpoint permanently. Deletion cannot be undone, so it is worth confirming that no integration still depends on the endpoint first. |
Typical requests
The following are the kinds of things teams ask an assistant connected to this server. They are written the way a person would actually phrase them.
- "Export the billing settings from the sandbox so we have a record of the configuration before Monday's release."
- "Load this quarter's updated price book and tell me when the import has finished and whether anything was rejected."
- "List every webhook endpoint we have registered and point out any that are currently disabled."
- "The reporting integration is being retired this week — disable its webhook endpoint but leave the registration in place for now."
- "Check whether last night's product import completed successfully."
- "Bring the order settings in this environment into line with production."
Related
- Nue MCP Servers Overview — how the gateway works and which servers are available.
- Connecting to Nue MCP — how to connect from ChatGPT, Claude, Cursor, and other clients.
- Nue Billing & Collections — the companion server for invoicing, payments, and collections.
- Nue Lifecycle Manager — opportunities, quotes, orders, and subscriptions.
- Nue Price Builder — products, pricing rules, bundles, and pricing plugins.