delete_data_entity
Deletes a data entity and its fields after the person confirms; deprecating keeps it on the record instead.
Delete a data entity by data_entity_id, with its fields. Reference fields of other entities that pointed at it lose their target. The removal goes through the same action the Dictionary page runs and data_entity.deleted goes out. The tool is destructive: a Heimdall turn pauses for the person's confirmation and an MCP client asks before sending. Prefer moving a retired entity to deprecated with update_data_entity so the record keeps it. A staff token with data-entity:delete on the project is needed.
Requires ability
The token behind the MCP session must hold it, or the call is refused with TOKEN_MISSING_ABILITY.
Runs the same action as
The REST endpoint and this tool share one action, so validation, permissions and events are identical.
Fires one event
Delivered to every endpoint subscribed to it once the change is made.
Annotations
A client that honours annotations asks a person before running it.
Arguments
data_entity_id*stringUUID of the data entity to delete.
What it returns
{ "data": { "data_entity_id": "8c9d0e1f-2a3b-4c4d-8e5f-6a7b8c9d0e1f", "deleted": true }}How it fails
RESOURCE_NOT_FOUNDunknown data_entity_id, or an entity outside the token's scope or the person's visibility.
FORBIDDENthe token is a client guest's, or the holder's role on the project does not carry data-entity:delete.
TOKEN_MISSING_ABILITYtoken lacks data-entity:delete.
How is this guide?
Last updated on