Update vault

The MCP server is in public beta. It is open to use and still being refined, so tools and behavior may change.

Tool update_vault · Behavior Destructive

Change a vault’s name, description, who can see it, or whether it is archived. Send only what should change. Archiving hides the vault and stops changes to it without deleting anything, and restoring brings it back with its documents intact. Only a vault owner can do any of this. Deleting a vault permanently is not available here; that is done in the app or on the REST API.

Input parameters

string (uuid)

required

The vault to change, from get_vaults.

string

New name.

string | null

New description. Pass null to clear it.

boolean

When true only members see the vault. When false anyone in the organization with organization-wide vault access can read it. This adds and removes no members.

boolean

Set true to archive the vault, which hides it and stops changes, or false to restore it. Archiving deletes nothing.

Response

object

Show properties

string (uuid)

Unique vault identifier

string

Vault name

string | null

Vault description, or null if unset

'owner' | 'editor' | 'viewer'

Caller’s role in this vault: owner (manage members and settings), editor (add documents and edit extracted data), or viewer (read and annotate). A vault the caller reaches only through organization-wide visibility reports viewer. The role is not the whole story for writes: adding documents also needs the organization-level permission to manage vaults, so a caller can hold editor here and still receive 403 from POST /vaults/{id}/documents.

boolean

When true, only vault members can see the vault. When false, any member of the organization with organization-wide vault read can see it.

number

Documents that have finished scanning in this vault. Documents still being read are not counted yet.

string | null

ISO 8601 timestamp when guided setup finished, or null while the vault is still in setup. Documents added to a vault in setup are stored but not scanned until setup finishes. Vaults created through POST /vaults finish setup immediately, so this is always set for them.

string | null

ISO 8601 timestamp when the vault was archived, or null while it is live. Archived vaults are hidden from the default list and reject changes until POST /vaults/{id}/restore runs.

string

ISO 8601 creation timestamp

string

ISO 8601 last-update timestamp

​Input parameters

​Response

Input parameters

Response