Get started with ProbeKit

Choose from 61 guided investigations

Open the investigation workspace to explore access, metadata, flows, OmniStudio, operations and data. Each investigation supplies typed parameters, API guidance and sequential query steps. Paste or select JSON/CSV exports, review observations and limits, and download a text or JSON summary. Enable comparison to inspect two sets of exports side by side. Every investigation includes fictional sample results.

For a local workspace, install Node.js 20+ and pnpm, then run pnpm run preview:web from the extracted project and open http://127.0.0.1:4794/investigations.html. The preview server does not publish or connect to Salesforce.

Investigate field access without installing anything

Open the field-access checker. Enter an object, field and username, then run the supplied queries in an approved Salesforce query tool. Paste complete JSON or CSV results to see matching permission grants and next checks. Analysis stays in your browser tab. Try the fictional sample to explore the workflow, or download a text findings report.

Use the library in your browser

Open the probe library, search for an object or question, and select a probe. Fill in its parameters to preview the command and SOQL. Copy the result using the copy buttons.

No installation is needed to browse. The website does not connect to your Salesforce org or execute queries.

Download and open locally

1. Download the ZIP and extract it.
2. For an offline library, open docs/index.html in your browser.
3. For the CLI or local server, install Node.js version 20 or newer. No project dependencies need installing.

On Windows, open the extracted folder in File Explorer, type cmd in the address bar and press Enter. On macOS or Linux, open a terminal in that folder.

node probe.mjs web --serve

Open http://127.0.0.1:4791. Press Ctrl+C in the terminal to stop the server.

Run a probe against Salesforce

Install the Salesforce CLI. Authenticate a sandbox and give it an alias:

sf org login web --alias MyDev --instance-url https://test.salesforce.com

For a Developer Edition org, omit the --instance-url option.

Inside the extracted ProbeKit folder, create a folder named .probekit. Save the following as .probekit/config.json, using the alias you authenticated:

{
  "orgs": {
    "dev": { "alias": "MyDev", "readonly": true }
  }
}

From the ProbeKit folder, list the probes, inspect one, and run it:

node probe.mjs list
node probe.mjs show access.field-grants
node probe.mjs run access.field-grants --org dev --obj Account --field Industry

Add --soql to print the queries. Results appear in the terminal; run history is saved in .probekit/usage/.

The browser previews commands beginning with probe. Use node probe.mjs in its place when running from the extracted folder, or run pnpm link --global once to install the probe command.

See the README for multiple-org comparisons, project probes, and production configuration.

Optional local MCP integration

Use ProbeKit from a compatible MCP client to find investigations, generate query plans, analyse exports and compare results. The server runs locally and uses the same 61-investigation catalogue. It does not connect to Salesforce or execute queries.

Download and extract the complete local version, install Node.js 20+ and pnpm, then run:

pnpm --dir mcp install --frozen-lockfile
pnpm --dir mcp check
pnpm --dir mcp config

The check verifies the local protocol connection. The config command prints JSON using your actual Node executable and server path. Copy only the JSON object into your client’s equivalent settings; it does not edit those settings for you.

Configure your client to launch node with the absolute path to mcp/server.mjs. See the MCP setup guide for configuration, Windows paths and a fictional walkthrough.

The connected client receives tool inputs and outputs and may transmit them under its own settings. Review those settings before supplying sensitive exports. Dependencies are installed separately and retain their upstream licences and notices.