PluginBench
Skill
Pass
Audit score 90

platform-architecture-analyze

forcedotcom/sf-skills

Holistic Well-Architected review of Salesforce DX projects: grades observable code/metadata criteria and emits governance checklist.

What is platform-architecture-analyze?

Orchestrates a read-only audit of Salesforce projects against the Well-Architected framework, scoring security, reliability, and composability pillars with file:line evidence. Use when asked to review architecture, run a health audit, or assess governance and risk holistically. Delegates heavy analysis to existing skills (code-analyzer, LSP) and produces a pillar-scored report plus manual checklist.

  • Scores three Well-Architected pillars (Trusted, Easy, Adaptable) with observable evidence from code and metadata
  • Delegates Apex security and performance checks to dx-code-analyzer-run, SOQL selectivity to platform-lsp-integrate, and structural signals via grep
  • Produces file:line evidence for each finding and maps them onto sub-pillar criteria
  • Emits a governance checklist for manual review items that code cannot assess
  • Generates a single report with pillar verdicts, observable findings, and recommended next steps

How to install platform-architecture-analyze

npx skills add https://github.com/forcedotcom/sf-skills --skill platform-architecture-analyze
Prerequisites
  • Salesforce CLI (sf) ≥2.0.0 installed
  • A valid Salesforce DX project with sfdx-project.json
  • (Optional) Connected org for org-dependent checks (OWD, permission sets); checks degrade gracefully without it
Claude Code
Cursor
Windsurf
Cline

How to use platform-architecture-analyze

  1. 1.Run the skill and provide the project root or package directory path
  2. 2.The skill scopes the project (counts classes, triggers, LWC, checks for tests and CI)
  3. 3.It delegates Apex analysis to dx-code-analyzer-run and SOQL checks to platform-lsp-integrate, then runs lightweight grep patterns for structural signals
  4. 4.Review the pillar verdicts table and observable findings with file:line evidence
  5. 5.Use the manual checklist to assess governance concerns your team owns (security matrix, encryption, org design)
  6. 6.Follow the recommended next steps, which name the specific skill to apply each fix

Use cases

Good for
  • Audit a new or inherited Salesforce project for security, governor-limit, and architectural risk before handoff or deployment
  • Review code-and-metadata health as part of a pre-release or compliance gate
  • Assess whether a project follows source/package strategy and avoids legacy anti-patterns (Workflow, @future, custom settings)
  • Identify SOQL injection, FLS bypass, bulkification, and sharing violations with exact file:line locations
  • Generate a structured governance checklist for team review of org-level concerns (OWD, permission sets, encryption strategy)
Who it's for
  • Salesforce architects and tech leads reviewing project health
  • Developers preparing for code review or release gates
  • Teams adopting Well-Architected governance or compliance frameworks
  • Code reviewers needing an objective, evidence-backed audit report

platform-architecture-analyze FAQ

Does this skill edit or deploy code?

No. It is read-only: it grades and recommends but never modifies, deploys, or deletes.

What if I don't have an org connected?

Org-dependent checks (OWD, permission sets, encryption) move to the manual checklist. Code and metadata checks still run.

How is this different from running sf code-analyzer directly?

This skill orchestrates code-analyzer and other tools, maps their findings onto the Well-Architected pillars, scores sub-pillars, and emits a governance checklist. It's a structured audit, not a single-tool scan.

Can I use this skill to fix issues it finds?

No, but the report names the skill to use for each fix (e.g., 'SOQL selectivity → platform-lsp-integrate', 'Apex refactor → platform-apex-generate').

What counts as 'observable' vs. 'manual'?

Observable: code patterns, metadata structure, static analysis findings (SOQL injection, FLS, bulkification, sharing keywords). Manual: org design (OWD), encryption strategy, security matrix, team process — things only your org and team can assess.

Full instructions (SKILL.md)

Source of truth, from forcedotcom/sf-skills.


