MCP Server tools
The MCP Server exposes tools for document management, folder operations, classification, and repository search organized by functional category.
Document Management
Tools for working with documents:
- get_document_properties
- Retrieves all property metadata and current values for a specific document. Returns comprehensive document information including class name, properties, and system metadata.
- get_document_text_extract
- Retrieves the text content extracted from a document. Returns the concatenated text content that can be used for analysis or property extraction workflows.
- update_document_properties
- Updates one or more properties of an existing document by providing property name-value pairs. Returns the updated document with its current property values.
- file_document
- Associates a document with a folder by creating a filing relationship between them. Returns confirmation that the document has been successfully filed in the specified folder.
- unfile_document
- Removes the filing relationship between a document and a folder, disassociating the document from that location. Returns confirmation of the unfiling operation.
Folder Operations
Tools for managing folders:
- browse_folder
- Navigates a folder hierarchy with configurable depth and returns documents, subfolders, or both in a structured tree format. Supports flexible exploration of the repository structure with customizable return types and depth limits.
- create_folder
- Creates a new folder in the repository with specified name, parent location, class type, and optional properties. Returns the newly created folder with its assigned ID and metadata.
- delete_folder
- Permanently removes a folder from the repository by its ID or path. Returns confirmation of the deletion operation.
- get_folder_detail
- Retrieves comprehensive information about a specific folder including its properties and metadata. Returns detailed folder information with all property values.
- get_folder_documents
- Retrieves all documents contained within a specified folder. Returns a list of documents with their properties and metadata.
- get_folder_subfolders
- Lists all immediate child folders within a specified parent folder. Returns folder information including names, IDs, and basic metadata.
- update_folder
- Modifies properties or class of an existing folder. Returns the updated folder with its current property values and metadata.
Classification and Metadata
Tools for working with classes and properties:
- determine_class
- Finds classes matching given keywords by performing fuzzy matching against class names and descriptions. Returns up to 3 best matching classes with relevance scores to help identify the appropriate class for a task.
- list_all_classes
- Lists all available classes for a specific root class type (for example, all Document classes). Returns complete class information including symbolic names, display names, and descriptions for the specified root class.
- list_root_classes
- Lists all available root class types in the repository (for example, Document, Folder). Returns the valid root class names that can be used with other class-related tools.
- get_class_property_descriptions
- Retrieves all property metadata for a specified class including system and custom properties. Returns comprehensive property information with symbolic names, display names, data types, and cardinality.
- get_searchable_property_descriptions
- Retrieves only the searchable, user-facing properties for a specified class, excluding system-owned and hidden properties. Returns filtered property metadata suitable for property extraction and search workflows.
- update_document_class
- Changes the class of a document to a different document class type. Returns the reclassified document with its updated class information.
- property_extraction
- Prepares a document for property extraction workflows by retrieving both the document's text content and its class-specific property metadata. Returns the text extract and a filtered list of extractable properties to guide AI-based property value extraction.
Search and Discovery
Tools for searching the repository:
- document_search
- Searches for documents using property-based criteria and optional full-text search terms. Returns matching documents with their properties, ranked by relevance score when using content-based retrieval (CBR).
- repository_object_search
- Performs advanced searches across repository objects (for example, documents or folders) using property-based criteria. Returns matching objects with their properties and metadata based on the specified search conditions.