setup-agents

Visual companion

VS Code Extension

A visual companion that brings setup-agents into the VS Code sidebar.

Personal open-source project. Not an official Salesforce product.

Point-and-click AI agent configuration

The Salesforce Setup Agents extension lets you configure profiles, connect Salesforce orgs, wire MCP servers, and manage rule files — all without touching the terminal. It wraps the same CLI plugin in a guided, sidebar-based workflow designed for teams where not everyone is comfortable running shell commands.

Product flow

In Action

Guided Setup + MCP Configuration

Select role profiles, apply rules, connect a Salesforce org, and browse third-party integrations — all from the sidebar.

Extension demo: guided setup and MCP configuration

Salesforce CLI Not Found

The extension shows a spinner while detecting SF CLI. If missing, it displays a clear error with installation instructions and a retry button.

Extension demo: SF CLI missing banner

Capabilities

Features

Guided Setup

Auto-detects installed AI tools (Cursor, VS Code, Codex, Claude, Agentforce) and lets you select role profiles visually.

MCP Configuration

Lists authenticated Salesforce orgs, lets you select which to connect, and writes the MCP config — project or global scope.

Third-Party Integrations

Profile-filtered integrations for Figma, Jira, draw.io, and GitHub. Select, enter credentials, and connect in one click.

Update Agent Rules

Detects stale rule files and lets you update them to the latest plugin version without re-running the full setup.

Rule Management

Import rules from URL or file, browse existing rule files, edit them inline, and save — all inside the sidebar panel.

Custom MCP Server

Add any MCP server not in the presets — specify name, transport (stdio or http), command, args, and env vars directly from the UI.

Health Checks

Shows a spinner while detecting SF CLI. If CLI or plugin is missing, displays actionable banners with install instructions and a retry button.

Before install

Prerequisites

1. Salesforce CLI

Install the SF CLI (sf v2+) from developer.salesforce.com or via npm:

npm install -g @salesforce/cli

2. CLI Plugin

Install the setup-agents plugin:

sf plugins install @jterrats/setup-agents

3. Extension

Install from the VS Code Marketplace or search Salesforce Setup Agents in the Extensions panel:

ext install jterrats.setup-agents-ui

Sidebar anatomy

UI Sections

Update Agent Rules

TOP

Runs sf setup-agents update --dry-run on load. If stale files are found, shows a count and an Update Now button.

Guided Setup

PROFILES + TOOLS

Shows detected AI tools as badges, renders 22 role profile cards with multi-select, and provides scope control (project vs user) and tool targeting. Click Apply Configuration to generate rule files — output streams to a live console.

MCP Configuration

ORGS + INTEGRATIONS

Lists authenticated Salesforce orgs (alias only, username on hover). Orgs already configured in your MCP config — regardless of key naming convention — are detected and pre-selected with a (connected) badge. Below the orgs section, third-party integrations (Figma, Jira, draw.io, GitHub) appear based on the profiles selected above. A Custom MCP Server form lets you add any arbitrary server (stdio or http) not covered by the presets.

IntegrationProfilesTransportCredentials
FigmaUX, BA, ArchitectHTTPNone
Jira CloudPM, BA, Developer, QA, DevOpsstdioURL, Email, API Token
draw.ioArchitect, BA, UX, DeveloperstdioNone
GitHubDeveloper, Architect, DevOps, QA, PMstdioPersonal Access Token

Custom MCP Server

ANY SERVER

Adds any MCP server not covered by the Salesforce or third-party presets. Choose stdio or http transport, provide a name, command/URL, args, and optional env vars. The entry is written directly to your project or global mcp.json.

Rule Management

IMPORT + EDIT

Import rule files from a URL or local file (supports Cursor, Agentforce, and Claude formats). Browse existing rule files with a dropdown, open them in an inline editor, and save changes directly.

Verification

Testing

E2E Tests (27 specs)

Playwright-based tests covering profile cards, MCP org cards, accessibility, keyboard navigation, and login flows.

cd extensions/vscode-setup-agents-ui
npm run test:e2e

Demo Recordings

Generate GIF recordings of the extension for documentation using Playwright video capture + ffmpeg:

# Record + convert in one step
npm run demo

# Or separately:
npm run demo:record
npm run demo:gifs

Want to try it?

Install the extension and open the Setup Agents sidebar in VS Code or Cursor.

Install Extension CLI Commands Browse Profiles Source Code