Agent Script Skill
What This Skill Is For
This skill is for developing Agentforce agents, primarily with Agent Script, Salesforce's scripting language for AI agents.
Org-backed workflows require an Agentforce license, API v66.0 or later, and an Einstein Agent User. Static authoring and review can proceed without org access.
CRITICAL: Agent Script is NOT AppleScript, JavaScript, Python, or any other language. Do NOT confuse Agent Script syntax or semantics with any other language you have been trained on.
Agent Script agents are defined by AiAuthoringBundle metadata: a .agent file (agent behavior) plus bundle-meta.xml (bundle metadata). Actions can be implemented with invocable Apex, autolaunched Flows, Prompt Templates, and other supported types.
This skill covers the full Agent Script lifecycle: designing agents, writing Agent Script code, validating and debugging, deploying and publishing, and testing.
How to Use This Skill
This file maps user intent to task domains and relevant reference files in references/. Treat this file as the execution router for end-to-end agent development, and use references for deep detail.
Identify user intent from task descriptions. Read only the reference explicitly required by the active step or needed for the current decision. Every Reference Files section is a lookup index, not a preload list; do not load files for later or inapplicable steps.
Rules That Always Apply
Always
--json. ALWAYS include--jsonon EVERYsfCLI command. Do NOT pipe CLI output throughjqor2>/dev/null. Read the full JSON response directly — LLMs parse JSON natively.Verify target org. Before any org interaction, run
sf config get target-org --jsonto confirm a target org is set. If none configured, ask the user to set one withsf config set target-org <alias>.Diagnose before you fix. When validating/debugging agent behavior, ALWAYS
--use-live-actionsto preview authoring bundles. Send utterances then read resulting session traces to ground your understanding of the agent's behavior. Trace files reveal subagent selection, action I/O, and LLM reasoning. DO NOT modify.agentfiles or action implementations without this grounding. See Validation & Debugging for trace file locations and diagnostic patterns.Spec approval is a hard gate. Never proceed past Agent Spec creation without explicit user approval.
Don't stall. After a step completes successfully, announce the next step and start it. Do not wait for the user to say "what's next" or "ok, continue." The only checkpoints that require explicit user approval are: (a) Agent Spec approval, (b) the pre-Publish CHECKPOINT, (c) any A/B branch the skill explicitly surfaces (e.g., Data Cloud not provisioned during ADL setup). Long-running async work like ADL indexing should run in the background while the skill continues with work that doesn't depend on the result.
Draft-first lifecycle. During normal authoring, stay in draft iteration: edit
.agent+ action implementations, validate, deploy, and preview as many times as needed. Do NOT publish/activate by default. Publish + activate are explicit release actions that require the user to confirm they are ready to commit the current draft to metadata and expose it to end users.Start with one execution block and no mutable state. A focused agent puts reasoning and actions directly in
start_agent. Add a subagent only for a real objective, instruction, action, authority, or escalation boundary. Add persistent state only for a named deterministic consumer and give it a complete lifecycle. Ordinary continuity stays in surviving history. Apply the concrete checks in The Zen of AgentScript and Posture & Determinism.Use supported control flow. Use the canonical conditional forms and never generate a nested
if, which Agentforce lint rejects. See Conditional Control Flow Syntax, then run full bundle validation.Action implementation is a user decision. During planning/spec work, default new actions to
NEEDS STUBplaceholders. Always ask the user whether they want to scan org/project for existing implementations and/or generate new Apex/Flow/Prompt implementations before taking either path.Give each reachable branch one next outcome. Choose exactly one primary outcome: answer, ask, invoke an action, transition, refuse, or escalate. The compiler selects a subagent
system.instructionsoverride instead of the global value, and the current runtime assembles effective system and resolved reasoning text for the model. Keep authoring constructs out of model-facing text. See Instruction Resolution.Use portable structural indentation. Generate new
.agentfiles with 4 spaces per level. Preserve a consistently indented legacy file during a surgical edit, or normalize the whole file as a separate validated change.
Task Domains
Every task domain below has Required Steps. Follow verbatim, in order. The default path is: design -> draft implementation loop -> validation/preview loop -> explicit user-approved release.
Create an Agent
User wants to build new agent from scratch. ALWAYS use Agent Script. Work with User to understand the agent's purpose, subagents, and actions using plain language without Salesforce-specific terminology.
Required Steps
Before running an sf command, read only the applicable command section in
CLI for Agents. Do not preload the
CLI reference during design-only work.
- Design — Read Design & Agent Spec to draft an Agent Spec. Default all new actions to
NEEDS STUBplaceholders during planning. Ask the user which implementation path they want before implementation work:- Path A: Keep placeholders only (no implementation now)
- Path B: Scan for existing actions to reuse
- Path C: Generate new actions
Only run scans (reading
sfdx-project.json, searching@InvocableMethod,AutoLaunchedFlow, prompt templates, external service registrations, standard invocable actions, and custom objects) if the user explicitly chooses Path B or C. If the agent's purpose involves answering from documents (e.g., "answer customer questions from our product manual", "respond based on a policy guide", "FAQ from a PDF"), ask the user: "Will this agent answer questions from a document corpus (PDF/DOCX/TXT)? If so, what file path?" Capture the path in the Spec under a "Knowledge Grounding" section. Asking now — during requirements capture — is critical: ADL indexing takes minutes, so we want the file path captured pre-Spec-approval and provisioning kicked off as early as possible. If the agent will handle voice/telephony (e.g., "phone agent", "voice bot", "IVR replacement", "call center agent"), confirm it's a voice agent and capture a "Voice Configuration" section in the Spec. Do not ask the user for a voice_id — there is no reliable way to enumerate voice IDs and tuning values from the CLI. Always start with the platform default voice (UgBBYS2sOqTuMpoF3BR0— "Mark", en_US;outbound_speed: 1,outbound_stability: 0.65,outbound_similarity: 0.75) and tell the user they can customize the voice later in the Agent Builder UI (open the agent → Connections → Voice, click Continue to pick a different voice and tune speed/stability). See Voice Modality Reference for themodality voice:block syntax and voice-specific authoring guidance. Voice service agents are almost always knowledge-backed (callers ask FAQ/policy/troubleshooting questions). When you detect a voice agent, proactively ask the Knowledge Grounding question above — do not wait for the user to mention documents. This pairing (voice + knowledge grounding) is the Project Codey "Steel Thread 2" shape, and grounding on an ADL/Salesforce Knowledge corpus is what keeps a voice agent from hallucinating spoken answers. If the user has a document corpus, capture the file path and provision the ADL as usual; theassets/agents/voice-knowledge-grounded.agenttemplate shows the combined wiring. Always save Agent Spec as file.
- STOP for user approval of Agent Spec. Present to user (including the Knowledge Grounding section if present). Ask for approval or feedback. Do not proceed without approval. Once approved, proceed without stopping unless a step fails.
- Validate environment prerequisites — Read Design & Agent Spec, Section 3 (Environment Prerequisites). Based on agent type from design, validate org environment:
- Employee agent: Confirm the file normally omits
access.default_agent_user,connection messaging:, and MessagingSession linked variables. Remove them if present. Exception: If the agent has aknowledge:block (usesAnswerQuestionsWithKnowledge),access.default_agent_userIS required even for employee agents — the platform treats knowledge-grounded agents as requiring an Einstein Agent User context at runtime. Query for the agent user and include it. See Examples for a complete employee agent example. - Service agent: Query org for Einstein Agent User. If one exists, confirm username with user. If none, guide user through creation. See CLI for Agents, Section 12 for creation steps and Agent User Setup for required permissions.
3b. Kick off ADL provisioning (only if the Spec has a Knowledge Grounding section). Read Data Library Reference. Run the Step 0 preflight:
SELECT COUNT() FROM DataKnowledgeSpace(DC provisioned check), thensf agent adl list(ADL service health check). If DC is not provisioned, present the A/B choice from that reference. If DC is provisioned but the ADL service returns400 INTERNAL_ERROR, surface the "DC up, ADL broken" path and skip grounding for this run. If both checks pass, runsf agent adl create(reference Step 1) to capturelibraryId. Computerag_feature_config_id = "ARFPC_<libraryId>"from thelibraryIdalone — that's enough to author the bundle. Then start the upload + indexing flow (reference Steps 2–6) in the background while authoring continues. Per Rule 5, do not block on async indexing;retrieverIdis only needed for runtime queries (gated in Step 8). Also kick off the Data Cloud permset assignment for the agent user — see Agent User Setup, Step 3b for the discovery-then-assign procedure, which now ends with Step 3b.5 pinned post-assignment verification (against the resolved running-user and Einstein Agent User IDs) so callers can treat "Step 3b passed" as an authoritative Data Cloud grounding gate without re-running inline SOQL. Do not proceed to code generation until environment is validated (ADL provisioning may continue running in background).
- Employee agent: Confirm the file normally omits
- Generate authoring bundle —
sf agent generate authoring-bundle --json --no-spec --name "<Label>" --api-name <Developer_Name> - Write code — Read Core Language for syntax, block structure, and anti-patterns. Read Instruction Resolution for instruction patterns, recommended instruction order, and anti-patterns (especially Anti-Pattern 7: prose-based conditional logic). Edit generated
.agentfile using reference files and templates. Do not create.agentorbundle-meta.xmlfiles manually. If Step 3b produced alibraryId, include the top-levelknowledge:block and theAnswerQuestionsWithKnowledgeaction wiring per Data Library Reference, section "Wiring the ADL into Agent Script". The template atassets/agents/knowledge-grounded.agentis a copy-modify starting point. If the Spec has a Voice Configuration section, include themodality voice:block (using the defaultvoice_idand tuning values) andlanguage:block per Voice Modality Reference. Keep the standardagent_type(e.g.AgentforceServiceAgent) — do NOT set anAtlas__VoiceAgenttemplate in the bundle; that is a runtime planner_type, not an authored field. Also add theVoiceCallId: linked stringvariable bound to@VoiceCall.Idand addconnection customer_web_client:(ECv2 — the voice-capable surface) withadaptive_response_allowed: True. Keep themodality voice:block minimal (voice_id + speed/stability/similarity); advanced settings (filler-word detection, speak-up, endpointing) are optional — add only if the Spec calls for them.connection messaging:is additive — include it only if the agent escalates to a human (@utils.escalate). Write concise voice instructions with the high-value guards: read back critical data (IDs/amounts/dates) before acting, and never read out URLs/citations/visual formatting. Also add the spoken-delivery instruction rules from Voice Modality Reference "Instructions for Voice Agents" — ack/filler phrases before slow actions, spoken-form numbers, ASR repair prompts, and empty-result fallbacks. When wiring actions into a voice agent, apply the voice-safe action rules in actions-reference.md "Voice-Safe Action Authoring" (plain-English descriptions, speakable parameter names, enums, lookup-step for internal IDs, voice-friendly error shapes) and check the actions against voice-latency-heuristics.md — flag (don't silently rewrite) sync writes, bulky retrieval, and chained callouts on the live-call path. The template atassets/agents/voice-service-agent.agentis a copy-modify starting point. If the Spec has both a Voice Configuration and a Knowledge Grounding section, start fromassets/agents/voice-knowledge-grounded.agentinstead — it combinesmodality voice:, the voice wiring, and theknowledge:block +AnswerQuestionsWithKnowledgeaction with spoken-answer anti-hallucination guards. - Validate compilation —
sf agent validate authoring-bundle --json --api-name <Developer_Name>If validation fails, read Validation & Debugging to diagnose and fix, then re-validate. ALWAYS fix syntax and structural errors before generating action implementations. - Generate action implementations (explicit user-requested path only) — Only run this step if the user explicitly asked to generate new implementations (Path C in Step 1). For each action marked NEEDS STUB:
sf template generate apex class --name <ClassName> --output-dir <PACKAGE_DIR>/main/default/classesReplace class body with invocable pattern from Design & Agent Spec. ALWAYS deploy:sf project deploy start --json --metadata ApexClass:<ClassName>ALWAYS fix deploy errors BEFORE generating and deploying next stub. - Validate behavior — Read Validation & Debugging for preview workflow and session trace analysis.
If Step 3b provisioned an ADL, before sending any grounded test utterances confirm the library is queryable: run
sf agent adl get -i $LIBRARY_IDand check thatretrieverIdis present (Data Library Reference, Step 6). If still null, wait and re-poll — do not preview yet, the agent will return emptyknowledgeSummaryand the anti-hallucination guard will refuse on every utterance.sf agent preview start --json --use-live-actions --authoring-bundle <Developer_Name>If actions query data, ground test utterances with:sf data query --json -q "SELECT <Relevant_Fields> FROM <SObject> LIMIT 100"Send test utterances with:sf agent preview send --json --authoring-bundle <Developer_Name> --session-id <ID> -u "<message>"Smoke testing requirements (see Validation & Debugging, Utterance Derivation):- Test ALL routing branches, not just the happy path. Multiple phrasings per branch.
- Use realistic utterances — write what a human would actually type, not keywords.
- After EVERY utterance, read the trace to confirm actions actually fired (
FunctionStep). Do not trust the agent's text response alone — agents can claim they performed actions without calling them. - Evaluate against the Agent Spec like a human tester: check conversation flow, instruction adherence, unnecessary repetition, and response quality. If the spec says "confirm once" and the agent confirms twice, that's a bug — fix it.
If behavior diverges from the Agent Spec, fix the
.agentfile and re-preview. For complex issues, switch to Diagnose Behavioral Issues workflow. Return AFTER correcting issues. CHECKPOINT — Stay in draft iteration unless user explicitly asks to release. If user requests release, do NOT proceed to Publish unless ALL are true: validate authoring-bundlepasses with zero errors- Live preview (
--use-live-actions) tested with realistic utterances covering all routing branches - Traces confirm correct subagent routing, action invocation (
FunctionSteppresent), and spec-compliant behavior - User explicitly approves deployment
- If the agent has a
knowledge:block: the Einstein Agent User has a Data Cloud permset/PSL assigned. Verify both:
One ofsf data query --json -q "SELECT PermissionSet.Name FROM PermissionSetAssignment WHERE Assignee.Username='<agent_user>'" sf data query --json -q "SELECT PermissionSetLicense.DeveloperName FROM PermissionSetLicenseAssign WHERE Assignee.Username='<agent_user>'"GenieDataPlatformStarterPsl,GenieUserEnhancedSecurity,DataCloudUser, orDataCloudArchitectmust appear in the combined results. If none does, run Agent User Setup, Step 3b discovery-then-assign and re-verify before proceeding. If a Data Cloud permset is assigned but a smoke-test grounded query returns emptyknowledgeSummary, the Data Space scope also needs to be granted on that permset — UI-only, see Agent User Setup, Step 3b.4.
- Publish (explicit release step) — Only after the user confirms they are ready to commit this draft to metadata. Publish validates metadata structure, not agent behavior. Every publish creates permanent version number.
sf agent publish authoring-bundle --json --api-name <Developer_Name>If publish fails, follow troubleshooting checklist in Metadata & Lifecycle, Section 5 before retrying. - Activate (explicit release step) — Makes new version available to users after publish.
sf agent activate --json --api-name <Developer_Name> - Verify published agent — Preview user-facing behavior AFTER activation with
sf agent preview start --json --api-name <Developer_Name>Use--api-name, not--authoring-bundle. - Configure end-user access — ONLY for employee agents. Read Agent Access Guide to configure perms and assign access.
Reference Files
- CLI for Agents — exact command syntax for generate, validate, deploy, publish, activate; Section 12 for Einstein Agent User creation
- Core Language — execution model, syntax, block structure, anti-patterns
- Design & Agent Spec — subagent graph design, flow control patterns, Agent Spec production, action implementation analysis; Section 3 for environment prerequisites
- Subagent Map Diagrams — Mermaid diagram conventions for visualizing the agent's subagent graph
- Posture & Determinism — default agentic posture, deterministic controls with cause
- Agent User Setup & Permissions — permission set assignment, object permissions, cross-subagent validation
- Metadata & Lifecycle — directory structure, bundle metadata; publish troubleshooting
- Validation & Debugging — validate the agent compiles, preview to confirm behavior
- Agent Access Guide — end-user access permissions, visibility troubleshooting
- Known Issues — only load when errors persist after code fixes
- Patterns by Requirement — scenario-to-pattern mapping for architecture and flow choices
- Architecture Patterns — router-first mechanics, verification gates, workflow-local linear patterns
- Complex Data Types — type mapping decision tree
- Safety Review — 7-category safety review
- Discover Reference — target discovery CLI
- Scaffold Reference — stub generation CLI
- Deploy Reference — deployment lifecycle, error recovery
- Data Library Reference — provision a SFDRIVE Agentforce Data Library and wire it into the
.agentvia theknowledge:block +AnswerQuestionsWithKnowledgeaction
Comprehend an Existing Agent
User wants to understand Agent Script agent they didn't write or need to revisit. May point to AiAuthoringBundle directory or ask "what does this agent do?" or "I need to fix this agent but I don't understand how it works.".
Required Steps
- Locate agent — Read
sfdx-project.jsonto identify package directories. FindAiAuthoringBundledirectory within them. Read.agentfile andbundle-meta.xml. - Read code — Read Core Language for syntax and execution model BEFORE parsing
.agentfile. - Map action implementations — For each action with
target, locate implementation (Apex class, Flow, Prompt Template) in project. Note input/output contracts. - Reverse-engineer Agent Spec — Read Design & Agent Spec for Agent Spec structure. Produce Agent Spec from code and save as file.
- Produce Subagent Map diagram — Read Subagent Map Diagrams for Mermaid conventions. Generate flowchart of subagent graph showing transitions, gates, and action associations.
- Annotate source — Ask if user wants Agent Script source annotated with explanations. If requested, add inline comments to
.agentfile explaining flow control decisions, gating rationale, and subagent relationships. - Present to user — Share Agent Spec, Subagent Map, and annotated source if produced. Check Anti-Patterns section in Core Language reference and flag any matches found in code.
Reference Files
- Core Language — syntax, execution model, anti-patterns
- Design & Agent Spec — Agent Spec structure, flow control pattern recognition
- Subagent Map Diagrams — Mermaid conventions for subagent graph visualization
- Metadata & Lifecycle — directory conventions, bundle metadata
- Known Issues — only load when code contains unexplained workaround patterns
Modify an Existing Agent
User wants to add, remove, or change subagents, actions, instructions, or flow control on existing agent. May describe change in plain language ("add a billing subagent") or reference specific Agent Script constructs.
Required Steps
Read CLI for Agents for exact command syntax.
- Comprehend — If no Agent Spec exists, reverse-engineer first by following "Comprehend an Existing Agent" workflow above.
- Update Agent Spec — Read Design & Agent Spec for flow control patterns and existing action analysis. Modify Agent Spec to reflect intended changes. Default new actions to
NEEDS STUBplaceholders. Ask the user which path they want:- Path A: Keep placeholders only
- Path B: Scan for existing actions to reuse
- Path C: Generate new actions Only run scans if the user explicitly chooses Path B or C. If the modification involves adding, replacing, or removing knowledge grounding, ask: "Will this agent answer questions from a document corpus (PDF/DOCX/TXT)? If so, what file path?" Capture the path in the updated Spec under a "Knowledge Grounding" section. Asking now — during Spec update — surfaces ADL changes for the user's approval and lets us kick off provisioning right after. Always save updated Agent Spec as file.
- STOP for user approval of updated Agent Spec. Present to user (including the Knowledge Grounding section if present). Ask for approval or feedback. Do not proceed without approval. Once approved, proceed without stopping unless a step fails.
- Kick off ADL provisioning (only if the Spec has a Knowledge Grounding section).
- If the
.agentalready has aknowledge:block with a populatedrag_feature_config_idAND the user is keeping the same library, reuse it. Skip provisioning. (No need to confirmretrieverIdhere — that gate moves to Step 8.) - If a new ADL is needed, follow the same flow as the create workflow: read Data Library Reference, run the Step 0 preflight (
sf agent adl list), and (if DC is ready) runsf agent adl create(Step 1) to capturelibraryId. Computerag_feature_config_id = "ARFPC_<libraryId>"fromlibraryIdalone — that's enough to author the bundle. Start the upload + indexing flow (reference Steps 2–6) in the background while you continue to Step 5 (Edit code). Per Rule 5, do not block on async indexing. Also kick off the Data Cloud permset assignment for the agent user — see Agent User Setup, Step 3b, which now ends with Step 3b.5 pinned post-assignment verification (against the resolved running-user and Einstein Agent User IDs) so callers can treat "Step 3b passed" as an authoritative Data Cloud grounding gate without re-running inline SOQL. - If grounding is not part of the modification, skip this step.
- If the
- Edit code — Read Core Language for syntax and anti-patterns. Edit
.agentfile to implement approved changes. If Step 4 produced alibraryId, include or update theknowledge:block and theAnswerQuestionsWithKnowledgeaction per Data Library Reference. - Validate compilation —
sf agent validate authoring-bundle --json --api-name <Developer_Name>If validation fails, read Validation & Debugging to diagnose and fix, then re-validate. - Generate new action implementations (explicit user-requested path only) — Only run this step if the user explicitly asked to generate new implementations (Path C in Step 2). For each new action marked NEEDS STUB:
sf template generate apex class --name <ClassName> --output-dir <PACKAGE_DIR>/main/default/classesReplace class body with invocable pattern from Design & Agent Spec. ALWAYS deploy:sf project deploy start --json --metadata ApexClass:<ClassName>ALWAYS fix deploy errors BEFORE generating and deploying next stub. Skip if no new actions added. - Validate behavior — Read Validation & Debugging for preview workflow and session trace analysis.
If Step 4 provisioned a new ADL, before sending any grounded test utterances confirm the library is queryable: run
sf agent adl get -i $LIBRARY_IDand check thatretrieverIdis present (Data Library Reference, Step 6). If still null, wait and re-poll — do not preview yet, the agent will return emptyknowledgeSummaryand the anti-hallucination guard will refuse on every utterance.sf agent preview start --json --use-live-actions --authoring-bundle <Developer_Name>If actions query data, ground test utterances with:sf data query --json -q "SELECT <Relevant_Fields> FROM <SObject> LIMIT 100"Send test utterances with:sf agent preview send --json --authoring-bundle <Developer_Name> --session-id <ID> -u "<message>"Smoke testing requirements (see Validation & Debugging, Utterance Derivation):- Test changed paths first, then adjacent paths to catch regressions.
- Test ALL routing branches affected by the change. Multiple phrasings per branch.
- Use realistic utterances — write what a human would actually type, not keywords.
- After EVERY utterance, read the trace to confirm actions actually fired (
FunctionStep). Do not trust the agent's text response alone. - Evaluate against the Agent Spec: conversation flow, instruction adherence, unnecessary repetition, response quality.
If behavior diverges from the Agent Spec, fix the
.agentfile and re-preview. For complex issues, switch to Diagnose Behavioral Issues workflow. CHECKPOINT — Stay in draft iteration unless user explicitly asks to release. If user requests release, do NOT proceed to Publish unless ALL are true: validate authoring-bundlepasses with zero errors- Live preview (
--use-live-actions) tested with realistic utterances covering all routing branches - Traces confirm correct subagent routing, action invocation (
FunctionSteppresent), and spec-compliant behavior - User explicitly approves deployment
- If the agent has a
knowledge:block: the Einstein Agent User has a Data Cloud permset/PSL assigned. Verify both:
One ofsf data query --json -q "SELECT PermissionSet.Name FROM PermissionSetAssignment WHERE Assignee.Username='<agent_user>'" sf data query --json -q "SELECT PermissionSetLicense.DeveloperName FROM PermissionSetLicenseAssign WHERE Assignee.Username='<agent_user>'"GenieDataPlatformStarterPsl,GenieUserEnhancedSecurity,DataCloudUser, orDataCloudArchitectmust appear in the combined results. If none does, run Agent User Setup, Step 3b discovery-then-assign and re-verify before proceeding. If a Data Cloud permset is assigned but a smoke-test grounded query returns emptyknowledgeSummary, the Data Space scope also needs to be granted on that permset — UI-only, see Agent User Setup, Step 3b.4.
- Publish (explicit release step) — Only after the user confirms they are ready to commit this draft to metadata. Publish validates metadata structure, not agent behavior. Every publish creates permanent version number.
sf agent publish authoring-bundle --json --api-name <Developer_Name>If publish fails, follow troubleshooting checklist in Metadata & Lifecycle, Section 5 before retrying. - Activate (explicit release step) — Makes new version available to users after publish.
sf agent activate --json --api-name <Developer_Name> - Verify published agent — Preview user-facing behavior AFTER activation with
sf agent preview start --json --api-name <Developer_Name>Use--api-name, not--authoring-bundle.
Reference Files
- CLI for Agents — exact command syntax for validate, deploy, preview, publish, activate
- Core Language — syntax, anti-patterns
- Design & Agent Spec — Agent Spec updates, action implementation analysis
- Validation & Debugging — compilation diagnosis, preview workflow, session trace analysis
- Data Library Reference — provisioning and Agent Script wiring for ADL grounding
- Known Issues — only load when errors persist after code fixes
Diagnose Compilation Errors
User has Agent Script that won't compile. Errors surface from sf agent validate or sf agent preview start, or User describes symptoms like "I'm getting a validation error."
Required Steps
Read CLI for Agents for exact command syntax.
- Capture concrete errors first, then reproduce — If the user already shared error output, extract and list the exact error messages first. Then run
sf agent validate authoring-bundle --json --api-name <Developer_Name>to capture basic compile errors. If no errors, runsf agent preview start --json --use-live-actions --authoring-bundle <Developer_Name>to capture complex compile errors. If reproduction differs from user-provided errors, call out both and continue with the current reproducible errors. - Classify error — Read Validation & Debugging for error taxonomy. Map each exact error message to a root cause category.
- Locate fault — Read Core Language to understand correct syntax. Find specific line(s) in
.agentfile that cause each error. - Fix code — Apply targeted fixes. Check Anti-Patterns section in Core Language reference to ensure you're not introducing known bad pattern.
- Re-validate — Run
sf agent validate authoring-bundle --json --api-name <Developer_Name>then runsf agent preview start --json --use-live-actions --authoring-bundle <Developer_Name>Repeat steps 2–5 if errors persist. - Explain fix — Tell user what was wrong and what you changed. Explain root cause in terms of Core Language agent execution model.
Reference Files
- Core Language — syntax, block structure, anti-patterns
- Validation & Debugging — error taxonomy, error-to-root-cause mapping
- Known Issues — only load when error doesn't match user code; may be a platform bug
- Production Gotchas — only load when error involves reserved keywords or lifecycle hook syntax
Diagnose Behavioral Issues
Agent compiles, preview can start and --use-live-actions, but agent does not behave as expected. User describes symptoms like "the agent keeps going to the wrong subagent" or "the action isn't being called." Fundamentally different from validate or preview start errors — code is valid but behavior is wrong.
Required Steps
Read CLI for Agents for exact command syntax.
- Establish baseline — Read Agent Spec. If no Agent Spec exists, follow Comprehend an Existing Agent workflow to reverse-engineer one, then continue.
- Form hypotheses — Read Core Language for execution model. Based on user's description, list candidate root causes. Think through: subagent routing, gating conditions, action availability, instruction clarity, variable state, and transition timing.
- Reproduce in preview — Read Validation & Debugging for preview workflow and session trace analysis. Start preview session:
sf agent preview start --json --use-live-actions --authoring-bundle <Developer_Name>then send test messages covering EACH subagent withsf agent preview send. One message is not enough — confirm behavior per subagent before proceeding. - Analyze session traces — Examine trace output to confirm subagent selection, action availability/execution, LLM reasoning, and where behavior diverges from Agent Spec. Do NOT skip this step — preview output alone is insufficient for diagnosis.
- Identify root cause — Match trace evidence to hypotheses. Consult Core Language reference and Gating Patterns in Design & Agent Spec reference to confirm absence of anti-patterns.
- Fix code — Apply targeted fix. If fix involves flow control changes, update Agent Spec to match.
- Re-validate and re-preview — Repeat steps 3–6 until behavior matches Agent Spec or you confirm a platform limitation. Run
validate authoring-bundle, thenpreview start --use-live-actionsto verify fix using same utterances. Then test adjacent paths that might be affected by your changes. - Explain fix — Tell user what was wrong and what you changed. Explain root cause in terms of Core Language agent execution model.
Reference Files
- Core Language — execution model, anti-patterns
- Design & Agent Spec — Agent Spec as behavioral baseline, gating patterns
- Validation & Debugging — preview workflow, session trace analysis
- Known Issues — only load when behavior is wrong but code logic is correct
Deploy, Publish, and Activate
User wants to take working agent from local development to running state in Salesforce org. Involves deploying AiAuthoringBundle and its dependencies, publishing to commit version, then activating to make it live.
Required Steps
Read CLI for Agents for exact command syntax.
- Validate compilation —
sf agent validate authoring-bundle --json --api-name <Developer_Name>Do not proceed if validation fails. - Deploy bundle and dependencies — Read Metadata & Lifecycle for dependency management and deploy commands. Deploy
AiAuthoringBundleand all action implementations (Apex classes, Flows, Prompt Templates) and dependencies to org. - Live preview — Read Validation & Debugging for preview workflow and session trace analysis.
sf agent preview start --json --use-live-actions --authoring-bundle <Developer_Name>then send test utterances with:sf agent preview send --json --authoring-bundle <Developer_Name> --session-id <ID> -u "<message>"Test key conversation paths to validate agent behavior when backed by live actions. CHECKPOINT — Do NOT proceed to Publish unless ALL are true:validate authoring-bundlepasses with zero errors- Live preview (
--use-live-actions) tested with realistic utterances covering all routing branches - Traces confirm correct subagent routing, action invocation (
FunctionSteppresent), and spec-compliant behavior - User expli
…(truncated)