Browse documentation

Keep tool reference

Every tool Keep offers your agent over MCP. Creating identities and credentials is a CLI operation and is not listed here. Full technical reference: limits, errors, and recovery

Status

describe
Describe product support, limits, current access and retrieval readiness. Tool capability readiness does not grant permission. Omit spaceId to select an accessible workspace.

Workspaces

list_spaces
List accessible workspaces and effective permissions. Select a spaceId for workspace data calls. isDefault identifies the default workspace.
get_space
Read an accessible workspace's metadata revision and content snapshotRevision together. Use both current revisions for deletion. Scoped authority requires membership and credential scope.
put_space
Create or replace workspace metadata by stable key. Use absent for creation or the current revision for replacement. Retain requestId for retries.
delete_space
Permanently delete a workspace. Default is protected. Read get_space for both preconditions. Non-empty workspaces require cascade true. Retain requestId and payload after an ambiguous response. A revision conflict requires inspection and a new requestId.

Collections

list_collections
List complete collection catalog objects with exact snapshot continuation.
get_collection
Read current collection metadata and its current document count.
put_collection
Create or replace collection metadata conditionally. Optional schemas can guide or strictly validate document data. Retain requestId after an ambiguous response.

Documents

list_documents
List exact document projections with optional typed filters and order. Repeat arguments with a cursor; restart after cursor_expired.
get_document
Read a complete current or specified historical document by ID or collection and key.
put_document
Create or replace a complete document conditionally. Omitted fields use defaults. Retain requestId after an ambiguous response.
document_history
List revision summaries in recorded-time order. Read a specific revision with get_document.
delete_document
Permanently delete a document and its content history. Retain requestId after an ambiguous response.

Search and Aggregates

aggregate_documents
Calculate exact counts and declared numeric measures over one collection. Optional grouping returns at most 100 groups. No partial totals are returned.
search
Find ranked current documents. Auto uses lexical ranking; hybrid needs --semantic and a ready index. Call describe after a hybrid failure. Use list_documents for complete sets.

Saved Views

list_views
List saved exact queries in one collection with snapshot continuation.
get_view
Read one saved view by ID or by its collection and key.
put_view
Create or replace a saved exact query conditionally. Retain requestId after an ambiguous response.
list_view_documents
Run a saved exact query. Repeat the returned asOf value with a relative-view cursor.

Record Links

get_document_link
Create a read-only record address after checking access and target existence. Omit revision for a live link; specify revision to pin history. Links grant no permission. Resolve on a trusted existing Keep connection.
resolve_document_link
Read a record address on the current trusted Keep connection. Existing access checks apply. Foreign stores return not_found. No network fetch occurs. Live links read current content; pinned links read the specified revision.

Access

put_space_grant
Create or replace workspace membership on the owner's behalf; confirm the share with the owner before calling. The caller needs owner membership and manage scope. Null role revokes access. Read list_space_grants first.
list_principals
List identity metadata and current revisions. Store administration requires admin scope. Disabled identities retain history and audit attribution.
list_space_grants
List workspace memberships and current revisions. The caller needs owner membership and manage scope. Null roles retain revocation revisions.
list_credentials
List credential metadata and current revisions. Store administration requires admin scope. Secrets and digests are excluded. A cursor belongs to its credential and authorization revision.
list_audit_events
List immutable successful mutation events. Store administration requires admin scope. Events exclude content and secrets. Reads, denials and receipt replays create no event.

Export and Import

export_space
Export one workspace as a bounded inline package. The selected profile reports content coverage and receipt inclusion. Exports omit authority and audit; organization profiles also omit operational receipts. Use a stopped-store backup for full recovery.
import_space
Validate a package against a pristine destination without changes. Apply imports atomically and adopts the source workspace ID. spaceId names the pre-import destination. New calls use the adopted ID; ambiguous-response retries retain the original payload and requestId.