name: platform-architecture-analyze description: "Use when the developer asks to "review the architecture", "run a Well-Architected check", "audit this project", "is this project well-architected?", or wants to assess security/governor-limit/risk as a holistic code-and-metadata health report. Grades observable criteria (sharing/FLS, bulkification, SOQL selectivity, packageability) with file:line evidence; emits a governance checklist for what it can't see. Read-only, never edits. DO NOT TRIGGER for single-tool Apex scans (dx-code-analyzer-run)." allowed-tools:

  • Bash
  • Read
  • Glob
  • Grep metadata: cliTools:
    • tool: ["sf"] semver: ">=2.0.0" relatedSkills:
    • "dx-code-analyzer-run"
    • "platform-lsp-integrate"
    • "platform-metadata-retrieve"
    • "platform-apex-generate"

Analyzing Architecture (Well-Architected Review)

Grade a Salesforce DX project against the Salesforce Well-Architected framework and produce an honest, evidence-backed report: a pillar-scored table for what's observable in code and metadata, plus a human checklist for the governance/process concerns a local repo can't reveal.

This skill is an orchestrator. It does not re-implement static analysis — it drives the analysis skills the plugin already ships and maps their output onto the Well-Architected pillars. It is read-only: it grades and recommends; it never edits, deploys, or deletes.

It also backs the architecture-review agent, which runs this exact workflow as a dedicated read-only reviewer. Invoke the agent for an end-to-end review; use this skill directly when you want the workflow inline in the current session.

Capability resolution

  1. Skill-orchestrated review (this skill) — runs the observable checks by delegating to existing skills/MCP tools, scores each sub-pillar, and emits the manual checklist.
  2. Direct CLI / grep — used only for the lightweight structural signals the rubric names (sharing keywords, legacy-tech file types, deploy strategy). Fine standalone, but skips the pillar scoring and the governance checklist this skill provides.
  3. API — not applicable.

The rubric (read these first)

Before scoring, read the three reference files — they are the source of truth:

Workflow

Step 1 — Scope the project

# Package directories + API version
cat sfdx-project.json

Establish:

  • Package dirs (from packageDirectories[].path) — where the source lives.
  • Inventory — count Apex classes, triggers, LWC bundles, Aura, Flows, objects:
    find <pkgdir> -name '*.cls' | wc -l
    find <pkgdir> -name '*.trigger' | wc -l
    find <pkgdir> -name '*.js-meta.xml' | wc -l   # LWC bundles
    
  • Tooling signals — does the repo have tests (*Test.cls, __tests__/), CI (.github/workflows/), linting (.eslintrc*, .prettierrc*), a package.xml vs source/package strategy?
  • Org connection — sf org display --json succeeds → org-dependent checks (OWD, permission sets) are in play; otherwise mark them manual.

Record the scope line for the report header.

