Skip to main content

Conversations

MCP tools for the Conversations module. See the Conversations module docs for permissions and data model.

list-conversations

List conversations

Arguments

ArgumentTypeRequiredDescription
project_idstringnoProject ID (optional)
actor_idstringnoFilter by actor ID
limitnumbernoMaximum number of results to return
offsetnumbernoNumber of results to skip

create-conversation

Create a conversation

Arguments

ArgumentTypeRequiredDescription
project_idstringnoProject ID. Required for JWT auth; omit when using an project key.
statusstringnoInitial conversation status
namestring | nullnoOptional name for the conversation
actor_idstring | nullnoActor ID to associate with this conversation

get-conversation

Get a conversation by ID

Arguments

ArgumentTypeRequiredDescription
conversation_idstringyesConversation ID

update-conversation

Update a conversation

Arguments

ArgumentTypeRequiredDescription
conversation_idstringyesConversation ID
statusstringnoNew conversation status
namestring | nullnoNew conversation name

delete-conversation

Delete a conversation

Arguments

ArgumentTypeRequiredDescription
conversation_idstringyesConversation ID

list-conversation-messages

List conversation messages

Arguments

ArgumentTypeRequiredDescription
conversation_idstringyesConversation ID
limitnumbernoMaximum number of results to return
offsetnumbernoNumber of results to skip

add-conversation-message

Add a message to a conversation

Arguments

ArgumentTypeRequiredDescription
conversation_idstringyesConversation ID
messagestringyesMessage text content to add to the conversation
rolestringyesRole of the message sender
actor_idstring | nullnoOptional actor ID to associate with this message (user identity)
positionnumbernoZero-based position. Defaults to MAX+1 (append).
metadataobject | nullnoOptional structured metadata to attach to the message (e.g. phone number, channel). Stored as-is and injected into the AI prompt context.

generate-conversation-message

Generate the next message in a conversation

Arguments

ArgumentTypeRequiredDescription
conversation_idstringyes
waitbooleannoWhen omitted or false (default), the generation runs in the background and 202 Accepted is returned immediately. Pass true to block until the generation settles and receive the result. A builtin tool call always waits.
agent_idstringyesID of the agent that will produce the next message.
modelstringnoOptional model override.
streambooleannoIf true, stream tokens via SSE. NOT IMPLEMENTED in v1 — returns 501.
tool_contextobject | nullnoKey-value pairs forwarded as X-Soat-Context-<key> headers on every http, mcp and builtin tool call in this generation. The header name is the deployment's configured context prefix (X-Soat-Context- by default) plus the key verbatim — no character is re-cased and keys are never case-converted, so they round-trip exactly as sent. An invalid or colliding key is rejected with 400 INVALID_TOOL_CONTEXT_KEY.

remove-conversation-message

Remove a message from a conversation

Arguments

ArgumentTypeRequiredDescription
conversation_idstringyesConversation ID
document_idstringyesDocument ID

get-conversation-tags

Get conversation tags

Arguments

ArgumentTypeRequiredDescription
conversation_idstringyesConversation ID

replace-conversation-tags

Replace conversation tags

Arguments

ArgumentTypeRequiredDescription
conversation_idstringyesConversation ID

merge-conversation-tags

Merge conversation tags

Arguments

ArgumentTypeRequiredDescription
conversation_idstringyesConversation ID