Skip to main content

Chats

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

create-chat

Create a chat

Arguments

ArgumentTypeRequiredDescription
ai_provider_idstringnoPublic ID of the AI provider to pin. Optional: omit it to inherit the project's default_model_route_id, which gives the chat provider failover. Omitting it returns 400 when the project has no default, and cannot be combined with model — each route target names its own.
project_idstringnoPublic ID of the project. Required when the user belongs to multiple projects and no project key is used.
namestringnoOptional human-readable name
instructionsstringnoOptional system message applied to all completions on this chat
modelstringnoOptional default model override

list-chats

List chats

Arguments

ArgumentTypeRequiredDescription
project_idstringnoProject public ID to filter by
limitnumbernoMaximum number of results to return
offsetnumbernoNumber of results to skip

get-chat

Get a chat

Arguments

ArgumentTypeRequiredDescription
chat_idstringyes

delete-chat

Delete a chat

Arguments

ArgumentTypeRequiredDescription
chat_idstringyes

create-chat-completion

Create a chat completion

Arguments

ArgumentTypeRequiredDescription
ai_provider_idstringnoPublic ID of the AI provider to run the completion against. Mutually exclusive with chat_id; exactly one of the two is required.
chat_idstringnoPublic ID of a stored chat supplying the provider, model and instructions. Mutually exclusive with ai_provider_id; exactly one of the two is required.
modelstringnoModel identifier. Overrides the provider's default_model, or the chat's model, when specified.
instructionsstringnoSystem instructions for this call. Sent to the provider as its instructions argument rather than as a message, which is the only place the AI SDK accepts system content (allowSystemInMessages defaults to false). This field is the only channel — a role: "system" entry in messages is refused with 400 SYSTEM_MESSAGE_NOT_ALLOWED. With chat_id, this replaces the chat's stored instructions for this call only; the stored value applies when the request carries none, and the two are never merged.
messagesarray<object>yesOrdered list of chat messages
streambooleannoWhen true the response is an SSE stream of delta chunks. When false (default) a single JSON object is returned.