Step 2 — Run the observable checks (delegate; don't re-scan)

Work through references/observable-checks.md. For the heavy lifting, delegate:

  • Apex security + performance → dx-code-analyzer-run. It runs sf code-analyzer and classifies findings by severity. Map its rules onto the rubric:
    • ApexSOQLInjection, ApexCRUDViolation, ApexInsecureEndpoint, ApexBadCrypto → Secure
    • ApexSharingViolations → Secure (sharing) / Composable (separation)
    • OperationWithLimitsInLoop, OperationWithHighCostInLoop → Reliable / Automated
    • AvoidDebugStatements → Automated
  • Inline SOQL parse + selectivity, compile-level diagnostics → platform-lsp-integrate (apex_diagnostics, lwc_diagnostics, check_soql_selectivity) when lsp_health is green → Reliable / Automated.
  • OWD / sharing model / permission sets → platform-metadata-retrieve + sf org inspection, only if an org is connected → Secure.

For the lightweight structural signals, grep directly (patterns in references/observable-checks.md), e.g.:

# Secure — classes missing a sharing keyword
grep -rLE 'with(out)? sharing|inherited sharing' --include='*.cls' <pkgdir>

# Intentional — legacy tech still present
find <pkgdir> -name '*.workflow-meta.xml' -o -name '*.flowDefinition-meta.xml'
grep -rl '@future' --include='*.cls' <pkgdir>

# Composable — deploy strategy
ls manifest/package.xml 2>/dev/null            # package.xml-driven (anti-pattern past PoC)
grep -l '"path"' sfdx-project.json             # source/package strategy

# Composable — runtime config in custom settings vs CMT
find <pkgdir> -path '*objects*' -name '*.object-meta.xml' | xargs grep -l 'CustomSetting' 2>/dev/null

Collect every finding with file:line evidence. A check with no evidence is not a pass and not a fail — it's "not observable" and moves to the manual checklist.

Step 3 — Score each observable sub-pillar

Assign ✅ / ⚠️ / ❌ per sub-pillar using the thresholds in references/observable-checks.md:

  • ✅ no anti-patterns found in the observable checks for that sub-pillar.
  • ⚠️ low/moderate findings, or only some criteria observable.
  • ❌ critical/high findings (e.g. SOQL injection, FLS bypass, SOQL-in-loop at scale).

Then roll the sub-pillar verdicts up to a pillar verdict (worst-of, with a note).

Step 4 — Emit the manual checklist

Copy the [manual] criteria from references/manual-review-checklist.md into the report as unchecked items, grouped by pillar. Label the section clearly: "not auto-graded — assess with your team." Do not guess at these; the point is to hand the developer a structured governance checklist, not to fake a score.

Step 5 — Report

Produce one report using the format below. Lead with pillar verdicts, then observable findings (Trusted/Secure first — never bury security under style), then the manual checklist, then recommended next steps that name the skill which would apply each fix.

Well-Architected Review — <project name>
Scope: <pkg dirs>, <N classes / M triggers / K LWC>, tests: <y/n>, CI: <y/n>, org: <connected alias / none>

PILLAR VERDICTS
  🛡️ Trusted     <✅|⚠️|❌>  (Secure …, Compliant …, Reliable …)
  ⚡ Easy         <✅|⚠️|❌>  (Intentional …, Automated …, Engaging …)
  🔁 Adaptable    <✅|⚠️|❌>  (Resilient …, Composable …)

OBSERVABLE FINDINGS  (graded from code + metadata)
  Sub-pillar | Verdict | Finding | Evidence (file:line / tool)

MANUAL REVIEW  (not auto-graded — assess with your team)
  [ ] <item>  …

RECOMMENDED NEXT STEPS
  - <highest-signal fix> → via `<skill>`

Examples

Example 1 — "Is this project well-architected?"

Scope the project, run all observable checks (delegating Apex analysis to dx-code-analyzer-run), score all three pillars, emit the full manual checklist, and report. This is the default full review.

Example 2 — "Review my project's security and governor-limit risk"

Narrow to the Secure and Reliable/Automated sub-pillars: run dx-code-analyzer-run with a security + performance selector, use platform-lsp-integrate check_soql_selectivity for selectivity, grep for missing sharing keywords. Score those sub-pillars; still emit the Secure/Compliant manual items (security matrix, encryption strategy). Skip the Adaptable deep-dive unless asked.

Example 3 — "Run a Well-Architected check before we package this for release"

Full review, weighting Composable (packageability — CMT vs custom settings, loose coupling, LATEST aliasing, no package.xml-driven deploys) and Resilient (source-tracked, CI, no failed deploys). Lead the report with the packageability readiness verdict.

Failure modes

SymptomCauseRecovery
dx-code-analyzer-run reports the analyzer isn't installedCode Analyzer v5 missingNote it in the report; fall back to grep-based structural checks for Apex and mark PMD-only criteria "not observable".
sf org display failsNo org connectedMark OWD / permission-set / org-metadata criteria as manual; grade only file-based criteria.
LSP tools return lsp_disabled / no_apex_workspaceLSP off or no workspaceSkip the LSP-grounded checks; rely on dx-code-analyzer-run + grep. Note the gap.
No sfdx-project.jsonNot an SFDX projectStop — this skill reviews SFDX projects. Tell the developer.
Huge repo, scan is slowProject-wide PMD + graph buildScope dx-code-analyzer-run to the package dir; note that cross-file (sfge) findings may be partial.

Rules

  • Read the three references/*.md files before scoring — the rubric is the source of truth.
  • Delegate observable detection to existing skills/MCP tools; grep only for the lightweight structural signals the rubric names.
  • Every observable finding carries file:line (or tool-result) evidence. No evidence → manual checklist, not the scored table.
  • Never score a [manual] governance criterion from inference — list it for human review.
  • Read-only: recommend fixes and name the skill that applies them (platform-apex-generate for Apex authoring / trigger refactoring); never edit, deploy, or delete.
  • Lead with Trusted/Secure findings; don't bury security under style nits.
  • Surface zero-finding sub-pillars briefly ("no issues found in observable checks") rather than omitting them.