Skip to main content

MCP Tools Reference

All 16 tools available in @squirex.dev/mcp-server. Parameter names below match the server's tools/list input schemas exactly.

Results and errors. Scan tools return the SARIF 2.1.0 log as the first text item and a one-line summary as the second. Findings are results, not errors (the engine exits 2 when it finds violations). isError: true is set only when a tool could not run — CLI or engine missing, invalid arguments, no output — and the text explains why.

Annotations. Every tool declares a title and MCP behavior hints, so clients can decide what needs confirmation:

Hint setTools
Read-only, local (readOnlyHint: true, openWorldHint: false)scan_agentforce, scan_agentforce_file, scan_agentforce_rule, list_scan_rules, get_rule_details, explain_violation, suggest_fix, predict_conflicts
Local side effects (readOnlyHint: false, destructiveHint: false)run_tests, get_coverage, analyze_schema, generate_sarif_report, generate_dx_tests, validate_dx_tests
Read-only, external (openWorldHint: true)get_testing_center_results
Destructive, external (destructiveHint: true, openWorldHint: true)push_to_testing_center

Core Scanning​

scan_agentforce​

Full project scan (squirex scan). With baseBranch, a PR-scoped scan of changed files only (squirex scan-pr --base).

Parameters:

  • directory (optional) — directory to scan, relative to SQUIREX_PROJECT_DIR or absolute
  • baseBranch (optional) — diff against this branch; omit for a full scan

scan_agentforce_file​

Findings for a single file. Many rules are cross-file, so the server scans the whole project (or the file's directory if it is outside the project) and returns only the SARIF results located in this file.

Parameters:

  • filePath — path to the file, relative to the project root or absolute

scan_agentforce_rule​

Runs a single rule against the full project (--rules).

Parameters:

  • ruleId — e.g. AGENTFORCE-1.1

Rule Intelligence​

list_scan_rules​

Returns rules with id, category, severity, and short description.

Parameters:

  • category (optional)
  • severity (optional)

get_rule_details​

Returns full rule documentation including remediation guidance.

Parameters:

  • ruleId

explain_violation​

Rule-level root-cause explanation for a SARIF result.

Parameters:

  • ruleId
  • filePath (optional)
  • message (optional) — the SARIF result message
  • lineNumber (optional)

suggest_fix​

Rule-level fix template for a violation (does not read the file).

Parameters:

  • ruleId
  • filePath
  • violationContext (optional) — the violating XML/Apex snippet

Apex Testing & Schema​

run_tests​

Executes Apex tests using the Go runtime engine. Failing tests are results, not tool errors.

Parameters:

  • file (optional) — test file, e.g. MyTest.cls
  • filter (optional) — regex for test method names
  • parallel (optional, boolean)
  • failFast (optional, boolean)

get_coverage​

Returns line-level coverage data (runs the tests).

Parameters:

  • className (optional)

analyze_schema​

Returns the inferred SObject schema from the codebase.

Parameters:

  • directory (optional) — default ./force-app
  • includeHeatmap (optional, boolean)
  • live (optional, boolean, default true) — aggregate live via the Go engine; writes schema_graph.json in the project

predict_conflicts​

Parameters:

  • branches — comma-separated branch names (e.g. main,feature/my-branch)
  • simulate (optional, boolean)

generate_sarif_report​

Runs a scan and returns the SARIF log, or writes it to outputPath.

Parameters:

  • outputPath (optional) — file to write, relative to the project directory
  • baseBranch (optional) — PR-scoped report

Testing Center Bridge​

generate_dx_tests​

Converts scan violations to Agentforce DX test YAML.

Parameters:

  • sarifPath (optional) — existing SARIF file; a fresh scan runs if omitted
  • outputPath (optional)
  • suiteName (optional)
  • rules (optional) — comma-separated rule IDs

validate_dx_tests​

Validates a generated DX test spec.

Parameters:

  • testFilePath

push_to_testing_center​

Pushes the spec to Salesforce via sf agent test run.

Parameters:

  • testFilePath
  • targetOrg — authenticated org alias

get_testing_center_results​

Returns instructions for checking a Testing Center run.

Parameters:

  • testRunId
  • targetOrg