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
project_idstringnoProject ID (optional)
external_idstringnoExternal ID to filter by (e.g. WhatsApp phone number)
namestringnoCase-insensitive substring match on the actor name
agent_idstringnoReturn only actors linked to this agent
chat_idstringnoReturn only actors linked to this chat
conversation_idstringnoReturn only actors that participate in this conversation (derived from the conversation's messages).
tagsarraynoFilter by tag pairs, written key:value (split on the first colon, so a value may contain colons). Repeat the parameter for several pairs; all must be present with exactly that value.
limitnumbernoResults per page. Above the maximum it is clamped, and limit in the response reports the page served; below 1 or not an integer it is 400 VALIDATION_FAILED.
offsetnumbernoResults to skip. Negative or not an integer it is 400 VALIDATION_FAILED.

create-actor​

Create an actor

Arguments​

ArgumentTypeRequiredDescription
project_idstringnoProject ID. Required for JWT auth; omit when using an project key.
namestringyes—
external_idstringnoOptional 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).
instructionsstring | nullnoPersona-specific instructions composed into the effective system prompt during conversation generation.
agent_idstringnoAgent to link this actor to. Mutually exclusive with chat_id.
chat_idstringnoChat to link this actor to. Mutually exclusive with agent_id.

get-actor​

Get an actor by ID

Arguments​

ArgumentTypeRequiredDescription
actor_idstringyesActor ID

delete-actor​

Delete an actor

Arguments​

ArgumentTypeRequiredDescription
actor_idstringyesActor ID

update-actor​

Update an actor

Arguments​

ArgumentTypeRequiredDescription
actor_idstringyesActor ID
namestringno—
external_idstringnoExternal identifier (e.g. WhatsApp phone number)
instructionsstringnoPersona-specific instructions
agent_idstring | nullnoAgent to link this actor to. Mutually exclusive with chat_id.
chat_idstring | nullnoChat to link this actor to. Mutually exclusive with agent_id.
tagsanynoKey-value labels on a resource. A flat object of string values — an array, a nested object or a number is rejected with 400 VALIDATION_FAILED, never coerced. Keys are opaque and stored verbatim, so cost_center and costCenter are two different tags. Matched by JSONB containment wherever tags are read: the ?tags= filter, knowledge search, and the IAM soat:ResourceTag/<key> condition. Keys beginning system. are reserved: the platform writes them to record which conversation, actor, agent and role a row came from, and a write naming one is refused with 400 RESERVED_TAG_KEY. They are read and filtered like any other tag. The bag is bounded, because every pair reaches the IAM context of every access check on the resource: at most 50 keys, each key at most 128 characters and each value at most 256. A write past a bound — including a merge that would grow the stored bag past the key count — is 400 VALIDATION_FAILED with meta.limit naming the bound it crossed. system.* keys are the platform's and do not count against the 50.

get-actor-tags​

Get actor tags

Arguments​

ArgumentTypeRequiredDescription
actor_idstringyesActor ID

replace-actor-tags​

Replace actor tags

Arguments​

ArgumentTypeRequiredDescription
actor_idstringyesActor ID

merge-actor-tags​

Merge actor tags

Arguments​

ArgumentTypeRequiredDescription
actor_idstringyesActor ID