Skip to main content

Actors

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

list-actors

List actors

Arguments

ArgumentTypeRequiredDescription
projectIdstringnoProject ID (optional)
externalIdstringnoExternal ID to filter by (e.g. WhatsApp phone number)
agentIdstringnoReturn only actors linked to this agent
chatIdstringnoReturn only actors linked to this chat
conversationIdstringnoReturn only actors that participate in this conversation (derived from the conversation's messages).
limitnumbernoMaximum number of results to return
offsetnumbernoNumber of results to skip

create-actor

Create an actor

Arguments

ArgumentTypeRequiredDescription
projectIdstringnoProject ID. Required for JWT auth; omit when using an project key.
namestringyes
externalIdstringnoOptional external identifier (e.g. WhatsApp phone number). If provided and an actor with this externalId already exists in the project, the existing actor is returned (idempotent — 200 OK).
instructionsstringnoPersona-specific instructions composed into the effective system prompt during conversation generation.
agentIdstringnoAgent to link this actor to. Mutually exclusive with chat_id.
chatIdstringnoChat to link this actor to. Mutually exclusive with agent_id.
memoryIdstringnoMemory ID to link to this actor. Mutually exclusive with auto_create_memory.
autoCreateMemorybooleannoWhen true, automatically creates a new memory container for this actor and links it. Ignored if memory_id is set. With external_id (idempotent), memory is only created on first creation.

get-actor

Get an actor by ID

Arguments

ArgumentTypeRequiredDescription
actorIdstringyesActor ID

delete-actor

Delete an actor

Arguments

ArgumentTypeRequiredDescription
actorIdstringyesActor ID

update-actor

Update an actor

Arguments

ArgumentTypeRequiredDescription
actorIdstringyesActor ID
namestringno
externalIdstringnoExternal identifier (e.g. WhatsApp phone number)
instructionsstringnoPersona-specific instructions
agentIdstringnoAgent to link this actor to. Mutually exclusive with chat_id.
chatIdstringnoChat to link this actor to. Mutually exclusive with agent_id.
memoryIdstringnoMemory ID to link to this actor. Set to null to unlink.
tagsobjectno

get-actor-tags

Get actor tags

Arguments

ArgumentTypeRequiredDescription
actorIdstringyesActor ID

replace-actor-tags

Replace actor tags

Arguments

ArgumentTypeRequiredDescription
actorIdstringyesActor ID

merge-actor-tags

Merge actor tags

Arguments

ArgumentTypeRequiredDescription
actorIdstringyesActor ID