get_data_entity
One data entity by id with its fields in order, each with its type, flags, validation, example and description.
Return one entity of a project's dictionary with its fields in order: the entity's own record (name, plural, description, component, owner, personal-data flag, retention note, status) and, for every field, its name, type, the entity a reference points at, the values of an enum, whether it is required, unique or personal data, the rule a value obeys in words, a sample value and what it means. Read it before writing a migration, a form, a validation rule or an API payload for the entity, and before drafting test data, so the fields you use are the ones the analyst wrote down.
An entity of a project the token may not see, or one that is not approved read through a guest token, is unknown rather than forbidden.
Requires ability
The token behind the MCP session must hold it, or the call is refused with TOKEN_MISSING_ABILITY.
Runs the same actions as
The REST endpoint and this tool share one action, so validation, permissions and events are identical.
Annotations
It reads and never changes anything.
Arguments
data_entity_id*stringUUID of the data entity to fetch.
What it returns
{ "data": { "id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d", "project_id": "7f3d1c92-8b45-4e6a-9d21-5c8e0a4b6f13", "component_id": "c2d3e4f5-a6b7-4c8d-9e0f-1a2b3c4d5e6f", "name": "Order", "plural": "Orders", "description": "<p>One purchase a branch places, from the basket to the delivery note.</p>", "owner_id": "9b2e4f1a-3c5d-4e6f-8a7b-1c2d3e4f5a6b", "pii": true, "retention_note": "Kept seven years for tax; personal fields masked after two.", "status": "approved", "position": 1, "fields": [ { "id": "f1e2d3c4-b5a6-4978-8a9b-0c1d2e3f4a5b", "name": "reference", "type": "string", "reference_entity_id": null, "required": true, "unique": true, "pii": false, "validation": "ORD- followed by six digits", "example": "ORD-000142", "description": "The number printed on the invoice.", "enum_values": [], "position": 0 }, { "id": "f2e3d4c5-b6a7-4089-9b0c-1d2e3f4a5b6c", "name": "status", "type": "enum", "reference_entity_id": null, "required": true, "unique": false, "pii": false, "validation": null, "example": "placed", "description": "Where the order stands.", "enum_values": ["draft", "placed", "paid", "shipped"], "position": 1 } ], "created_at": "2026-10-20T09:20:00+00:00", "updated_at": "2026-10-27T11:30:00+00:00" }}How it fails
RESOURCE_NOT_FOUNDunknown data_entity_id, an entity of a project outside the token's scope or the person's visibility, or an entity that is not approved read through a guest token.
TOKEN_MISSING_ABILITYtoken lacks data-entity:view.
How is this guide?
Last updated on