MCP tool
list_documents
List / count protected documents
READ
calls /api/v1/documentsList and COUNT the protected documents (files) in a workspace, optionally filtered by folder or a name search. Use this to answer "how many files do I have" or to show what has been protected. Returns the total count plus a page of documents (name, folder, proof tx, network, date). Read-only.
- Access: read-only
- Calls:
/api/v1/documents
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
workspace | string | yes | Workspace id |
folder | string | no | Folder id to count/list within (omit for the whole workspace) |
search | string | no | Filter by file name, title, or the agent reason |
uploadChannel | web | api | agent | no | agent = only what the AI agent protected |
docType | string | no | Agent classification doc type |
docState | string | no | Agent classification doc state |
objective | string | no | The objective the agent was working to |
runId | string | no | Only documents protected by this sweep |
needsFolder | boolean | no | true = agent-protected files still at the workspace root |
party | string | no | Exact counterparty name, e.g. "Acme Corp". Not a substring: Acme will not match Acme Holdings |
hasClassification | boolean | no | false = documents nobody has described yet. The backfill starting point |
documentDateFrom | string | no | ISO 8601, on the date read OFF the document (unproven) |
documentDateTo | string | no | ISO 8601, on the date read OFF the document (unproven) |
sort | createdAt | documentDate | no | createdAt = when immut proved it. documentDate = the date on the page, unproven |
order | asc | desc | no | Default desc. Use asc for a chronological story |
minConfidence | number | no | Lowest classification confidence to include |
maxConfidence | number | no | Highest classification confidence to include |
from | string | no | ISO 8601. Only documents protected on or after this |
to | string | no | ISO 8601. Only documents protected on or before this |
page | number | no | Page number (default 1) |
limit | number | no | Page size, max 100 (default 20) |
Generated from the immut MCP server, 28 tools. Machine-readable: this page as markdown · everything in one file · tool contract