Get vaults

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

Tool get_vaults · Behavior Read-only

List or fetch Contract Intelligence vaults. A vault holds a set of contracts that GC AI has read, with the extracted fields the team tracks. Pass id to fetch one vault. Otherwise returns a page of the vaults you can access; narrow with q and page with cursor/limit. Always returns a vaults array (empty when nothing matches) and a next_cursor (null on the last page). Use a returned id as vault_id when adding a document with upload_file or start_file_upload, or to ground ask_gcai in that vault’s documents. Archived vaults are not listed. document_count is the number of documents that have finished scanning and can lag a fresh upload; confirm an upload with get_files({ id }), not with this count.

Input parameters

string (uuid)

Fetch one vault by id. Provide either id or a list query (q/cursor), not both.

string

Filter the accessible vaults by a case-insensitive substring of the vault name. Omit to list everything accessible.

string

Opaque pagination cursor from a previous response’s next_cursor. Omit for the first page; repeat any filters (e.g. q) alongside it.

integer

Max items to return (default 25, max 100). Defaults to 25.

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.

string

ISO 8601 creation timestamp

string

ISO 8601 last-update timestamp

string | null

REST

MCP

CLI

Input parameters

Response

​Input parameters

​Response

Input parameters

Response