Skip to content

sf-pi Agent Orientation

Auto-generated from manifests and repo layout. Run npm run generate-catalog to refresh; do not edit by hand.

Start here

  1. AGENTS.md — automatically loaded repository rules and authority order.
  2. Query catalog/index.json only when the owning extension is unknown.
  3. Read extensions/<id>/manifest.json for declared surfaces and document roles.
  4. For code changes, read the declared docs.editingRules, then the relevant source and Behavior Proof.
  5. For tool operation, use the active schema first and read docs.agentGuide only when deeper ordering or recovery guidance is useful.
  6. Use the extension README for human explanation and a specific ADR/context glossary for rationale or terminology.

Extension map

Use this table to locate the owner. Exact summaries, maturity, defaults, providers, tool names, events, safety notes, state paths, and environment variables remain in catalog/index.json.

ExtensionCategoryCommandsToolsEditing rulesOperating guideReferencesEntry point
SF Pi Managermanager/sf-pi0nonenonenoneextensions/sf-pi-manager/index.ts
SF LLM Gatewayprovider/sf-llm-gateway0rulesnonenoneextensions/sf-llm-gateway/index.ts
SF Agent Scriptagent-tool/sf-agentscript4rulesguideindexextensions/sf-agentscript/index.ts
SF Apexagent-tool/sf-apex1noneguidenoneextensions/sf-apex/index.ts
SF Browseragent-tool/sf-browser10noneguideindexextensions/sf-browser/index.ts
SF Code Analyzeragent-tool/sf-code-analyzer1noneguidenoneextensions/sf-code-analyzer/index.ts
SF Data 360agent-tool/sf-data36011rulesguideindex, indexextensions/sf-data360/index.ts
SF Docsagent-tool/sf-docs1rulesguideindexextensions/sf-docs/index.ts
SF Herdragent-tool/sf-herdr1noneguidenoneextensions/sf-herdr/index.ts
SF LWCagent-tool/sf-lwc1noneguidenoneextensions/sf-lwc/index.ts
SF Slackagent-tool/sf-slack10rulesguidenoneextensions/sf-slack/index.ts
SF SOQLagent-tool/sf-soql1noneguidenoneextensions/sf-soql/index.ts
SF tldrawagent-tool/sf-tldraw1rulesguideindexextensions/sf-tldraw/index.ts
SF Guardrailsafety/sf-guardrail0rulesnonenoneextensions/sf-guardrail/index.ts
SF Brainassistivenone0noneguidenoneextensions/sf-brain/index.ts
SF Feedbackassistive/sf-feedback0nonenonenoneextensions/sf-feedback/index.ts
SF LSPassistive/sf-lsp0nonenonenoneextensions/sf-lsp/index.ts
SF Data Explorerui/sf-data-explorer0rulesnonenoneextensions/sf-data-explorer/index.ts
SF DevBarui/sf-devbar, /sf-org0nonenonenoneextensions/sf-devbar/index.ts
SF Ohana Spinneruinone0nonenonenoneextensions/sf-ohana-spinner/index.ts
SF Skillsui/sf-skills0nonenonenoneextensions/sf-skills/index.ts
SF Welcomeui/sf-welcome, /sf-setup-fonts0nonenonenoneextensions/sf-welcome/index.ts

Manifest doc metadata

Every extension manifest must provide non-empty docs.summary and docs.primaryFiles fields. Extension-local AGENTS.md, AGENT_GUIDE.md, and CONTEXT.md files are declared explicitly as docs.editingRules, docs.agentGuide, and docs.contextGlossary. Tool-owning extensions require an agent guide. docs.referenceRoots routes every Markdown file under extension docs/ and references/ as current, generated-current, or compatibility material. docs.stateFiles, docs.env, and docs.safety remain optional.

Each docs.primaryFiles entry is extension-relative, resolves to an existing unique path, and the read-first set is capped at 8. Reference-root indexes are also extension-relative; generated-current roots name their repository generator.

Runtime surfaces

SurfaceOwners
Slash commandsSF Pi Manager, SF LLM Gateway, SF Agent Script, SF Apex, SF Browser, SF Code Analyzer, SF Data 360, SF Docs, SF Herdr, SF LWC, SF Slack, SF SOQL, SF tldraw, SF Guardrail, SF Feedback, SF LSP, SF Data Explorer, SF DevBar, SF Skills, SF Welcome
LLM toolsSF Agent Script, SF Apex, SF Browser, SF Code Analyzer, SF Data 360, SF Docs, SF Herdr, SF LWC, SF Slack, SF SOQL, SF tldraw
Provider registrationSF LLM Gateway, SF Docs, SF Slack
Startup/session hooksSF Pi Manager, SF LLM Gateway, SF Agent Script, SF Apex, SF Browser, SF Code Analyzer, SF Data 360, SF Docs, SF Herdr, SF LWC, SF Slack, SF SOQL, SF tldraw, SF Guardrail, SF LSP, SF Data Explorer, SF DevBar, SF Ohana Spinner, SF Skills, SF Welcome
Tool-call hooksSF Guardrail, SF Welcome
Generated docs/catalogscripts/generate-catalog.mjs, catalog/index.json, catalog/registry.ts, docs/extensions.md, docs/extensions/*.md, docs/.vitepress/generated-extension-sidebar.ts, docs/commands.md

Generated files

Do not edit these by hand; edit the source manifest/docs and run npm run generate-catalog.

  • catalog/index.json
  • catalog/registry.ts
  • docs/extensions.md
  • docs/extensions/*.md
  • docs/.vitepress/generated-extension-sidebar.ts
  • docs/commands.md
  • docs/agent-orientation.md
  • docs/adr/README.md
  • generated marker blocks in ARCHITECTURE.md, CONTRIBUTING.md, lib/common/README.md, scripts/e2e/README.md, and docs/troubleshooting.md
  • generated file-structure marker blocks in extensions/*/README.md
  • normalized catalog/announcements.json release entry

Automation shortcuts

  • npm run docs:health:check — documentation drift and tracked public-artifact lint.
  • npm run check:architecture — source-size advisories and shared state-placement policy.
  • npm run check:manager-first — real-factory no-args Manager routing proof.
  • npm run test:runtime-surface — real-factory manifest registration attestation.
  • npm run validate:ci — local approximation of CI's validation lane.

Released under the Apache-2.0 License.