Conversations
MCP tools for the Conversations module. See the Conversations module docs for permissions and data model.
list-conversations
List conversations
Arguments
| Argument | Type | Required | Description |
|---|---|---|---|
projectId | string | no | Project ID (optional) |
actorId | string | no | Filter by actor ID |
limit | number | no | Maximum number of results to return |
offset | number | no | Number of results to skip |
create-conversation
Create a conversation
Arguments
| Argument | Type | Required | Description |
|---|---|---|---|
projectId | string | no | Project ID. Required for JWT auth; omit when using an project key. |
status | string | no | Initial conversation status |
name | string | no | Optional name for the conversation |
actorId | string | no | Actor ID to associate with this conversation |
get-conversation
Get a conversation by ID
Arguments
| Argument | Type | Required | Description |
|---|---|---|---|
conversationId | string | yes | Conversation ID |
update-conversation
Update a conversation
Arguments
| Argument | Type | Required | Description |
|---|---|---|---|
conversationId | string | yes | Conversation ID |
status | string | no | New conversation status |
name | string | no | New conversation name |
delete-conversation
Delete a conversation
Arguments
| Argument | Type | Required | Description |
|---|---|---|---|
conversationId | string | yes | Conversation ID |
list-conversation-messages
List conversation messages
Arguments
| Argument | Type | Required | Description |
|---|---|---|---|
conversationId | string | yes | Conversation ID |
limit | number | no | Maximum number of results to return |
offset | number | no | Number of results to skip |
add-conversation-message
Add a message to a conversation
Arguments
| Argument | Type | Required | Description |
|---|---|---|---|
conversationId | string | yes | Conversation ID |
message | string | yes | Message text content to add to the conversation |
role | string | yes | Role of the message sender |
actorId | string | no | Optional actor ID to associate with this message (user identity) |
position | number | no | Zero-based position. Defaults to MAX+1 (append). |
metadata | object | no | Optional 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
| Argument | Type | Required | Description |
|---|---|---|---|
conversationId | string | yes | — |
agentId | string | yes | ID of the agent that will produce the next message. |
model | string | no | Optional model override. |
stream | boolean | no | If true, stream tokens via SSE. NOT IMPLEMENTED in v1 — returns 501. |
toolContext | object | no | Key-value pairs forwarded as X-Soat-Context-<Key> headers on every http, mcp and soat tool call in this generation. Each key's first character is uppercased and the rest is used verbatim; keys are never case-converted — 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
| Argument | Type | Required | Description |
|---|---|---|---|
conversationId | string | yes | Conversation ID |
documentId | string | yes | Document ID |
get-conversation-tags
Get conversation tags
Arguments
| Argument | Type | Required | Description |
|---|---|---|---|
conversationId | string | yes | Conversation ID |
replace-conversation-tags
Replace conversation tags
Arguments
| Argument | Type | Required | Description |
|---|---|---|---|
conversationId | string | yes | Conversation ID |
merge-conversation-tags
Merge conversation tags
Arguments
| Argument | Type | Required | Description |
|---|---|---|---|
conversationId | string | yes | Conversation ID |