Skip to main content

Canonical Vocabulary

The AXAG canonical vocabulary defines all reserved attribute names, their types, allowed values, and semantic meaning.

Reserved Attribute Prefix

The prefix axag- is reserved for AXAG annotations. Implementations MUST NOT use this prefix for non-AXAG purposes.

Identity Attributes

AttributeTypeDescription
axag-intentstringSemantic intent in entity.verb format
axag-entitystringDomain entity being operated on
axag-action-typeenumOperation classification
axag-descriptionstringHuman-readable description
axag-operation-idstringUnique operation identifier

Parameter Attributes

AttributeTypeDescription
axag-required-parametersstring[]JSON array of required parameter names
axag-optional-parametersstring[]JSON array of optional parameter names
axag-parameterstringParameter name (on input elements)
axag-parameter-typestringParameter data type
axag-parameter-requiredbooleanWhether the parameter is required
axag-parameter-descriptionstringParameter description
axag-parameter-formatstringExpected format (email, date, url, etc.)
axag-parameter-enumstring[]Allowed values for enum parameters
axag-parameter-minnumberMinimum value
axag-parameter-maxnumberMaximum value
axag-parameter-patternstringRegex pattern for validation

State Attributes

AttributeTypeDescription
axag-preconditionsstring[]Required state before execution
axag-postconditionsstring[]Guaranteed state after execution
axag-side-effectsstring[]Observable changes beyond primary result

Safety Attributes

AttributeTypeDescription
axag-risk-levelenumnone, low, medium, high, critical
axag-confirmation-requiredbooleanWhether explicit confirmation is needed
axag-confirmation-messagestringMessage to display for confirmation
axag-approval-requiredbooleanWhether multi-party approval is needed
axag-approval-rolesstring[]Roles that can approve
axag-approval-countnumberNumber of approvals required
axag-idempotentbooleanWhether safe to repeat
axag-rate-limitstringMaximum invocation frequency
axag-cooldownstringMinimum time between invocations

Scope Attributes

AttributeTypeDescription
axag-scopestringOperational boundary
axag-tenant-contextstringTenant identifier context
axag-cross-tenantbooleanWhether cross-tenant operation is allowed
axag-required-rolesstring[]Roles permitted to invoke
axag-role-escalationbooleanWhether role escalation is permitted

Visibility Attributes

AttributeTypeDescription
axag-visiblebooleanWhether discoverable by agents
axag-operablebooleanWhether invocable by agents
axag-operability-reasonstringWhy the operation is not operable

Workflow Attributes

AttributeTypeDescription
axag-workflow-idstringWorkflow identifier
axag-workflow-stepnumberStep position in workflow
axag-workflow-total-stepsnumberTotal steps in workflow
axag-workflow-nextstringIntent of next step
axag-workflow-previousstringIntent of previous step

Versioning Attributes

AttributeTypeDescription
axag-versionstringAXAG specification version
axag-deprecatedbooleanWhether this annotation is deprecated
axag-deprecated-replacementstringReplacement intent for deprecated operations
axag-sincestringVersion when this annotation was introduced

Action Type Values

ValueDescription
readNon-mutating data retrieval
createCreates a new entity instance
mutateModifies an existing entity
deleteRemoves an entity
navigateChanges the view or context without data mutation

Risk Level Values

ValueDescriptionTypical Actions
noneNo riskSearch, browse, read
lowEasily reversibleAdd to cart, bookmark
mediumRequires attentionUpdate profile, change settings
highFinancial or data impactProcess payment, submit application
criticalIrreversible, high impactDelete account, purge data

Next Steps