SF API Topic and Action Enablement

operation-must-have-descriptions

general > operation-must-have-descriptions


Guidance / Message

API operations enabled as agent actions must have a description longer than 10 characters

Examples

valid

get:
  operationId: get-operation
  description: "this is an accurate description"
  x-sfdc:
    agent:
      action:
        publishAsAgentAction: true

invalid

get:
  operationId: get-operation
  description: short
  x-sfdc:
    agent:
      action:
        publishAsAgentAction: true

Applies to Operation

Constraint

Type: Declarative Validation
TypeRuleset
OrganizationMuleSoft
Published by
Mulesoft Organization
Published onOct 26, 2026
Asset overview

Asset versions for 1.2.x

Asset versions
VersionActions
1.2.0

Tags