anypoint-connect

Start here

You need Node.js >=22; Node.js 24 LTS is recommended. If Node and npm are unfamiliar, follow the 15-minute setup instead of guessing through the commands below.

# Install
npm install --global @sfdxy/anypoint-connect

# Save a Connected App Client ID and Secret
anc config init

# Authorize your Anypoint user in the browser
anc auth login

# Verify the local session and one visible environment
anc auth status
anc apps list --env Sandbox

The Connected App must be App acts on behalf of a user, use Authorization Code, redirect to http://localhost:3000/api/callback, and include Full Access plus Background Access. The credential guide gives the exact UI fields, administrator handoff, storage model, rotation steps, and troubleshooting.

Related MCP server: Orion CLI

Credential model

The ID and Secret do not provide access without a browser-authorized user session. Environment variables can override where app credentials come from, but they do not implement headless CI authentication. This release does not support the client_credentials grant, and its encrypted token file is machine-bound.

What it does

Copyable task flows are in Common recipes; every CLI command is in the CLI reference, every MCP tool in the tool catalog, and how to read runtime metrics in Monitoring.

MCP server

Authenticate in a terminal before starting the server. The MCP host never receives the Client Secret or OAuth tokens; it sends tool calls to the local server that owns the session.

{
  "mcpServers": {
    "anypoint-connect": {
      "command": "npx",
      "args": ["-y", "@sfdxy/anypoint-connect@0.15.0", "mcp"]
    }
  }
}

VS Code uses a servers wrapper and Codex uses TOML. See the MCP guide or copy a checked-in configuration from examples/mcp.

Example requests use synthetic names:

What applications are visible in Sandbox? Read only.
Analyze errors for sample-orders-api in Sandbox over the last two hours.
Is the old generation of sample-orders-api in Production close to its limit?
Preview a deployment of target/sample-orders-api-1.3.0-mule-application.jar to Sandbox; do not apply it.

Safety

MCP deployment tools are previews until confirm: true is supplied, and anc deploy --dry-run prints the same plan. Publishing reads the JAR's embedded Maven identity and binds its SHA-256. Redeploys change only the artifact reference, preserving runtime, target, replicas, and settings. Deletion requires the deployment ID returned by the preview, Design Center writes require a single-use preview token, and production operations require an additional acknowledgement.

// Preview only
update_app_artifact({
  "appName": "sample-orders-api",
  "environment": "Sandbox",
  "version": "1.3.0"
})

// Apply the reviewed change
update_app_artifact({
  "appName": "sample-orders-api",
  "environment": "Sandbox",
  "version": "1.3.0",
  "confirm": true
})

The complete contract is in the safety model.

Library

The library reuses a profile authenticated with anc auth login. The Client ID and Secret construct the client; the profile selects the encrypted token store.

import { AnypointClient } from '@sfdxy/anypoint-connect';

const client = new AnypointClient({
  clientId: process.env.ANYPOINT_CLIENT_ID,
  clientSecret: process.env.ANYPOINT_CLIENT_SECRET,
  profileName: process.env.ANYPOINT_PROFILE || 'default',
});

const identity = await client.whoami();
const environments = await client.accessManagement.getEnvironments(identity.organization.id);
console.log(`Authenticated; ${environments.length} environment(s) visible.`);

Direct API clients include bearer injection, refresh, rate limiting, and caching. They do not include the CLI/MCP confirmation gates. Start with the runnable JavaScript example in examples/library and read the library guide.

Profiles and multiple organizations

Use neutral profile names rather than customer names:

anc config init --profile team-a
anc auth login --profile team-a
anc config use team-a

The directory binding contains only a local profile label, but it can still reveal internal context. Add .anypoint-connect.json to the project's .gitignore. Resolution rules and storage layout are in Profiles.

Development

nvm use
npm install
npm run build
npm test
npm run lint
npm run docs:check
mkdocs build --strict

CI tests Node 22, 24, and 26. Documentation is built with MkDocs Material and published through GitHub Pages. Releases are tag-triggered and published to npm with provenance.

License

MIT