MCP 207 tools

Browse the tools
Available tools

Entities

An entity is one record of an entity type, such as one animal, kept in a vault. Its values follow the template version it was written with, which a correction never changes.

Choose a tool to see the parameters it accepts.

Tools

List the records of one entity type in one vault, such as the animals, a page at a time, by name, each with its values.

vault string required
The id of the vault, as list-vaults gives it.
entity_type string required
The id of the entity type, as list-entity-types gives it.
page integer optional
The page to read, starting at 1.
per_page integer optional
How many records a page holds: 25 unless asked, 100 at most.

Look one record of an entity type up in a vault, such as an animal, with every value its template holds.

vault string required
The id of the vault, as list-vaults gives it.
entity string required
The id of the record, as list-entities gives it.

Write down a new record of an entity type in a vault, such as an animal, on the template the vault uses for that type unless another template of the type is named. The change is written to the account log.

vault string required
The id of the vault, as list-vaults gives it.
entity_type string required
The id of the entity type, as list-entity-types gives it.
name string required
What the record is called.
structure_version_id integer optional
The id of the published version of one of your active templates for this entity type, as list-template-versions gives it, which says what the record holds. Left out, the record starts from the template the vault uses for that type.
fields object optional
Values keyed by the field id get-template-version gives for the template the record starts from. A repeating group takes a list of repetitions, each as {values}, keyed by the ids of the fields inside the group. A field left out starts with its default.

Correct a record of an entity type, such as an animal: its name and the values of its template. The record stays on the template version it uses. The change is written to the account log.

vault string required
The id of the vault, as list-vaults gives it.
entity string required
The id of the record, as list-entities gives it.
name string optional
What the record is called.
fields object optional
Values keyed by the field id get-entity gives. A repeating group takes a list of repetitions, each as {id, values}: the id is the row get-entity gives, and the values are keyed by the ids of the fields inside the group.