Skip to content

Entity Update

Update an entity's canonical name and/or description. Tags + aliases are managed through their own capabilities so a rename PATCH can't accidentally wipe them.

MCP name: entity_update

Category: entities

Mutates state (retry policy: manual)

Parameters

Name Type Required Description
author str No 'user' (default) or 'agent'.
canonical_name str No New display name. Re-normalizes; rejects on collision with another entity.
description str No New description. Pass empty string to clear; omit to leave unchanged.
entity_id int Yes Stable surrogate id (NOT the canonical name).
source_kind str No One of document, chat, task, agent, manual.
source_path str No Document/session/agent path; with source_kind, records an update reference.