mirror of
https://github.com/forcedotcom/afv-library.git
synced 2026-07-30 11:43:26 +08:00
261abd679a
* @W-21955450@ Rename topic to subagent for Agent Script v2
Aligns with Agent Script v2 naming standards where `topic` is renamed
to `subagent` across all skill documentation and templates.
Changes:
- Agent Script templates: topic keyword → subagent keyword
- References: @topic.* → @subagent.*
- Documentation: Updated all skill references and guides
- Natural language references preserved in comments/descriptions
* Rename start_agent topic_selector to agent_router
Completes the topic → subagent terminology alignment by:
1. Renaming start_agent from topic_selector to agent_router (15 agent files)
2. Updating template topic declarations: topic {{placeholder}} → subagent {{placeholder}} (5 files)
3. Updating all @subagent.topic_selector references to @subagent.agent_router (35 occurrences)
4. Updating documentation: prose, examples, and diagrams (10 markdown files)
5. Updating comments to use agent_router terminology
Files affected:
- 22 agent template files
- 10 documentation/reference markdown files
- Template component files
The agent_router name is more descriptive of its actual function
(routing to different subagents) and completes the Agent Script v2
terminology standardization.
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
* Rename files with "topic" to use "subagent" terminology
Completes the topic → subagent terminology alignment by renaming
files and updating all references:
**Files renamed (5):**
- multi-topic.agent → multi-subagent.agent
- template-single-topic.agent → template-single-subagent.agent
- template-multi-topic.agent → template-multi-subagent.agent
- topic-with-actions.agent → subagent-with-actions.agent
- agent-topic-map-diagrams.md → agent-subagent-map-diagrams.md
**References updated (6 docs):**
- Updated all filename references to point to new filenames
- Updated "Topic Map" → "Subagent Map" throughout documentation
- Updated "multi-topic"/"single-topic" → "multi-subagent"/"single-subagent"
Files modified:
- README.md, SKILL.md, agent-spec-template.md
- assets/agents/README.md, assets/README-legacy.md
- references/agent-design-and-spec-creation.md
This ensures consistent "subagent" terminology across filenames,
file content, and all documentation references.
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
* Complete topic-to-subagent terminology update across skills
Comprehensive update replacing "topic" with "subagent" terminology throughout
the developing-agentforce and testing-agentforce skills to align with Agent
Script's `subagent` block naming.
Key changes:
- "Topic Selector" → "Subagent Router" in all agent templates and docs
- "Topic/action" → "Subagent/action" in documentation
- "Topic map" → "Subagent map" in diagram references
- Updated all architecture documentation to use "subagent" terminology
- Updated 19 .agent template files with new labels and comments
- Updated 8 reference documentation files with consistent terminology
API contract preservation:
- Test spec YAML files preserve "topic" terminology to match Testing Center API
- Added clarifying comments explaining topic/subagent equivalence in YAML files
- Field names like `expectedTopic` unchanged (Salesforce API requirement)
Preserved terms:
- "off-topic" (standard phrase for out-of-scope)
- "expectedTopic" field (Testing Center API)
- "platform topics" (Salesforce guardrail features)
32 files changed, 379 insertions(+), 366 deletions(-)
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
* Complete comprehensive topic-to-subagent terminology update
Thorough update replacing all remaining "topic" references with "subagent"
terminology across developing-agentforce, testing-agentforce, and
observing-agentforce skills to fully align with Agent Script's `subagent`
block naming.
Key changes:
- Agent Script syntax: @topic.<name> → @subagent.<name>
- Agent Script syntax: topic.actions → subagent.actions
- Shell script patterns: ^topic → ^subagent
- Documentation: "topic instructions" → "subagent instructions"
- observing-agentforce skill: Updated all agent architecture references
- Template files: Updated all inline comments and descriptions
- Variable names in scripts: TOPIC → SUBAGENT
Specific updates:
- 45 files changed, 294 insertions, 294 deletions
- Updated all Agent Script code examples to use @subagent syntax
- Updated observing-agentforce issue classification guide
- Updated shell script patterns in diagnostic tools
- Updated Apex comments to clarify topic field maps to subagents
Preserved (as required):
- "off-topic" and "off_topic" (standard out-of-scope phrase)
- Testing Center API fields: expectedTopic, topic: in YAML
- API response fields: .topic, generatedData.topic, topic_assertion
- STDM field names: ssot__TopicApiName__c (with clarifying docs)
- Template placeholders in test specs (API values)
- "Topic hash drift" (API field behavior)
- "Email topic/purpose" (means email subject)
- Explanatory comments about API field mapping
All Agent Script syntax and documentation now consistently uses "subagent"
while preserving backward compatibility with platform API field names.
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
* a few more topic -> subagent replacements
---------
Co-authored-by: Steve Hetzel <shetzel@salesforce.com>
Co-authored-by: Claude Sonnet 4.5 <noreply@anthropic.com>
91 lines
3.2 KiB
Markdown
91 lines
3.2 KiB
Markdown
# Agent Spec: Agent_API_Name
|
|
|
|
## Purpose & Scope
|
|
|
|
Describe the agent's purpose in 1-2 sentences. What does it help users do?
|
|
What domain does it operate in?
|
|
|
|
## Behavioral Intent
|
|
|
|
Describe the key behavioral rules that govern the agent:
|
|
- What must the agent know before taking action?
|
|
- What backing logic types are used (Apex, Flow, Prompt Template)?
|
|
- What guardrails apply (off-topic handling, escalation)?
|
|
- What information persists across subagent switches?
|
|
|
|
## Subagent Map
|
|
|
|
```mermaid
|
|
%%{init: {'theme':'neutral'}}%%
|
|
graph TD
|
|
A[start_agent<br/>agent_router]
|
|
|
|
A -->|description of routing condition| B[subagent_name<br/>Subagent]
|
|
A -->|unclear intent| C[ambiguous_question<br/>Subagent]
|
|
A -->|out of scope| D[off_topic<br/>Subagent]
|
|
A -->|needs escalation| E[escalation<br/>Subagent]
|
|
```
|
|
|
|
Expand the diagram to show actions, gating logic, and variable state changes
|
|
within each subagent. See the Subagent Map Diagrams reference for conventions.
|
|
|
|
## Variables
|
|
|
|
- `variable_name` (mutable type = default) — What this variable tracks.
|
|
Set by: which action or utility. Read by: which topics for gating or
|
|
conditional instructions.
|
|
|
|
## Actions & Backing Logic
|
|
|
|
### action_name (subagent_name subagent)
|
|
|
|
- **Target:** `apex://ClassName` or `flow://FlowName` or `prompt://PromptTemplateName`
|
|
- **Backing Status:** EXISTS / NEEDS STUB / NEEDS IMPLEMENTATION
|
|
|
|
#### Inputs
|
|
|
|
| Name | Type | Required | Source |
|
|
|------|------|----------|--------|
|
|
| property_id | string | Yes | User input |
|
|
| max_results | integer | No | Defaults to 10 |
|
|
|
|
#### Outputs
|
|
|
|
| Name | Type | Visible to User? | Source | Notes |
|
|
|------|------|-------------------|--------|-------|
|
|
| property | object | Yes | `Property__c` | Complete property details |
|
|
| related_applications | list[object] | Yes | `Application__c` | Records for this property |
|
|
| active_listing | boolean | Yes | `Listing__c` | Listing status |
|
|
| hasData | boolean | No | Computed | Internal empty-result flag |
|
|
|
|
> **"Visible to User?"** maps to `filter_from_agent` in the `.agent` file: Yes → `filter_from_agent: False`, No → `filter_from_agent: True`.
|
|
|
|
#### Stubbing Requirement
|
|
|
|
If NEEDS STUB:
|
|
|
|
- Apex class name and inner class wrappers needed
|
|
- `complex_data_type_name` for each `object`/`list[object]` output
|
|
- Key queries or computation logic the stub must implement
|
|
|
|
Repeat for each action.
|
|
|
|
## Gating Logic
|
|
|
|
- `action_name` visibility: `available when @variables.variable_name != ""`
|
|
— Rationale for why this gate exists.
|
|
|
|
List all gating conditions with their rationale.
|
|
|
|
## Architecture Pattern
|
|
|
|
State the architecture pattern: hub-and-spoke, chain, hybrid, etc.
|
|
Describe the routing strategy and how topics relate to each other.
|
|
|
|
## Agent Configuration
|
|
|
|
- **developer_name:** `Agent_API_Name`
|
|
- **agent_label:** `Agent Display Name`
|
|
- **agent_type:** `AgentforceEmployeeAgent` or `AgentforceServiceAgent` — state the reasoning based on prompt signals (e.g., "accessible by employees" → Employee, "customer-facing channel" → Service)
|
|
- **default_agent_user:** Required for `AgentforceServiceAgent`. Forbidden for `AgentforceEmployeeAgent`. If specified, MUST be **user name**. MUST NEVER be **user ID**. User MUST have `Einstein Agent` license.
|