AuralisDocs
Tools reference

Macros and canned replies

Use and create the desk's macros and approved reply snippets.

With these tools an assistant can reply in the wording your team has agreed, run a macro on a ticket in one step, and save new macros and reply snippets for the team to reuse.

ToolWhat it doesRole neededChanges data?
list_macrosLists every macro with its actions, and whether it also fires automaticallyviewerread-only
apply_macroRuns a macro's actions against a ticket as one stepeditordestructive
create_macroCreates a manual macro from a list of actionseditoradds
list_canned_responsesLists the desk's approved reply snippetsviewerread-only
create_canned_responseSaves a reusable reply snippet, optionally with a shortcuteditoradds

Source: _TOOLS in services/runtime/src/runtime/mcp/tools.py, handlers _list_macros, _apply_macro, _create_macro, _list_canned_responses and _create_canned_response.

list_macros, apply_macro and list_canned_responses send the client no read-only or destructive hint. Their entries describe what each handler does.

apply_macro

  • Inputs: macro_id and ticket_id.
  • Runs every action in the macro: for example, it sends the macro's reply and sets the status it names. A reply it sends goes to the customer.
  • Refusals: a disabled or unknown macro, and a ticket you cannot see.

Source: _apply_macro in services/runtime/src/runtime/mcp/tools.py.

create_macro

  • Inputs: name (1 to 120 characters) and actions are required. description is optional, up to 500 characters.
  • actions is a list of 1 to 10 items. Each has a kind and, where the kind needs one, a body or a value. kind is one of reply, internal_note, set_status, set_priority, add_tag, assign_agent, route_team or escalate.
  • An item with any other key is refused, and the refusal names the key.
  • A macro created here is always manual: it runs only when someone applies it. Automatic triggers cannot be set over MCP.
  • Returns the new macro as list_macros shows it.

Source: _create_macro, _macro_actions and _MACRO_ACTION_KINDS in services/runtime/src/runtime/mcp/tools.py.

list_canned_responses

No inputs beyond workspace_id. When a snippet fits, an assistant should use its wording rather than write its own, because it is what the team has agreed to say.

create_canned_response

  • Inputs: title (1 to 200 characters) and body (1 to 10,000) are required. shortcut is optional, up to 60 characters.
  • Returns the saved snippet.

Source: _create_canned_response in services/runtime/src/runtime/mcp/tools.py.

On this page