Wire Agent to Topics — Final Step (Create GenAiPlanner)

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Beyond the annotations (readOnlyHint: false, idempotentHint: true, destructiveHint: false), the description discloses the critical behavior that the planner REPLACES any existing planner, and omitting a topic removes it from the agent. This added context is vital for safe use and goes well beyond the annotation metadata.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is front-loaded with the main purpose and step, and each sentence adds value. The synonym list is slightly redundant but helps with keyword matching. Overall, it's efficient and well-structured, though not perfectly minimal.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's complexity, the description covers the purpose, placement in the sequence, the critical replacement behavior, and the completion criterion. With no output schema needed, the description is sufficiently complete for an AI agent to use it correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, and all parameters have detailed descriptions in the schema. The tool description primarily reiterates the same information (e.g., complete list of topics, exact agentName match) without adding new parameter-level meaning beyond what the schema already provides. Therefore, the baseline of 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool creates a GenAiPlanner that connects an Agentforce Agent to its Topics, and identifies it as STEP 4 (FINAL) of the setup sequence. It also lists synonyms to reinforce its role, distinguishing it from sibling steps like sf_create_agent or sf_create_agent_topic.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicitly states when to use: as the final step after topics/actions are created, and warns that without it the agent cannot route any request. Provides clear guidance for modifying an existing agent (include all previous topic names). The instruction to only report completion after this step succeeds is a strong usage directive.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.