Documents
75 entities and 387 agent-callable operations in documents. Each operation is addressed as {mega_tool}/documents/{entity}/{operation} and carries the same permission check over MCP and REST.
387 of 387 shown
access_alerts
| Operation | Mega-tool | What it does |
|---|---|---|
acknowledge | document_op | Acknowledge an open folder access alert ("I know"). |
evidence | document_op | The audit events behind an alert (id, time, action, node id, actor, source), newest first, up to 200. |
list | document_op | Folder access alerts, severity-sorted (critical first), with the open count. |
resolve | document_op | Resolve a folder access alert. |
access_grant
| Operation | Mega-tool | What it does |
|---|---|---|
list | entity_crud | List access_grants with filtering and pagination |
read | entity_crud | Get detailed access grant information |
search | entity_crud | Search access_grants with fuzzy matching |
access_report
| Operation | Mega-tool | What it does |
|---|---|---|
export | document_op | Export one report to Excel (every sheet an Excel Table, no merged cells). |
external_exposure | document_op | External sharing in SharePoint: anyone/organization links (no-expiry, password), grants to accounts outside the organization grouped by account, folder and… |
parity_diff | document_op | A4-effective versus Microsoft-effective access per folder: users only A4 grants, users only Microsoft grants, unresolved principals, and Everyone differences. |
what_can_user_access | document_op | What a user can reach: folder and document counts per site, drive or top folder, with the "because" paths. |
who_can_access | document_op | Who can see this folder, as SharePoint grants it and as A4 enforces it, side by side. |
access_request
| Operation | Mega-tool | What it does |
|---|---|---|
approve | document_op | Approve a pending request: a Library request creates the permission for the requester through the normal grant path (same checks, same audit; the folder must… |
deny | document_op | Decline a pending request, with an optional note the requester sees. |
list_mine | document_op | The caller's own access requests with their status and decision, newest first. |
list_pending | document_op | Pending access requests the caller may decide (Full control on the folder, Manage folder access, or SharePoint management for SharePoint items), soonest SLA… |
request | document_op | Ask the owners of a folder or file for access, on behalf of the caller (never another user). |
withdraw | document_op | Withdraw one of your own pending requests. |
access_review
| Operation | Mega-tool | What it does |
|---|---|---|
close_campaign | document_op | Close a campaign: execute every decision, apply default_on_no_response to unanswered A4 lines, mark it closed. |
create_campaign | document_op | Start an access review campaign and freeze its lines. |
decide | document_op | Record Keep, Remove or Expire (expire_on, future ISO date-time) on one line. |
export | document_op | Export a campaign as Excel evidence. |
list_campaigns | document_op | Access review campaigns with progress (items_total, items_decided). |
list_items | document_op | The lines of one campaign (id, node, principal, level, source_of_truth, decision, remediation_state). |
access_scope
| Operation | Mega-tool | What it does |
|---|---|---|
list | entity_crud | List access_scopes with filtering and pagination |
read | entity_crud | Get detailed access scope information |
search | entity_crud | Search access_scopes with fuzzy matching |
acl_coverage
| Operation | Mega-tool | What it does |
|---|---|---|
derived_drift | document_op | Do the derived stores (research evidence sources) still match their documents? |
refresh_derived | document_op | Enqueue a refresh of the derived-store ACL mirror: for doc_ids (this organization only) or, with none, the whole organization (leak direction repaired first). |
anonymize
| Operation | Mega-tool | What it does |
|---|---|---|
run | document_op | Run anonymize. |
attachment
| Operation | Mega-tool | What it does |
|---|---|---|
codex_judge_sweep | workflow_action | Size or sample the headless-Codex content judge for never-content-judged email attachments. |
consumer_report
| Operation | Mega-tool | What it does |
|---|---|---|
report | document_op | Report a loaded document as a consumer report (delete a consumer report). |
consumer_report_incident
| Operation | Mega-tool | What it does |
|---|---|---|
list | document_op | List consumer-report incidents for this organization (file name, folder, discovery point, deadline, status, derived-record counts, drafted notice, notice-sent… |
mark_notice_sent | document_op | Record that the written notice for an incident was sent (by a person, outside the platform — the platform never sends it). |
read | document_op | Read one consumer-report incident (with the drafted plain-text notice). |
dedup_rule
| Operation | Mega-tool | What it does |
|---|---|---|
create | entity_crud | Create a new dedup rule |
delete | entity_crud | Delete a dedup rule |
list | entity_crud | List dedup_rules with filtering and pagination |
read | entity_crud | Get detailed dedup rule information |
search | entity_crud | Search dedup_rules with fuzzy matching |
update | entity_crud | Update an existing dedup rule |
dedup_rule_set
| Operation | Mega-tool | What it does |
|---|---|---|
create | entity_crud | Create a new dedup rule set |
delete | entity_crud | Delete a dedup rule set |
list | entity_crud | List dedup_rule_sets with filtering and pagination |
read | entity_crud | Get detailed dedup rule set information |
search | entity_crud | Search dedup_rule_sets with fuzzy matching |
update | entity_crud | Update an existing dedup rule set |
dedup_rule_set_membership
| Operation | Mega-tool | What it does |
|---|---|---|
create | entity_crud | Create a new dedup rule set membership |
delete | entity_crud | Delete a dedup rule set membership |
list | entity_crud | List dedup_rule_set_memberships with filtering and pagination |
read | entity_crud | Get detailed dedup rule set membership information |
update | entity_crud | Update an existing dedup rule set membership |
dlp_policy
| Operation | Mega-tool | What it does |
|---|---|---|
effective | config_manage | Effective copy decision for a user reading documents of an organization: {can_copy, restricted, restriction_source, reason}. |
get | config_manage | Read the document copy-protection (DLP) policy: tenant default, every visible organization's override (null = inherit) with its resolved answer and source… |
set | config_manage | Turn document copy protection on/off. |
dms
| Operation | Mega-tool | What it does |
|---|---|---|
save_back | document_op | Write a document's current bytes to its DMS content source as a new document or a new version, using the caller's own delegated DMS sign-in so the DMS audit… |
document
| Operation | Mega-tool | What it does |
|---|---|---|
archive | document_op | Archive a document by setting its status to 'archived'. |
bulk_status | document_op | Update the status of multiple documents at once. |
chunk_retrieve | document_op | Retrieve text chunks from a specific document for reading or RAG context assembly. |
classify | document_op | Classify a document by applying classification rules to determine its type. |
create | entity_crud | Create a new document |
create_viewing_room | document_op | Bundle a curated list of documents into a shareable Viewing Room. |
delete | entity_crud | Delete a document |
find_related | document_op | Find documents related to an entity via DocumentLink. |
find_similar | document_op | Find documents whose text chunks are similar to a reference document (text embeddings) — not pixels. |
get_transitions | workflow_action | Get available transitions for a document |
image_text_search | document_op | Find document images that VISUALLY match a free-text description (e.g. |
image_visual_search | document_op | Find documents whose images look VISUALLY similar to a reference document's image (pixel features, not text descriptions). |
list | entity_crud | List documents with filtering and pagination. |
near_duplicate_counts | document_op | Visible near-duplicate cluster size per document id (up to 100 ids per call). |
near_duplicate_review | document_op | Confirm or dismiss a near-duplicate/version-chain proposal. |
near_duplicates | document_op | Members of a document's near-duplicate cluster, plus any pending version-chain proposals (supersedes/redline_of) touching it. |
push_from_workspace | document_op | Save files you wrote in your own workspace (Studio seat, or a Terminal v2 session workspace when the organization has no Studio) into this organization's… |
rag_status | document_op | Get RAG pipeline health and indexing statistics for the organization. |
read | entity_crud | Get detailed document information. |
read | document_op | Read a single document by UUID — returns full extracted_text, intelligence_summary, description, all metadata. |
reclassify | document_op | Force reclassify a document, clearing existing classification before re-evaluating rules. |
reprocess | document_op | Re-run the document processing pipeline: reset status to 'uploaded', clear the chosen processing outputs, then ENQUEUE the same Celery chain the REST… |
search | entity_crud | Search documents by content and metadata. |
search | document_op | Search documents by content using DocumentChunk text matching. |
search_guide | document_op | Get the search strategy playbook for effectively finding information in the document library. |
semantic_search | document_op | Semantic RAG search across ALL document chunks using vector embeddings. |
set_language | document_op | Set a document's language by hand (ISO 639-1 code such as 'en', 'de', 'fr'). |
share_link_create | document_op | Create an ungated public share link for one document — anyone who has the link can view (and optionally download) it without signing in. |
share_link_list | document_op | List the public share links created for one document. |
share_link_revoke | document_op | Revoke a public share link so its token stops resolving. |
taxonomy_describe | document_op | Describe the live v2 document-type taxonomy for the active organization. |
transition | workflow_action | Transition document to a new status |
update | entity_crud | Update an existing document. |
document_access
| Operation | Mega-tool | What it does |
|---|---|---|
create | entity_crud | Grant ONE user access to one document (view | edit | manage) without widening its access_level to the whole org. |
delete | entity_crud | Revoke one user's sharing grant on a document (soft delete; visibility is withdrawn immediately). |
list | entity_crud | List the per-user sharing grants on one document, with its access_level and owner. |
document_analytics
| Operation | Mega-tool | What it does |
|---|---|---|
breakdown | report_query | Get document analytics breakdown by dimension |
summary | report_query | Document processing analytics and classification metrics |
trend | report_query | Get document analytics trend over time |
document_annotation
| Operation | Mega-tool | What it does |
|---|---|---|
create | entity_crud | Create a highlight/comment/note annotation on a document |
delete | entity_crud | Delete an annotation (author-only; soft delete) |
list | entity_crud | List annotations on a document (shared ones plus the caller's own private ones) |
read | entity_crud | Read one annotation (visible to the caller, else 404) |
update | entity_crud | Update an annotation (author-only) |
document_chunk
| Operation | Mega-tool | What it does |
|---|---|---|
create | entity_crud | Create a document chunk; metadata, metrics and embeddings are server-owned |
delete | entity_crud | Delete a document chunk |
list | entity_crud | List document_chunks with filtering and pagination |
read | entity_crud | Get detailed document chunk information |
update | entity_crud | Update authored chunk fields; metadata and derived state are server-owned |
document_classification_rule
| Operation | Mega-tool | What it does |
|---|---|---|
create | entity_crud | Create a new document classification rule |
delete | entity_crud | Delete a document classification rule |
list | entity_crud | List document_classification_rules with filtering and pagination |
read | entity_crud | Get detailed document classification rule information |
search | entity_crud | Search document_classification_rules with fuzzy matching |
update | entity_crud | Update an existing document classification rule |
document_import_job
| Operation | Mega-tool | What it does |
|---|---|---|
list | entity_crud | List document_import_jobs with filtering and pagination |
read | entity_crud | Get detailed document import job information |
search | entity_crud | Search document_import_jobs with fuzzy matching |
document_label
| Operation | Mega-tool | What it does |
|---|---|---|
create | entity_crud | Create a new document label |
delete | entity_crud | Delete a document label |
list | entity_crud | List document_labels with filtering and pagination |
read | entity_crud | Get detailed document label information |
search | entity_crud | Search document_labels with fuzzy matching |
update | entity_crud | Update an existing document label |
document_link
| Operation | Mega-tool | What it does |
|---|---|---|
create | entity_crud | Create a new document link. |
delete | entity_crud | Delete a document link |
list | entity_crud | List document_links with filtering and pagination. |
read | entity_crud | Get detailed document link information |
search | entity_crud | Search document_links with fuzzy matching |
update | entity_crud | Update an existing document link |
document_relation
| Operation | Mega-tool | What it does |
|---|---|---|
create | entity_crud | Create a new document relation |
delete | entity_crud | Delete a document relation |
list | entity_crud | List document_relations with filtering and pagination |
read | entity_crud | Get detailed document relation information |
search | entity_crud | Search document_relations with fuzzy matching |
update | entity_crud | Update an existing document relation |
document_saved_view
| Operation | Mega-tool | What it does |
|---|---|---|
create | entity_crud | Create a new document saved view |
delete | entity_crud | Delete a document saved view |
list | entity_crud | List document_saved_views with filtering and pagination |
read | entity_crud | Get detailed document saved view information |
search | entity_crud | Search document_saved_views with fuzzy matching |
update | entity_crud | Update an existing document saved view |
document_source_config
| Operation | Mega-tool | What it does |
|---|---|---|
create | entity_crud | Create a new document source config |
delete | entity_crud | Delete a document source config |
list | entity_crud | List document_source_configs with filtering and pagination |
read | entity_crud | Get detailed document source config information |
search | entity_crud | Search document_source_configs with fuzzy matching |
update | entity_crud | Update an existing document source config |
document_type_definition
| Operation | Mega-tool | What it does |
|---|---|---|
create | entity_crud | Create a new document type definition |
delete | entity_crud | Delete a document type definition |
list | entity_crud | List document_type_definitions with filtering and pagination |
read | entity_crud | Get detailed document type definition information |
search | entity_crud | Search document_type_definitions with fuzzy matching |
update | entity_crud | Update an existing document type definition |
document_version
| Operation | Mega-tool | What it does |
|---|---|---|
create | entity_crud | Create a new document version |
delete | entity_crud | Delete a document version |
list | entity_crud | List document_versions with filtering and pagination |
read | entity_crud | Get detailed document version information |
search | entity_crud | Search document_versions with fuzzy matching |
update | entity_crud | Update an existing document version |
embed_policy
| Operation | Mega-tool | What it does |
|---|---|---|
duplicates_status | report_query | How many email Documents of this organization are already chunk_only (excluded from embedding), how many more the duplicate rule would mark (per class and… |
mark_duplicates | smart_action | Dry run: which duplicate email Documents of this organization (same Message-ID + subject across mailboxes, same attachment content, two bodies for one… |
explorer
| Operation | Mega-tool | What it does |
|---|---|---|
copy | document_op | Copy items to a destination folder: SharePoint items (async; the result carries operation_id, poll operation_status) or a Library document into a SharePoint… |
create_folder | document_op | Create a folder in the A4 Library (parent lib:root or lib:f:<uuid>) or in a writable SharePoint drive (parent sp:d: or sp:i:). |
delete | document_op | Delete items: a Library document goes to the Recycle Bin (restorable for 30 days), an empty Library folder is removed, a SharePoint item goes to the… |
explain_query | document_op | Parse an Explorer search query without running it: returns the search object (terms, property filters with labels, warnings such as unknown_property or… |
get_node | document_op | Get one explorer node with its ancestors, Windows-style display path and, for a single document or SharePoint file, a properties dict of Details-tab rows… |
link_to_deal | document_op | Link Library documents to a deal drive (destination_id deal:<deal_key>): a LINK, not a move - the document stays in its folder and also shows in the deal's… |
list_children | document_op | List the folders and files directly inside a node (folders first), paged. |
list_roots | document_op | List the top-level locations of the File Explorer: the A4 Library, Gallery, Recycle Bin and every synced SharePoint drive. |
move | document_op | Move items to a destination folder: Library folders/documents within the Library, SharePoint items within one drive, or a Library document into a SharePoint… |
operation_status | document_op | Check SharePoint copy operations started by copy: pass the operation_id values it returned. |
place_staged | document_op | Turn staged uploads (from document_op/documents/staged_upload/stage_from_bytes) into documents and file them in a Library folder (lib:root, lib:f:<uuid>) or a… |
rename | document_op | Rename a Library folder, Library document (title) or SharePoint item. |
resolve_path | document_op | Resolve a Windows-style path (e.g. |
restore | document_op | Restore Library documents from the Recycle Bin (lib:bin) by their doc:<uuid> ids; each returns to its folder, or to its source bucket if the folder was deleted. |
search_grammar | document_op | The Explorer search grammar manifest: every supported property (name, aliases, value type, values, providers), the kind names, size buckets (Empty..Gigantic)… |
seek | document_op | Type-ahead position: the 0-based index in a name-ordered listing of the first row whose name is at or after prefix (at or before it when direction is desc)… |
finance_profile
| Operation | Mega-tool | What it does |
|---|---|---|
confirm | document_op | Accept a proposed claim as a named person (a new accepted row; the profile is rebuilt). |
explain | document_op | Every claim behind one field of a document (or all fields), oldest first, with method, confidence, evidence, status and whether it is the current one: the… |
get | document_op | The projected finance profile of one document (type, family, authority, official badge, deal links, role, parties, dates, legends, governing law, identifiers)… |
propose | document_op | Propose a value for a finance field (it lands 'proposed' in the Needs-confirmation queue; a person confirms it). |
reinfer | document_op | Re-run the DETERMINISTIC finance inference on one document (channel and stamp, legend census, ledger projection, filename and cover rules, privilege screen… |
reject | document_op | Reject a claim as a named person (a new rejected row; inference never re-proposes the same value). |
folder_access
| Operation | Mega-tool | What it does |
|---|---|---|
apply_template | document_op | Apply a permission template (list_templates) to a Library folder: it stops inheriting and its grants are replaced by the template. |
audit | document_op | The append-only folder-access audit trail (grants, revokes, level and inheritance changes, templates, policy and enforcement changes, identity links… |
check_access | document_op | 'Check access': why a user can or cannot view / edit / manage a node: can_view, can_edit, can_manage, because (the chain of grants), blockers… |
extend_grant | document_op | Change or clear (expires_at null) the expiry of one live permission (grant_id from get_acl) on a folder with its own permissions. |
follow_folder | document_op | Make a filed document follow its folder's permissions ('Make it follow folder permissions'). |
get_acl | document_op | Who has access to a folder, file, drive or SharePoint item: the AclView with grants (level, via direct/inherited), inheritance, can_manage, source_of_truth… |
grant | document_op | Give a principal a permission level on a Library folder (or lib:root). |
list_expiring | document_op | Time-boxed permissions that expire within the next N days (default 14, max 365) on folders the caller manages (Manage folder access sees all), soonest first. |
list_principals | document_op | Search the principals a permission can be given to (max 25): Everyone, A4 users, A4 roles, synced Entra / Microsoft 365 groups and resolved SharePoint groups. |
operation_status | document_op | Progress of folder-access repoint operations started by stop_inheriting, restore_inheritance or apply_template: pass the operation_id values they returned. |
restore_inheritance | document_op | Make a Library folder follow its parent's permissions again (its own grants are retired once its files have moved). |
revoke | document_op | Remove one permission (grant_id from get_acl) from a folder's own permissions. |
set_level | document_op | Change the level of one existing permission (grant_id from get_acl). |
stop_inheriting | document_op | Give a Library folder its own permissions (SharePoint 'Stop inheriting'). |
folder_access_policy
| Operation | Mega-tool | What it does |
|---|---|---|
create_template | document_op | Create a custom permission template. |
delete_template | document_op | Delete a custom template (a system template cannot be deleted). |
get | document_op | The organization's folder-access policy: config {default_new_top_level_folder, manage_requires, allow_everyone_grants… |
list_templates | document_op | The permission templates (Everyone can read, Everyone can edit, Owner and admins only, Confidential, plus custom ones). |
update | document_op | Change the folder-access policy and/or the enforcement switches. |
update_template | document_op | Edit a custom template (a system template cannot be edited). |
google_drive_account
| Operation | Mega-tool | What it does |
|---|---|---|
activate | entity_crud | Flip enrolled Google Drive connectors active and dispatch their first delta, staggered smallest-drive-first. |
deactivate | entity_crud | Stop enrolled Google Drive connectors syncing. |
enroll | entity_crud | Enrol tenant Google mailboxes/Drives as HELD, INACTIVE rows (census + create). |
list | entity_crud | List enrolled Google Drive accounts (held SourceConnector rows) with sync/ACL state and counts. |
read | entity_crud | Read a single enrolled Google Drive account by SourceConnector id. |
set_viewers | entity_crud | Change who besides the owner may read a held Google Drive's documents. |
google_workspace_census
| Operation | Mega-tool | What it does |
|---|---|---|
summary | report_query | Google Workspace tenant census summary. |
guide
| Operation | Mega-tool | What it does |
|---|---|---|
get | agent_command | Org pipeline control playbook (two levels, subtract-only accounts, inheritance, source semantics, per-mailbox email lanes). |
query | report_query | Documents agent playbook: where every documents id comes from and the order the workflows run in. |
import_job
| Operation | Mega-tool | What it does |
|---|---|---|
import_cancel | document_op | Cancel a non-terminal bulk import job (org-scoped). |
import_items | document_op | Per-file outcomes for a single bulk import job (org-scoped), ordered by sequence. |
import_list | document_op | List this org's bulk import jobs, newest first. |
import_status | document_op | Get the status, counts, and progress of a single bulk import job (org-scoped) by its id. |
import_submit | document_op | Start a bulk document-import job from the org's pending staged uploads. |
intake_policy
| Operation | Mega-tool | What it does |
|---|---|---|
read | document_op | Read this organization's consumer-report triage policy: whether triage governs every delivered file (consumer_report_triage), hold expiry and staging-delete… |
set | document_op | Turn consumer-report triage on/off for THIS organization (its own policy row). |
intake_triage
| Operation | Mega-tool | What it does |
|---|---|---|
decide | document_op | Decide a HELD intake item on its metadata: decision='clear' makes it promotable; decision='consumer_report' deletes the staged bytes, opens an incident and… |
evaluate | document_op | Dry-run the consumer-report triage rules on a file NAME, delivered folder path and (optional) tabular header cells. |
list | document_op | List consumer-report triage records for this organization (metadata only: file name, delivered folder, type, size, verdict, matched rule). |
read | document_op | Read one triage record (metadata only) by id. |
mcp_bridge
| Operation | Mega-tool | What it does |
|---|---|---|
export_to_mcp | document_op | Send one A4 document to an admin-declared export target on an external MCP server. |
import_from_mcp | document_op | Import resources from an external MCP server the caller has connected into A4 documents (restricted, owned by the caller, optional matter). |
microsoft_acl_sync
| Operation | Mega-tool | What it does |
|---|---|---|
accept_unresolved | document_op | Record that an unresolved / consent-missing / directory-role principal grants nobody in A4, by decision. |
acknowledge_parity | document_op | Acknowledge that a folder admin will see less because that is what SharePoint grants them (a loss through decided principals only; a loss through an undecided… |
link_identity | document_op | Link an Entra user (object id) to an A4 user of this organization so the user's Microsoft group memberships and SharePoint permissions apply to their A4… |
list_resolution | document_op | The Rollout principal ledger: every Microsoft principal a live grant names, with its resolution state (resolved, resolved_empty, deleted_in_directory… |
map_site_group | document_op | Map an unresolved SharePoint site group (key from status.unresolved_groups) to A4 users and/or roles' current members. |
preflight | document_op | The SharePoint enforcement preflight. |
revoke_acceptance | document_op | Undo accept_unresolved: the principal returns to the undecided state it came from. |
run | document_op | Queue a Microsoft sync now: kind directory (users, groups, membership), mirror_full (every folder permission) or mirror_item (one SharePoint node: pass… |
status | document_op | Microsoft permission sync status: tenant binding, last directory sync / full mirror / sharing-change feed, coverage (folders mirrored vs live), unresolved… |
unlink_identity | document_op | Unlink an Entra identity from its A4 user; the sync never silently re-binds it. |
unmap_principal | document_op | Remove the manual mapping of a directory-role / deleted-group / site-group principal; it returns to its undecided state. |
onedrive_account
| Operation | Mega-tool | What it does |
|---|---|---|
activate | entity_crud | Flip enrolled OneDrive connectors active and dispatch their first delta, staggered smallest-drive-first. |
deactivate | entity_crud | Stop enrolled OneDrive connectors syncing. |
enroll | entity_crud | Enrol tenant OneDrives as HELD, INACTIVE SourceConnector rows (census + create). |
list | entity_crud | List enrolled OneDrive accounts (held SourceConnector rows) with sync/ACL state and counts. |
read | entity_crud | Read a single enrolled OneDrive account by SourceConnector id. |
set_viewers | entity_crud | Change who besides the owner may read a held OneDrive's documents. |
onedrive_census
| Operation | Mega-tool | What it does |
|---|---|---|
summary | report_query | OneDrive tenant census summary. |
pipeline
| Operation | Mega-tool | What it does |
|---|---|---|
infra_status | document_op | Get read-only infrastructure / embedding health for the document pipeline: inline embedding-server health (HTTP /health probe + URL) and the GPU… |
pipeline_overview | document_op | Get the evergreen corpus overview analytics for the organization: total documents, text/embed coverage percentages, the document->extracted->chunked and… |
pipeline_status | document_op | Get the full live status of all 7 document-pipeline stages for the organization (SharePoint sync, email sync, text extraction, OCR, chunking, inline… |
pipeline_control
| Operation | Mega-tool | What it does |
|---|---|---|
get | config_manage | Read one pipeline stage's control state (enabled + config) for the active org |
list | config_manage | List every pipeline stage with its effective state, source, group and description |
reset | config_manage | Delete a stage's control row for the active org, reverting it to the stage default |
set | config_manage | Enable/disable a pipeline stage (and merge config) for the active org; busts the gate cache |
pipeline_stage
| Operation | Mega-tool | What it does |
|---|---|---|
run_chunking | smart_action | Run-now the chunking stage org-wide (gated behind STUDIO_INLINE_STAGE_TRIGGERS, default OFF). |
run_email_sync | smart_action | Run-now the email sync stage for this org: dispatch sync_all_email_accounts scoped to the current organization. |
run_embedding | smart_action | Run-now the inline-embedding stage org-wide (gated behind STUDIO_INLINE_STAGE_TRIGGERS, default OFF). |
run_extraction | smart_action | Run-now the text-extraction stage org-wide (gated behind STUDIO_INLINE_STAGE_TRIGGERS, default OFF). |
run_gpu_drain | smart_action | Run-now the GPU batch-embedding stage for this org: dispatch drain_gpu_embeddings scoped to the current organization. |
run_ocr_sweep | smart_action | Run ocr sweep pipeline stage. |
run_sharepoint_sync | smart_action | Run-now the SharePoint/OneDrive sync stage for this org: dispatch a delta fan-out (run_scheduled_deltas) scoped to the current organization. |
policy
| Operation | Mega-tool | What it does |
|---|---|---|
search_internal_policies | document_op | Search the organization's knowledge vault for citable policy sections and enrolled controls. |
privilege
| Operation | Mega-tool | What it does |
|---|---|---|
check | document_op | Would these documents be blocked or warned by the privilege share gate on a channel ('share_link', 'matter_room', 'export', 'production')? |
screen | document_op | Run the deterministic privilege screen on one document and record the result (likely/possible/unlikely, basis, which rules fired). |
reconstructed_mailbox
| Operation | Mega-tool | What it does |
|---|---|---|
create | entity_crud | Define a new reconstructed mailbox (a person-centred aggregate over held mail). |
delete | entity_crud | Soft-delete a reconstructed mailbox definition; hard-deletes its own entry/source index rows (they are index rows, not records) — never touches the underlying… |
entries | report_query | A DIRECTORY of one reconstructed mailbox's entries — ids, role, timestamps and document_id only, narrowed to the calling agent's admitted human (§4.2). |
export | smart_action | Export one reconstructed mailbox, as THIS caller sees it, into an EML bundle for counsel (one .eml per visible entry + index.csv + manifest.json). |
list | entity_crud | List reconstructed mailboxes visible to the caller (seal-scoped — a caller not on a mailbox's owner/allowed_viewer_ids seal never sees it). |
read | entity_crud | Read one reconstructed mailbox by id (seal-scoped: not found unless the caller is the owner or on allowed_viewer_ids). |
rebuild | smart_action | Reconcile (catch up + prune) or rebuild (full re-index) one reconstructed mailbox's index. |
summary | report_query | Narrowed summary of a reconstructed mailbox for the calling agent's admitted human: counts, per-account entry totals and date bounds — all computed only over… |
update | entity_crud | Update a reconstructed mailbox. |
redaction
| Operation | Mega-tool | What it does |
|---|---|---|
propose | document_op | Propose redactions for a document: starts (or reuses) its redaction set and adds 'proposed' spans from the personal-data rules, computed lit.pii_spans model… |
status | document_op | A document's redaction sets (status, span counts, verification outcome) and the id of its current redacted copy, if one has been applied. |
routing_rule
| Operation | Mega-tool | What it does |
|---|---|---|
items | config_manage | The routing log (RoutedItem rows, newest first) for the active org — one row per rule x document x action evaluation with status (dry_run / copied / uploaded… |
list | config_manage | List the active org's attachment routing rules (predicate, ordered actions, enabled, dry_run, priority) plus the ACTION CATALOG describing every action type —… |
search_settings
| Operation | Mega-tool | What it does |
|---|---|---|
get | config_manage | Get the per-organization search-quality setting (DiskANN query-list-size); default 200 when unset |
set | config_manage | Set the per-organization search-quality setting (DiskANN query-list-size, 50-500). |
share_point_dedup_manifest
| Operation | Mega-tool | What it does |
|---|---|---|
create | entity_crud | Create a new share point dedup manifest |
delete | entity_crud | Delete a share point dedup manifest |
list | entity_crud | List share_point_dedup_manifests with filtering and pagination |
read | entity_crud | Get detailed share point dedup manifest information |
search | entity_crud | Search share_point_dedup_manifests with fuzzy matching |
update | entity_crud | Update an existing share point dedup manifest |
share_point_operation
| Operation | Mega-tool | What it does |
|---|---|---|
list | entity_crud | List share_point_operations with filtering and pagination |
read | entity_crud | Get detailed share point operation information |
search | entity_crud | Search share_point_operations with fuzzy matching |
share_point_saved_search
| Operation | Mega-tool | What it does |
|---|---|---|
list | entity_crud | List share_point_saved_searches with filtering and pagination |
read | entity_crud | Get detailed share point saved search information |
share_point_site
| Operation | Mega-tool | What it does |
|---|---|---|
create | entity_crud | Create a new share point site |
delete | entity_crud | Delete a share point site |
list | entity_crud | List share_point_sites with filtering and pagination |
live_list_children | entity_crud | LIVE SharePoint folder listing via Microsoft Graph (read-only GET). |
live_resolve_path | entity_crud | Resolve a platform Document to WHERE IT ACTUALLY LIVES in SharePoint, live via Microsoft Graph (read-only GET). |
live_search | entity_crud | LIVE SharePoint filename/content search via Microsoft Graph (read-only GET). |
live_verify_links | entity_crud | Get PROVEN-LIVE SharePoint links for citations. |
read | entity_crud | Get detailed share point site information |
search | entity_crud | Search share_point_sites with fuzzy matching |
update | entity_crud | Update an existing share point site |
sharepoint_restriction
| Operation | Mega-tool | What it does |
|---|---|---|
list | document_op | List the A4 restrictions on SharePoint drives and folders in your organization: drive, folder, scope id and the admitted principals. |
restrict | document_op | Restrict a SharePoint drive (connector_id) or one folder subtree (folder_id, a SourceRecord folder of that drive) to the admitted user_ids (read). |
stamp | document_op | Narrow the documents the organization's SharePoint restrictions cover: every document whose live SharePoint copies all lie inside restrictions, and which is… |
source_connector
| Operation | Mega-tool | What it does |
|---|---|---|
crawl_status | smart_action | Read sync state (sync_status, last_sync_*, last_sync_error) — use to poll a dispatched crawl. |
create | entity_crud | Create a new SourceConnector (typically done by the discover command, but exposed for manual seeding) |
delete | entity_crud | Delete a SourceConnector. |
list | entity_crud | List SourceConnector rows (one per external drive/inbox) with filters and stats |
mark_sync_error | smart_action | Force a connector into error state (for ops recovery, e.g. |
read | entity_crud | Read a single SourceConnector including raw Graph metadata |
reset_sync_state | smart_action | Clear delta_link, last_sync_error, and reset sync_status to 'never' so the next run is a full crawl. |
search | entity_crud | Search SourceConnector by name/description/site/drive |
stats | smart_action | Live aggregate stats from SourceRecord under this connector: counts by item_type/sync_status/extension, size sums. |
trigger_crawl | smart_action | Dispatch a full Graph walk of the connector's drive via Celery. |
trigger_delta_sync | smart_action | Dispatch an incremental Graph delta sync for one SharePoint connector via Celery. |
update | entity_crud | Update a SourceConnector. |
source_record
| Operation | Mega-tool | What it does |
|---|---|---|
create | entity_crud | Not supported — SourceRecord rows are created by the crawler via SourceRecord.from_graph_item. |
delete | entity_crud | Soft-delete a SourceRecord (sets is_deleted=True). |
find_duplicates_by_hash | smart_action | Group SourceRecord files sharing a content hash — the primary dedup signal. |
find_duplicates_by_name_size | smart_action | Group SourceRecord files by (filename, file_size_bytes) — secondary dedup signal for items without a shared hash. |
link_to_document | smart_action | Attach a SourceRecord to a Document by setting its document FK. |
list | entity_crud | List SourceRecord rows (files/folders from external sources) with rich filtering |
list_empty_folders | smart_action | List folder SourceRecords with child_count=0 — candidates for cleanup. |
read | entity_crud | Read a single SourceRecord. |
search | entity_crud | Search SourceRecord by filename/relative_path/description |
unlink_from_document | smart_action | Clear the Document FK on a SourceRecord (does not delete the Document). |
update | entity_crud | Update safe fields on a SourceRecord. |
verify_against_graph | smart_action | Live path-GET against Microsoft Graph to confirm a SourceRecord still exists. |
staged_upload
| Operation | Mega-tool | What it does |
|---|---|---|
list | entity_crud | List your OWN staged_uploads with filtering and pagination. |
list_pending | document_op | List YOUR OWN PENDING staged uploads — the files you dropped on the /documents/staging Canvas that are awaiting action. |
promote | document_op | Ingest a file into this organization's document library — the searchable document corpus — in ONE call and get back its document_id. |
pull_to_workspace | document_op | Copy the raw BYTES of staged uploads onto your Studio seat's mounted workspace so you can read them as local files. |
read | entity_crud | Get detailed information for one of YOUR OWN staged uploads. |
search | entity_crud | Search your OWN staged_uploads with fuzzy matching. |
stage_from_bytes | document_op | Stage a single local file for import by pushing its bytes directly over MCP (no multipart REST round-trip). |
stage_from_dropbox_share | document_op | Stage every file in a Dropbox SHARE LINK the customer created (no Dropbox token is involved and no credential is held). |
taxonomy_audit_event
| Operation | Mega-tool | What it does |
|---|---|---|
list | entity_crud | List taxonomy_audit_events with filtering and pagination |
read | entity_crud | Get detailed taxonomy audit event information |
search | entity_crud | Search taxonomy_audit_events with fuzzy matching |
taxonomy_draft
| Operation | Mega-tool | What it does |
|---|---|---|
create | entity_crud | Create a new taxonomy draft |
delete | entity_crud | Delete a taxonomy draft |
list | entity_crud | List taxonomy_drafts with filtering and pagination |
read | entity_crud | Get detailed taxonomy draft information |
update | entity_crud | Update an existing taxonomy draft |
taxonomy_snapshot
| Operation | Mega-tool | What it does |
|---|---|---|
create | entity_crud | Create a new taxonomy snapshot |
delete | entity_crud | Delete a taxonomy snapshot |
list | entity_crud | List taxonomy_snapshots with filtering and pagination |
read | entity_crud | Get detailed taxonomy snapshot information |
search | entity_crud | Search taxonomy_snapshots with fuzzy matching |
update | entity_crud | Update an existing taxonomy snapshot |
template
| Operation | Mega-tool | What it does |
|---|---|---|
archive | document_op | Retire a template: set its status to archived. |
create | document_op | Create template. |
duplicate | document_op | Fork a template into a new DRAFT in the same organization — source, schema, tokens and every image asset copied. |
list | document_op | List the Typst document templates THIS organization can render — the answer to "what documents can you produce for me?". |
read | document_op | Read template. |
render | document_op | Render a template to a real PDF and file it in the organization's document library. |
sample | document_op | Show off a template: render it with its own built-in example values and return a one- or two-page PDF (base64) so a user can see what it looks like. |
seed_house_templates | document_op | Install the platform's shipped house templates (branded-report, legal-instrument, customer-deliverable) into THIS organization. |
update | document_op | Patch an existing template. |
validate | document_op | Dry-run a template: substitute the variables, compile it with Typst, and report what happened WITHOUT writing anything — no library document, no render row… |
template_asset
| Operation | Mega-tool | What it does |
|---|---|---|
create | document_op | Upload an image a template's Typst source references by name. |
delete | document_op | Remove an image asset from a template. |
list | document_op | List the image assets a template carries — the files its Typst source can reference by name, e.g. |
template_render
| Operation | Mega-tool | What it does |
|---|---|---|
read | document_op | Read one template render — its status (pending/running/succeeded/failed), how long it took, the error log if it failed, and the library document it produced. |
template_revision
| Operation | Mega-tool | What it does |
|---|---|---|
list | document_op | List a template's version history, newest first. |
read | document_op | Read one frozen revision in full — the exact typ_source, variable_schema and brand_tokens the template carried at that version. |
restore | document_op | Put an earlier revision's content back on the template. |
valve
| Operation | Mega-tool | What it does |
|---|---|---|
create | entity_crud | Create a new valve |
delete | entity_crud | Delete a valve |
list | entity_crud | List valves with filtering and pagination |
read | entity_crud | Get detailed valve information |
search | entity_crud | Search valves with fuzzy matching |
update | entity_crud | Update an existing valve |
valve_photo
| Operation | Mega-tool | What it does |
|---|---|---|
create | entity_crud | Create a new valve photo |
delete | entity_crud | Delete a valve photo |
list | entity_crud | List valve_photos with filtering and pagination |
read | entity_crud | Get detailed valve photo information |
search | entity_crud | Search valve_photos with fuzzy matching |
update | entity_crud | Update an existing valve photo |
version
| Operation | Mega-tool | What it does |
|---|---|---|
create_version | document_op | Create a new version of a document. |
list_versions | document_op | List all versions of a document, ordered by creation date (newest first). |
restore_version | document_op | Restore a document to a previous version. |
viewing_room
| Operation | Mega-tool | What it does |
|---|---|---|
create | entity_crud | Create a new viewing room |
delete | entity_crud | Delete a viewing room |
list | entity_crud | List viewing_rooms with filtering and pagination |
read | entity_crud | Get detailed viewing room information |
search | entity_crud | Search viewing_rooms with fuzzy matching |
update | entity_crud | Update an existing viewing room |
viewing_room_folder
| Operation | Mega-tool | What it does |
|---|---|---|
list | entity_crud | List viewing_room_folders with filtering and pagination |
read | entity_crud | Get detailed viewing room folder information |
visibility
| Operation | Mega-tool | What it does |
|---|---|---|
approve_widen | document_op | Apply a recorded widening request. |
explain_audience | document_op | Who can see this document under its tokens, by class and owning organization. |
get | document_op | The restriction tokens on one document ([] = no restriction), whether it is a compartment document, and whether it is blocked from leaving the platform. |
narrow | document_op | Add restriction tokens to a document (narrowing only: this operation can never remove a token). |
request_widen | document_op | Record a request to remove restriction tokens from a document. |
Parameter schemas and permissions
Parameter schemas and permission codenames are in the full reference — sign in — or call prism_introspect(dimension="capability_search", query="…") with your key.
In the full reference this application appears under agent_command, config_manage, document_op, entity_crud, report_query, smart_action, workflow_action.