Skip to main content

MCP Server Setup

Add SquireX to your AI IDE in one configuration block.


Installโ€‹

npm install -g @squirex.dev/mcp-server

Or use npx (no install needed) with a pinned version:

"command": "npx",
"args": ["@squirex.dev/mcp-server@4.0.1"]

4.0.1 is the current npm release; use the latest from npm view @squirex.dev/mcp-server version. Don't add -y: npx doesn't prompt when an MCP client launches it (stdin is not a terminal). SquireX's own rule AGENTFORCE-MCP-04 flags unpinned npx servers (@latest or no version), so the examples below pin it.


Configure Your IDEโ€‹

claude mcp add squirex -e SQUIREX_PROJECT_DIR=/path/to/your/salesforce/project -- npx @squirex.dev/mcp-server@4.0.1

Or commit a project-scoped .mcp.json with the same mcpServers block as the Claude Desktop tab.


Environment Variablesโ€‹

VariableRequiredDescription
SQUIREX_PROJECT_DIRRecommendedAbsolute path to the project to scan (default: the server's working directory)
SQUIREX_LICENSE_KEYIn CI onlyPro/Enterprise key; scans inside CI need one, local scans don't. Get one at squirex.dev/pricing
SQUIREX_CLI_PATHNoUse a specific squirex CLI entry instead of npx squirex@<server version>
SQUIREX_CLI_VERSIONNoOverride the CLI version fetched by npx (default: same as the server)
SQUIREX_GO_BINARYNoUse a specific squireinterp engine binary

Verifyโ€‹

Once configured, ask your AI agent:

"Scan my Agentforce metadata for security vulnerabilities"

The agent will call scan_agentforce and return a prioritized violation report.


Requirementsโ€‹

  • Node.js โ‰ฅ 18
  • squirex CLI installed (or available via npx)
  • A Salesforce project with Agentforce metadata