IBM Content Services MCP Server
Click on "Install Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@IBM Content Services MCP Servershow me documents in the Legal folder"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
IBM Content Services MCP Server
Overview
The IBM Content Services MCP Server provides a standardized interface that enables IBM FileNet Content Manager (FNCM) capabilities to be used by AI models. The server is available in four specialized configurations to support different workflows:
Core Server: Comprehensive document and content management operations
Property Extraction and Classification Server: Document analysis for property extraction and classification
Legal Hold Server: Legal hold management
AI Document Insight Server: Uses virtual table capabilities for Content Assistant vector search combined with property/metadata search, along with document summarization, comparison, and Q&A
Each server can be deployed independently or in combination to support your specific use cases.
Related MCP server: Data Intelligence MCP Server
Server Types and Capabilities
Core Server (core-cs-mcp-server)
Purpose: Comprehensive document and content management operations
Use Cases:
General document lifecycle management (create, update, check-in, check-out, delete)
Folder operations and document filing
Search and retrieval across the repository
Metadata and class management
Resources support for exposing documents as LLM context
Property Extraction and Classification Server (property-extraction-and-classification-cs-mcp-server)
Purpose: Document analysis for property extraction and classification
Dependencies: Requires Core Server for document update operations (e.g., update_document_properties)
Use Cases:
Automated property extraction from document content
Document classification and reclassification workflows
Content-based metadata enrichment
Legal Hold Server (legal-hold-cs-mcp-server)
Purpose: Legal hold management
Use Cases:
Creating and managing legal holds
Placing documents and objects under hold
Tracking held objects
AI Document Insight Server (ai-document-insight-cs-mcp-server)
Purpose: Uses virtual table capabilities for Content Assistant vector search combined with property/metadata search, along with document summarization, comparison, and Q&A
Dependencies:
Requires Core Server for document operations
Requires Persistent Text Extract add-on
Requires Content Assistant add-on
Requires FileNet 5.7.0 IF003 or later
Use Cases:
Content-based document search with metadata filtering using Content Assistant API vector search
Content Assistant API document summaries
Content Assistant API document comparison and analysis
Tools List
Core Server Tools
The Core Server provides 26 tools organized into the following categories:
Document Management (11 tools)
get_document_versions: Retrieves a document's version history, including major and minor version numbers and document IDs for each version.
get_document_text_extract: Extracts text content from a document by retrieving its text extract annotations. If multiple text extracts are found, they are concatenated. IMPORTANT: This functionality requires the Persistent Text Extract add-on to be installed in your object store. See the Prerequisites section for more details.
create_document: Creates a new document in the content repository with specified properties. Can upload files as the document's content if file paths are provided. Requires first calling determine_class and get_class_property_descriptions.
update_document_properties: Updates an existing document's properties without changing its class. Requires first calling get_class_property_descriptions to get valid properties for the document's current class.
update_document_class: Changes a document's class in the content repository. WARNING: Changing a document's class can result in loss of properties if the new class does not have the same properties as the old class. Requires first calling determine_class to get the new class_identifier.
checkin_document: Checks in a document that was previously checked out. Can upload new content files during check-in if file paths are provided.
checkout_document: Checks out a document for editing. Can download the document content to a specified folder path if provided.
cancel_document_checkout: Cancels a document checkout in the content repository, releasing the reservation.
get_document_properties: Retrieves a document from the content repository by ID or path, returning the document object with its properties.
delete_document_version: Deletes a specific document version in the content repository using its document ID.
delete_version_series: Deletes an entire version series (all versions of a document) in the content repository using the version series ID.
Folder Management (7 tools)
create_folder: Creates a new folder in the content repository with specified name, parent folder, and optional class identifier.
delete_folder: Deletes a folder from the repository using its ID or path.
unfile_document: Removes a document from a folder without deleting the document itself.
file_document: Files a document into a folder.
update_folder: Updates an existing folder's properties. Requires first calling determine_class and get_class_property_descriptions.
get_folder_documents: Get documents contained in a folder.
get_folder_detail: Retrieves detailed information about a folder.
Class/Metadata Management (3 tools)
list_root_classes: Lists root classes.
determine_class: Determines the appropriate class based on the available classes and the content of the user's message or context document.
get_class_property_descriptions: Retrieves detailed descriptions of all properties for a specified class.
Search (5 tools)
get_searchable_property_descriptions: Retrieves descriptions of properties that can be used in search operations.
repository_object_search: Searches for repository objects based on specified criteria.
document_search: Searches for documents based on content and/or metadata criteria using full-text CBR search. Can combine content-based search with property filters for precise document discovery. Returns only released versions of documents. Special characters in content search terms are automatically escaped.
lookup_documents_by_name: Searches for documents by matching keywords against document names. Returns a ranked list of matching documents with confidence scores. Useful when you know part of a document's name but not its exact ID or path.
lookup_documents_by_path: Searches for documents based on their location in the folder hierarchy. Matches keywords against folder names and document containment names at each path level. Particularly useful when the user describes a document using path separators (e.g., "/Folder1/Subfolder/document").
Property Extraction and Classification Server Tools
The Property Extraction and Classification Server provides 2 specialized tools for AI-powered document workflows:
property_extraction: Extracts document class, properties metadata, and text content for AI-based property value extraction. This tool determines the document's class, fetches class metadata to identify all available properties (filtering out system and hidden properties), and retrieves the document's text extract content.
list_all_classes: Lists all available classes for a specific root class type. Essential for document reclassification workflows where you need to match document content to the most appropriate class.
Legal Hold Server Tools
The Legal Hold Server provides 6 tools for legal compliance management:
create_hold: Creates a new legal hold with a specified display name.
delete_hold: Removes a legal hold and releases all held objects.
add_object_to_hold: Places an object (document, folder, etc.) under a legal hold.
delete_object_from_hold: Removes an object from a legal hold without deleting the hold itself.
get_held_objects_for_hold: Lists all objects currently under a specific legal hold.
get_holds_by_name: Searches for legal holds by their display name.
AI Document Insight Server Tools
The AI Document Insight Server provides 6 specialized tools that leverage virtual table capabilities for Content Assistant operations:
document_smart_search: Performs a hybrid search combining vector (semantic) search and metadata filtering to find documents. Use this to find relevant documents based on meaning rather than just keywords. Returns only released versions of documents ranked by a GenaiScore.
document_quick_summary: Generates a concise AI-powered summary for one or more provided document IDs. Use this to give the user a quick overview of content without reading the full text.
document_compare_insights: Compares exactly two documents to identify similarities, differences, and version changes. Returns an AI-generated analysis.
document_qa_global: Answers natural language questions by scanning the entire document repository. Use this for broad questions where the specific documents are not known or when looking for patterns across the entire document repository.
document_qa_specific: Answers natural language questions based strictly on the context of specific, selected document. Use this when the user asks about a specific file.
documents_qa_multiple: Answers natural language questions based strictly on the context of selected documents. Use this when the user asks about a set of files.
Resources
What are Resources?
Resources provide read-only access to document content for LLM context. Documents in configured folders are automatically exposed as MCP resources, allowing AI models to reference them during conversations without explicit tool calls.
Important: Resources functionality requires the Persistent Text Extract Add-on to be installed in your object store to retrieve document content. See the Prerequisites section for installation details.
Server-Specific Resource Support
Each server type supports resources with specific folder defaults and optional prefix validation:
Server Type | Default Folder | Prefix Requirement | Description |
Core |
| None | Accepts all documents without prefix validation |
AI Document Insight |
|
| Only loads documents starting with |
Legal Hold |
|
| Only loads documents starting with |
Property Extraction & Classification |
|
| Only loads documents starting with |
Configuration
RESOURCES_FOLDER
Override the default resource folder path for any server:
RESOURCES_FOLDER=/custom/path # Override default folder pathThe RESOURCES_FOLDER value is the path of the folder in your FileNet object store where you should upload your resource documents. The server will automatically discover and register all documents in this folder.
Documents in the configured folder will be:
Automatically registered as resources when the server starts
Available to the LLM with URIs following the pattern:
ibm-cs://{object_store}/documents/{folder_path}/{document_name}Displayed with names in the format:
[IBM CS] {document_name}
RESOURCES_PREFIX_VALIDATION
Control how the server validates document name prefixes:
RESOURCES_PREFIX_VALIDATION=warn # Default: warnValidation Modes:
strict: Documents without matching prefixes are skipped and logged as errors. Recommended for production to ensure clean separation between server types.warn(Default): Documents without matching prefixes are skipped with warnings logged. Good for development and testing.off: No prefix validation performed. All documents in the folder are loaded regardless of naming.
Example for Legal Hold Server:
# Uses default folder: /resources/LegalHold
# Only accepts documents starting with LH_
# Strict validation - logs errors for invalid documents
RESOURCES_PREFIX_VALIDATION=strictSecurity Guidelines
Access Control: The resources folder should only be modifiable by administrative users to prevent tampering with content that will be used by AI models. Configure appropriate folder permissions in your FileNet object store to:
Restrict write/modify access to administrators only
Allow read access for the MCP server business user
Prevent unauthorized users from adding, modifying, or deleting resource documents
Use Cases
Resources are ideal for providing AI models with reference documentation:
Policy documents for compliance guidance
Classification guidelines for document categorization
Standard operating procedures
Regulatory requirements
Best practices documentation
Example
For Core Server (default folder: /resources, no prefix required):
Documents in that folder:
/resources/data_classification_policy.txt/resources/retention_policy.txt
For Property Extraction & Classification Server (default folder: /resources/Classification, requires CL_ or PE_ prefix):
Documents with proper prefixes:
/resources/Classification/CL_data_classification_policy.txt/resources/Classification/CL_retention_policy.txt
Or to load files without prefix validation:
RESOURCES_PREFIX_VALIDATION=offDocuments without prefixes:
/resources/Classification/data_classification_policy.txt/resources/Classification/retention_policy.txt
These documents will be available as resources that the AI can reference when answering questions or making decisions.
Tested Environments
The Content Services MCP Servers have been tested with the following MCP client and LLM combinations:
Claude Desktop: Sonnet 4.5, 4, 3.5 and Haiku 4.5
Watsonx Orchestrate: Llama-3-2-90b-vision-instruct
While other MCP client and LLM combinations have not been tested, they may work with this server. We encourage you to experiment and validate for yourself.
For setup instructions with additional MCP clients, see:
MCP Client Limitations
Some MCP clients have limitations that affect which tools can be used. The following table shows known compatibility issues:
MCP Client | Limitation | Affected Tools |
Watson Orchestrate | Does not support complex Pydantic classes as input | • |
Watson Orchestrate | Sporadic 'Invalid tool call object' error when agent tries to invoke MCP tools | • |
Note: These limitations are due to the MCP client's input handling capabilities, not the MCP server itself.
Setup and Configuration
Prerequisites
on macOS:
brew install uvon Windows: see link above
Access to a FileNet CPE server with Content Services GraphQL API (CS-GQL) installed
Required Add-ons
Important: The following add-ons must be installed in your FileNet object store for specific server functionality:
Persistent Text Extract Add-on (Required for Core, Property Extraction, and AI Document Insight Servers)
Enables extraction and storage of text content from documents
Required for:
Core Server:
get_document_text_extracttool and Resources functionalityProperty Extraction and Classification Server:
property_extractiontoolAI Document Insight Server: All tools (
document_smart_search,document_quick_summary,document_compare_insights,document_qa_global)
Without this add-on, document content retrieval features will not work
For installation instructions, refer to the IBM Documentation on Installing the Persistent Text Add-on
Content Assistant Add-on (Required for AI Document Insight Server only)
Provides AI-powered search, summarization, comparison, and Q&A capabilities
Required for: AI Document Insight Server (all tools)
Includes vector search and GenAI model integration
For installation instructions, refer to the IBM Content Assistant documentation
FNCM Deployment Version Requirements
Version 5.5.8 or later (Required for Core, Legal Hold, and Property Extraction and Classification Servers)
Provides the base GraphQL API support required for core content management operations
Required for: Core Server, Legal Hold Server, and Property Extraction and Classification Server (all tools)
Version 5.7.0 IF003 or later (Required for AI Document Insight Server only)
Provides GraphQL virtual table support required for AI document insight operations
Required for: AI Document Insight Server (all tools)
Configuration
The Content Services MCP Servers require several environment variables to connect to your FileNet CPE server:
Required Environment Variables
Environment Variable | Description | Default |
| Content Services GraphQL API endpoint URL (required) | - |
| Authentication username (required) | - |
| Authentication password (required) | - |
| Object store identifier (required) | - |
Optional Environment Variables
Environment Variable | Description | Default |
| Whether SSL is enabled. Can be set to |
|
| Whether SSL is enabled for token endpoint. Can be set to |
|
| Token refresh interval in seconds |
|
| OAuth token URL | - |
| OAuth grant type | - |
| OAuth scope | - |
| OAuth client ID | - |
| OAuth client secret | - |
| Request timeout in seconds |
|
| Number of connection pool connections |
|
| Maximum pool size |
|
| Logging level for the server. Valid values: |
|
| Folder path in the repository containing documents to expose as MCP resources. Each server type has a default folder (see Resources section). Documents will be automatically registered as resources with URIs following the pattern | Server-specific (see Resources) |
| Controls prefix validation for resource documents. Valid values: |
|
Cloud Pak for Business Automation Environment Variables
Environment Variable | Description | Default |
| Zen url to send IAM token for exchange to Zen token, for example: /v1/preauth/validateAuth | - |
| Whether SSL is enabled for Zen exchange route. Can be set to |
|
| IAM url to send user/pwd or client_id/client_secret to IAM to get back IAM token, for example: /idprovider/v1/auth/identitytoken | - |
| Whether SSL is enabled for IAM route. Can be set to |
|
| IAM grant type | - |
| IAM scope | - |
| if grant type is password, specify the IAM user | - |
| if grant type is password, specify the IAM password | - |
| if grant type is client_credentials, specify the IAM client id | - |
| if grant type is client_credentials, specify the IAM client secret | - |
SSL Configuration Best Practices
For SSL configuration (SSL_ENABLED, TOKEN_SSL_ENABLED, ZENIAM_ZEN_SSL_ENABLED, and ZENIAM_IAM_SSL_ENABLED), you have three options:
Use System Certificates (Recommended for Production): Set to
trueto use your system's certificate store.Provide Custom Certificate Path: Set to the file path of your certificate (e.g.,
/path/to/certificate.pem).Disable SSL Verification (Not Recommended for Production): Set to
falseto disable SSL verification.
Security Warning: Disabling SSL verification (
false) should only be used in testing environments. For production deployments, always use proper certificate validation to ensure secure communications.
Authentication Methods
The server supports three authentication methods:
Basic Authentication
Set the following environment variables:
SERVER_URL=https://your-graphql-endpoint
USERNAME=your_username
PASSWORD=your_password
OBJECT_STORE=your_object_store
SSL_ENABLED=your_path_to_graphql_certificate | true | falseOAuth Authentication
Set the following environment variables:
SERVER_URL=https://your-graphql-endpoint
USERNAME=your_username
PASSWORD=your_password
TOKEN_URL=https://your-oauth-server/token
GRANT_TYPE=password
SCOPE=openid
CLIENT_ID=your_client_id
CLIENT_SECRET=your_client_secret
OBJECT_STORE=your_object_storeZen/IAM Authentication
An example of ZEN/IAM environment variables when using USER/PASSWORD and SSL to all external servers
SERVER_URL=https://your-graphql-endpoint
SSL_ENABLED=your_path_to_graphql_certificate| true | false
OBJECT_STORE=your_object_store
ZENIAM_ZEN_URL=https://your-zen-exchange-route
ZENIAM_ZEN_SSL_ENABLED=your_path_to_zen_exchange_route_certicate | true | false
ZENIAM_IAM_URL=https://your-IAM-route
ZENIAM_IAM_SSL_ENABLED=your_path_to_IAM_route_certicate | true | false
ZENIAM_IAM_GRANT_TYPE=password
ZENIAM_IAM_SCOPE=openid
ZENIAM_IAM_USER=your_user_name
ZENIAM_IAM_PASSWORD=your_user_passwordIntegration with MCP Clients/Agent Frameworks
Claude Desktop Configuration
Open Claude Desktop Settings:
On macOS, click the Claude menu in the top menu bar and select Settings.
On Windows, access Settings from the Claude application.

Navigate to the Developer tab and click Edit Config:
macOS:
~/Library/Application Support/Claude/claude_desktop_config.jsonWindows:
%APPDATA%\Claude\claude_desktop_config.json
Add one of the following configuration examples to the claude_desktop_config.json file:
Option 1: Using local installation (if you've cloned the repository)
{ "mcpServers": { "core-cs-mcp-server": { "command": "/path/to/your/uvx", "args": [ "--from", "/path/to/your/cs-mcp-server", "core-cs-mcp-server" ], "env": { "USERNAME": "your_username", "PASSWORD": "your_password", "SERVER_URL": "https://your-graphql-server/content-services-graphql/graphql", "OBJECT_STORE": "your_object_store" } } } }Option 2: Installing directly from GitHub (recommended)
{ "mcpServers": { "core-cs-mcp-server": { "command": "uvx", "args": [ "--from", "git+https://github.com/ibm-ecm/ibm-content-services-mcp-server", "core-cs-mcp-server" ], "env": { "USERNAME": "your_username", "PASSWORD": "your_password", "SERVER_URL": "https://your-graphql-server/content-services-graphql/graphql", "OBJECT_STORE": "your_object_store" } } } }Option 3: Multi-Server Setup (Core + Property Extraction + Legal Hold + AI Document Insight)
{ "mcpServers": { "core-cs-mcp-server": { "command": "uvx", "args": [ "--from", "git+https://github.com/ibm-ecm/ibm-content-services-mcp-server", "core-cs-mcp-server" ], "env": { "USERNAME": "your_username", "PASSWORD": "your_password", "SERVER_URL": "https://your-graphql-server/content-services-graphql/graphql", "OBJECT_STORE": "your_object_store" } }, "property-extraction-cs-mcp-server": { "command": "uvx", "args": [ "--from", "git+https://github.com/ibm-ecm/ibm-content-services-mcp-server", "property-extraction-and-classification-cs-mcp-server" ], "env": { "USERNAME": "your_username", "PASSWORD": "your_password", "SERVER_URL": "https://your-graphql-server/content-services-graphql/graphql", "OBJECT_STORE": "your_object_store" } }, "legal-hold-cs-mcp-server": { "command": "uvx", "args": [ "--from", "git+https://github.com/ibm-ecm/ibm-content-services-mcp-server", "legal-hold-cs-mcp-server" ], "env": { "USERNAME": "your_username", "PASSWORD": "your_password", "SERVER_URL": "https://your-graphql-server/content-services-graphql/graphql", "OBJECT_STORE": "your_object_store" } }, "ai-document-insight-cs-mcp-server": { "command": "uvx", "args": [ "--from", "git+https://github.com/ibm-ecm/ibm-content-services-mcp-server", "ai-document-insight-cs-mcp-server" ], "env": { "USERNAME": "your_username", "PASSWORD": "your_password", "SERVER_URL": "https://your-graphql-server/content-services-graphql/graphql", "OBJECT_STORE": "your_object_store" } } } }Restart Claude Desktop:
Simply closing the window is not enough, Claude Desktop must be stopped and restarted:
on macOS: Claude > Quit
on Windows: File > Exit
Check Available Tools:
To see all the available tools in Claude Desktop, proceed as follows:
first click the settings icon, and you should see:

then click
core-cs-mcp-server, and you should see all your tools:
Note: The JSON configuration examples above show only the minimum required environment variables. For a complete list of all possible configuration options, refer to the Environment Variables tables above.
Watson Orchestrate (WxO) Configuration
This section explains how to augment IBM watsonx Orchestrate with the Content Services MCP Servers, enabling watsonx Orchestrate to interact with IBM FileNet Content Management during user interactions in a chat.
You can configure one or multiple servers depending on your needs:
Core Server: For general document management operations
Property Extraction and Classification Server: For AI-powered document analysis (requires Core Server for document updates)
Legal Hold Server: For legal compliance workflows
The configuration steps below use the Core Server as an example, but the same process applies to other servers by changing the server name and install command.
Configuration
1. Configure Connection Variables
For SaaS or on-premises offering (UI):
Click the main menu icon
Navigate to Manage > Connections
Click Add New Connection
Enter connection ID and display name
Click Next
You will now configure draft connection details (test environment)
Select authentication type dropdown to be Key value pair
Enter each required variable:
SERVER_URL: Your Content Services GraphQL API endpoint URLUSERNAME: Authentication usernamePASSWORD: Authentication passwordOBJECT_STORE: Object store identifier
Enter any optional variables as needed (e.g.,
SSL_ENABLED,TOKEN_REFRESH, etc.)Click Next when done
Now you will enter your live connection environment variables
Select authentication type dropdown to be Key value pair
Enter the same required variables as above
Enter any optional variables as needed
Select the preferred credential type
Click Add Connection
For ADK (Application Development Kit):
For creating connections using the ADK CLI, please refer to the official documentation.
2. Create an agent
Click the main menu icon
Navigate to Build > Agent Builder

Navigate to All agents
Click Create agent + to add a new agent

Choose Create from scratch
Enter a Name (e.g.,
Core Content Services Agent)Enter a Description (e.g.,
This agent enables interaction with FileNet Content Management.)Click Create

3. Augment the agent with the Core Content Services MCP Server
Navigate to the Toolset section, click Add tool +

Click Import

Click Import from MCP server

Click Add MCP server

Enter a Server name without any space characters (e.g.,
core-cs-mcp-server)Optionally enter a Description (e.g.,
This MCP Server connects to FileNet Content Platform Engine, enabling content management operations.)Enter an Install command:
uvx --from git+https://github.com/ibm-ecm/ibm-content-services-mcp-server core-cs-mcp-serverFor other servers, use these install commands:
Property Extraction and Classification Server:
uvx --from git+https://github.com/ibm-ecm/ibm-content-services-mcp-server property-extraction-and-classification-cs-mcp-serverLegal Hold Server:
uvx --from git+https://github.com/ibm-ecm/ibm-content-services-mcp-server legal-hold-cs-mcp-serverAI Document Insight Server:
uvx --from git+https://github.com/ibm-ecm/ibm-content-services-mcp-server ai-document-insight-cs-mcp-server
Note: If you encounter issues with git-based installation (e.g., "Git executable not found"), you can use this alternative command that downloads directly from GitHub without requiring git:
uvx --from https://github.com/ibm-ecm/ibm-content-services-mcp-server/archive/refs/heads/main.zip core-cs-mcp-serverReplace
core-cs-mcp-serverwith the name of the server you want to install (property-extraction-and-classification-cs-mcp-server,legal-hold-cs-mcp-server, orai-document-insight-cs-mcp-server).Click Connect
If you see "Connection successful", click Done

Set the Activation toggle to On for the tools you want to enable

Associate your previously created connection with this agent
4. Deploy the agent
Click Deploy

In the popup, Click Deploy again
5. Let the agent be used in chats
Click the main menu icon
Navigate to Chat
Click the newly created agent

Example Workflow
Once configured, you can interact with your FileNet repository through natural language in watsonx Orchestrate chats, depending on which tool you've enabled. For example:
"Find all documents containing the pdf in its document title"
"Create a new folder called Project Z"

Click Show Reasoning in any response to see the details of the operations performed.

Usage
Running Servers Directly
If you have a local copy of the repository, you can run any server directly with environment variables:
Core Server:
USERNAME=your_username PASSWORD=your_password SERVER_URL=https://your-graphql-server/content-services-graphql/graphql OBJECT_STORE=your_object_store uvx --from /path/to/your/cs-mcp-server core-cs-mcp-serverProperty Extraction and Classification Server:
USERNAME=your_username PASSWORD=your_password SERVER_URL=https://your-graphql-server/content-services-graphql/graphql OBJECT_STORE=your_object_store uvx --from /path/to/your/cs-mcp-server property-extraction-and-classification-cs-mcp-serverLegal Hold Server:
USERNAME=your_username PASSWORD=your_password SERVER_URL=https://your-graphql-server/content-services-graphql/graphql OBJECT_STORE=your_object_store uvx --from /path/to/your/cs-mcp-server legal-hold-cs-mcp-serverAI Document Insight Server:
USERNAME=your_username PASSWORD=your_password SERVER_URL=https://your-graphql-server/content-services-graphql/graphql OBJECT_STORE=your_object_store uvx --from /path/to/your/cs-mcp-server ai-document-insight-cs-mcp-serverIntegration with AI Agents
The Content Services MCP Servers can be integrated with AI Agents that support the MCP protocol. Depending on which server(s) you deploy, the AI Agent can:
Core Server capabilities:
Access and retrieve document properties
Extract text from documents
Create, update, check-in, and check-out documents
Manage folders and document classifications
Execute searches
Access resources for LLM context
Property Extraction and Classification Server capabilities:
Extract property values from document content using AI
List and match document classes for reclassification
Legal Hold Server capabilities:
Create and manage legal holds
Place objects under hold
Track and query held objects
AI Document Insight Server capabilities:
Perform AI-powered hybrid searches combining vector search with metadata filtering
Generate document summaries using GenAI
Compare documents and analyze differences
Answer natural language questions across the entire document repository
Answer natural language questions based on one document or a set of documents
Example Workflows
Core Server Workflow: Search and Document Management
Search and Discovery:
Users typically start with descriptive information (name, content, keywords) rather than IDs
The AI Agent first uses search tools to locate relevant objects:
get_searchable_property_descriptionsto discover valid search propertiesrepository_object_searchfor property-based searches
Search results include object IDs needed for subsequent operations
Document Retrieval:
Once an object ID is obtained through search, the AI Agent can retrieve:
Document properties using the ID
Version history
Text content (requires Persistent Text Extract Add-on to be installed)
Annotations
Document Creation: Users can ask the AI Agent to create new documents with specific properties and content.
Document Update:
After identifying a document through search, the AI Agent can:
Check out the document using its ID
Update properties or content
Check the document back in
Folder Operations:
Folders can be identified by path or by ID from search results
Documents can be filed/unfiled using both document and folder IDs
Property Extraction and Classification Workflow
Requires: Core Server (for document updates)
Property Extraction:
Use
property_extractiontool with a document IDThe tool returns:
Document class information
All available properties for that class (excluding system/hidden properties)
Document text content
AI analyzes the text and extracts appropriate property values
Use Core Server's
update_document_propertiesto save the extracted values
Document Classification:
Use
list_all_classesto get all available document classesAI analyzes document content and matches it to the most appropriate class
Use Core Server's
update_document_classto reclassify the document
Legal Hold Workflow
Creating a Hold:
Use
create_holdwith a descriptive name (e.g., "Litigation ABC vs XYZ")Returns the hold object with its ID
Placing Objects Under Hold:
Identify documents using Core Server search tools (if needed)
Use
add_object_to_holdwith the hold ID and object IDRepeat for all relevant documents/objects
Managing Holds:
Use
get_holds_by_nameto find holds by nameUse
get_held_objects_for_holdto see all objects under a specific holdUse
delete_object_from_holdto release specific objectsUse
delete_holdto remove the hold entirely (releases all objects)
Note: Most operations that modify or access specific objects require an object ID, which is typically obtained through a search operation first. This workflow pattern ensures users can work with objects by their meaningful attributes rather than requiring them to know technical identifiers upfront.
License
See the LICENSE file for details.
# Copyright contributors to the IBM Content Services MCP Server project
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.Available Tools
30 toolscancel_document_checkoutA
Cancels a document checkout in the content repository.
:param identifier: The identifier (required). This can be either a reservation_id or document_id. Reservation ID (GUID) is prioritized. Otherwise, we use document_id (GUID).
:returns: If successful, returns a Document object with its updated properties. If unsuccessful, returns a ToolError with details about the failure.
| Name | Required | Description | Default |
|---|---|---|---|
| identifier | Yes |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries full burden. It discloses that the tool returns a Document object on success and a ToolError on failure, and explains the identifier parameter's dual nature and prioritization. However, it could be more explicit about side effects like unlocking the document or permission requirements.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is very concise: two paragraphs with no fluff. The first sentence states the core functionality, followed by a clear parameter description and return value documentation. Every sentence serves a purpose.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a tool with one required parameter and an output schema (not shown), the description covers the parameter semantics and return value. It could improve by providing examples or clarifying how the identifier string distinguishes between reservation_id and document_id, but it is largely complete.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 0%, so the description must explain the parameter. It does so thoroughly: identifier can be reservation_id or document_id, with reservation_id prioritized. This adds significant meaning beyond the schema's 'string' type.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the verb 'cancels' and the resource 'document checkout', making the tool's purpose unambiguous. It is distinct from sibling tools like 'checkout_document' and 'checkin_document'.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description implies that the tool is used to undo a checkout, but it does not explicitly state when to use it or when not to, nor does it mention alternatives. The context from sibling tools helps, but the description itself lacks explicit guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
checkin_documentB
Checks in a document in the content repository with specified properties.
:param identifier: The identifier (required). This can be either a reservation_id or document_id. Reservation ID (GUID) is prioritized. Otherwise, we use document_id (GUID). :param checkin_action: Check-in action parameters for the document. :param document_properties: Properties to update for the document during check-in. :param file_paths: Optional list of file paths to upload as the document's content.
:returns: If successful, returns a Document object with its updated properties. If unsuccessful, returns a ToolError with details about the failure.
| Name | Required | Description | Default |
|---|---|---|---|
| file_paths | No | ||
| identifier | Yes | ||
| checkin_action | No | ||
| document_properties | No |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description must convey behavioral traits. It discloses return type (Document or ToolError) and the fact that properties are updated, but does not mention required permissions, side effects, or prerequisites like checkout state.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is structured as a docstring with parameter explanations, which is clear but somewhat verbose. It is appropriately sized for four parameters but redundant in places (e.g., 'Check-in action parameters for the document').
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The tool has four parameters and returns an object. The description covers basic functionality but omits important context like prerequisites (e.g., document must be checked out) and detailed error conditions. Given the complexity, it is adequate but not complete.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 0% at the top level, but nested objects have descriptions. The description adds meaning for identifier (prioritization logic) and file_paths (file uploads), but other parameters are merely restated without additional guidance beyond what the schema provides.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the verb 'Checks in' and the resource 'document in the content repository', which differentiates from sibling tools like checkout_document. However, it does not explicitly contrast with siblings, missing a 5.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explains the identifier parameter prioritization but lacks explicit guidance on when to use this tool versus alternatives (e.g., checkout_document). Usage context is implied but not stated.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
checkout_documentA
Checks out a document in the content repository.
:param identifier: The document id or path (required). This can be either the document's ID (GUID) or its path in the repository (e.g., "/Folder1/document.pdf"). :param document_properties: Properties to update for the document during check-out. :param checkout_action: Check-out action parameters for the document. :param download_folder_path: Optional path to a folder where the document content will be downloaded. If not provided but content download is needed, the user will be prompted to provide it.
:returns: If successful, returns a Document object with its updated properties. If unsuccessful, returns a ToolError with details about the failure.
| Name | Required | Description | Default |
|---|---|---|---|
| identifier | Yes | ||
| checkout_action | No | ||
| document_properties | No | ||
| download_folder_path | No |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Without annotations, the description partially discloses behavior: it mentions document property updates, optional download, and failure returns a ToolError. However, it does not clarify locking, permission requirements, or side effects, which are important for a checkout action.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is concise and well-structured with a docstring format. It front-loads the main purpose and then lists parameters. Minor redundancy with return info, but overall efficient.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given no annotations and the presence of an output schema, the description covers the essential aspects: input parameters, return type (Document or ToolError), and a key behavioral note about download folder prompting. It is adequate for a checkout operation.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The description adds significant meaning beyond the input schema. It explains that 'identifier' can be an ID or path (e.g., '/Folder1/document.pdf'), and that 'download_folder_path' is optional and may prompt the user. Schema coverage is 0%, so the description fully compensates with clear parameter semantics.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states 'Checks out a document in the content repository' which is a clear verb-resource pair. It distinguishes from sibling tools like cancel_document_checkout and checkin_document by explicitly focusing on the check-out action.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description does not provide explicit guidelines on when to use this tool versus alternatives. It lacks context on prerequisites or when not to use it, leaving the agent to infer from the tool name and sibling list.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
create_documentA
PREREQUISITES IN ORDER: To use this tool, you MUST call two other tools first in a specific sequence.
determine_class tool to get the class_identifier.
get_class_property_descriptions to get a list of valid properties for the given class_identifier
Description: Creates a document in the content repository with specified properties.
:param class_identifier: The class identifier for the document. If not provided, defaults to "Document". :param id: The unique GUID for the document. If not provided, a new GUID with curly braces will be generated. :param document_properties: Properties for the document including name, content, mimeType, etc. :param file_in_folder_identifier: The identifier or path of the folder to file the document in. This always starts with "/". :param checkin_action: Check-in action parameters. CheckinMinorVersion should always be included. :param file_paths: Optional list of file paths to upload as the document's content.
:returns: If successful, returns a Document object with its properties. If unsuccessful, returns a ToolError with details about the failure.
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | ||
| file_paths | No | ||
| checkin_action | No | ||
| class_identifier | No | ||
| document_properties | No | ||
| file_in_folder_identifier | No |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Without annotations, the description carries the full burden. It explains return types (Document object or ToolError), default behaviors (GUID generation, class_identifier default), and a constraint (file_in_folder_identifier starts with '/'). It lacks details on authentication or side effects, but for a creation tool, this is sufficient.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is somewhat verbose with repeated headers ('Description:') and a bold prerequisites section. While the information is front-loaded, it could be more streamlined. Two clear improvements: remove the redundant 'Description:' line and integrate prerequisites more concisely.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool's complexity (6 parameters, nested objects) and the presence of an output schema, the description covers creation prerequisites, parameter roles, and return types. It could mention idempotency or naming constraints, but overall it provides enough context for correct invocation.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 0%, so the description must compensate. It provides meaningful explanations for all six parameters, including defaults, format requirements, and behavioral notes (e.g., 'CheckinMinorVersion should always be included'), adding value beyond the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description explicitly states 'Creates a document in the content repository with specified properties,' clearly indicating the verb ('creates') and resource ('document'). This distinguishes it from sibling tools like checkout, checkin, or update, which have different primary actions.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides explicit prerequisites in a numbered sequence, stating that determine_class and get_class_property_descriptions must be called first. While it doesn't explicitly state when not to use the tool, the creation use case is clear and different from siblings.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
create_folderA
PREREQUISITES IN ORDER: To use this tool, you MUST call two other tools first in a specific sequence.
determine_class tool to get the class_identifier.
get_class_property_descriptions to get a list of valid properties for the given class_identifier
Creates a folder in the content repository with specified properties. This tool interfaces with the GraphQL API to create a new folder object with the provided parameters.
:param name string Yes The name of the folder to be created. :param parent_folder string Yes The identifier of the parent folder where this folder will be created. :param class_identifier string No The class identifier for the folder. If not provided, defaults to "Folder". :param id string No The unique identifier for the folder. If not provided, a new UUID with curly braces will be generated (format: {uuid}). :param folder_properties FolderPropertiesInput No properties of to set.
:returns: If successful, return a folder object with the following properties: id: The identifier of the created folder name: The name of the folder parent_folder: The identifier of the parent folder creator: The user who created the folder class_identifier: The class identifier of the folder Else, return a ToolError instance that describes the error.
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | ||
| name | Yes | ||
| parent_folder | Yes | ||
| class_identifier | No | ||
| folder_properties | No |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations provided, but the description details parameter behaviors (e.g., id generation format), prerequisites, and return value (folder object or ToolError). Lacks details on permissions or conflict handling.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Structured with prerequisites first, then main description, parameter list, and returns. Front-loaded with important usage info, though the param list uses non-standard format and could be more concise.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Covers prerequisites, all parameters, and return values. Could be improved by explaining error conditions and folder_properties structure more clearly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 0%, but the description lists each parameter with type and description. However, folder_properties is poorly described as 'properties of to set' which adds little value beyond the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states 'Creates a folder in the content repository' and lists specific parameters. It distinguishes from sibling tools like create_document and delete_folder by focusing on folder creation.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicitly states prerequisites in order: must call determine_class and get_class_property_descriptions first. This provides clear sequential guidance for the agent.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
delete_document_versionADestructive
Deletes a specific document version in the content repository.
:param identifier: The document id or path (required). This can be either the document's ID (GUID) or its path in the repository (e.g., "/Folder1/document.pdf").
:returns: If successful, returns the deleted Document id. If unsuccessful, returns a ToolError with details about the failure.
| Name | Required | Description | Default |
|---|---|---|---|
| identifier | Yes |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations include destructiveHint=true, and the description adds that failure results in a ToolError. However, it does not disclose necessary preconditions (e.g., permissions, checkout status) or side effects beyond deletion. Some value added but incomplete.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is concise with two clear paragraphs: purpose, then parameter and return details. No wasted words, though could be slightly more structured (e.g., bullet points for clarity).
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a simple tool with one parameter and an output schema, the description covers purpose, parameter, and return value. However, it misses behavioral context like when deletion is allowed or restrictions (e.g., cannot delete last version). Could be more complete.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 0%, but the description fully explains the single parameter 'identifier': it is required, can be a GUID ID or repository path, with an example. This compensates for the lack of schema descriptions.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states 'Deletes a specific document version in the content repository,' specifying the verb, resource, and scope. It effectively distinguishes from sibling tools like 'delete_version_series' or 'delete_folder'.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides parameter requirements and return information but lacks explicit guidance on when to use this tool over alternatives like 'delete_version_series' or preconditions (e.g., version not checked out). Usage context is minimal.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
delete_folderA
Deletes a folder in the content repository. This tool interfaces with the GraphQL API to delete a folder object with the provided id.
:param id_or_path string Yes The unique identifier or path for the folder. If not provided, an error will be returned.
:returns: If successful, return the folder id. Else, return a ToolError instance that describes the error.
| Name | Required | Description | Default |
|---|---|---|---|
| id_or_path | Yes |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description discloses that it returns the folder id on success or a ToolError on failure. However, with no annotations provided, it omits critical behavioral details like whether deletion is recursive, permission requirements, or irreversibility.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is reasonably concise, using a docstring-like format with param and returns. It is front-loaded with the main action but could be more streamlined by removing redundant statements about error returns.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool's simplicity (single required parameter) and the presence of an output schema, the description covers the basics. However, it lacks important context about effects on children, permissions, and when to use this over other folder operations.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The description adds a semantic description for the id_or_path parameter, clarifying it accepts either an ID or a path. Despite the schema having 0% description coverage, this is only a minimal addition beyond the parameter name itself.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The tool name and description clearly state that it deletes a folder, using a specific verb and resource. It distinguishes itself from sibling tools like create_folder and update_folder by focusing on deletion.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description implies usage when a folder deletion is needed, but provides no explicit guidance on when to use this tool versus alternatives (e.g., update_folder) or when not to use it.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
delete_version_seriesADestructive
Deletes an entire version series (all versions of a document) in the content repository.
:param version_series_id: The version series ID (GUID) to delete. If you don't have the version series ID, first call get_document_property on the document to get the version series ID.
:returns: If successful, returns the deleted version series ID as a string. If unsuccessful, returns a ToolError with details about the failure.
| Name | Required | Description | Default |
|---|---|---|---|
| version_series_id | Yes |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Beyond the destructiveHint annotation, the description clarifies that it deletes all versions of a document and mentions potential failure with ToolError. This adds useful behavioral context.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is concise (a few sentences), front-loaded with the core action, and every sentence provides necessary information without fluff.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a single-parameter destructive tool with annotations, the description is largely complete. It covers the parameter, return value, and error handling, though it omits permissions or side effects.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The description explains how to obtain the version_series_id (via get_document_property), which adds meaning beyond the schema's simple string type. With 0% schema coverage, this compensation is valuable.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states it deletes an entire version series (all versions of a document), distinguishing it from sibling tools like delete_document_version which deletes a single version.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Provides explicit guidance on obtaining the version series ID via get_document_property if not known. However, it does not explicitly state when to prefer this tool over alternatives like delete_document_version.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
determine_classA
Find classes that match the given keywords by looking for substring matches in class names and descriptions.
IMPORTANT:
To get a list of all valid class names that can be used with this tool, you MUST first call the list_root_classes_tool tool.
:param root_class: The root class to search within (eg. "Document", "Folder") :param keywords: Up to 3 words from the user's message that might contain the class's name
:returns: A list of up to 3 matching classes with their scores, or a ToolError if no matches are found Each match is a ClassMatch object with class_name and score fields
| Name | Required | Description | Default |
|---|---|---|---|
| keywords | Yes | ||
| root_class | Yes |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations exist, so the description must disclose behavior. It explains substring matching, return of up to 3 classes with scores, and error on no matches. However, it omits details like case sensitivity or score meaning, leaving some gap.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Description is concise with a clear first sentence, structured :param/:returns format, and no redundant text. Each sentence adds value.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the output schema existence and tool complexity, the description covers search method, parameters, return format, and prerequisite, making it fully adequate for agent use.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 0%, but the description fully compensates by explaining root_class and keywords with examples and constraints (e.g., 'up to 3 words'), adding meaning beyond type definitions.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description explicitly states the tool finds classes by substring matching in names and descriptions, clearly distinguishing it from siblings like list_root_classes or get_class_property_descriptions.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides explicit prerequisite: 'MUST first call list_root_classes_tool' for valid class names, and gives parameter constraints (up to 3 keywords) and examples (root_class like 'Document').
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
document_searchA
PREREQUISITES IN ORDER: To use this tool, you MUST call two other tools first in a specific sequence.
determine_class tool to get the class_name for search_class. The search class must be a document class or a document subclass.
get_searchable_property_descriptions to get a list of valid property_name for search_properties
Description: This tool will execute a request to search for documents based on content and the metadata criteria.
:param search_term: The words for CBR search. This will be used to search for documents based on their CBR indexed content and metadata If empty string or None, then only search by metadata.
:param search_parameters (SearchParameters): provide parameters search_class and addiontal search conditions. Note the search_class is filled in by determine_class tool. search_properties inside search_parameters include any property being searched for and any search conditions. Note: additional properties beside the search_class are used to narrow down the result set, not to expand the result set, ie it does not make sense to support prompt such as: get me all XXXCBRDocClass documents that are created by XXXuser OR contains 'XXX Content' . For CBR, Content search will be carried out first to get a result set and additional properties are placed on this result set to narrow it down.
:returns: the released versions of documents that fit the search criteria. - if search by content and CBR is not enabled, tool will return a ToolError.
Example of search by content and class is CBR enabled: Prompt: get me all XXXCBRDocClass documents that are created by XXXuser and contains 'XXX Content' Request: { "doc_class": "XXXCBRDocClass", "max_results": 50, "search_parameters": { "search_class": "XXXCBRDocClass", "search_properties": [ { "operator": "=", "property_name": "Creator", "property_value": "XXXuser" } ] }, "search_term": "XXX Content" }
| Name | Required | Description | Default |
|---|---|---|---|
| max_results | No | ||
| search_term | No | ||
| search_parameters | Yes | Complete set of parameters for executing a repository search. |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description fully discloses behavior: content search is performed first and then narrowed by metadata properties, search_term empty means metadata-only search, only released versions are returned, and a ToolError occurs if CBR is not enabled. This is comprehensive.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is long but well-structured with sections for prerequisites, parameter details, notes, and an example. Every part serves a purpose, though the prerequisites could be slightly condensed. Overall, it earns its length for the tool's complexity.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool's complexity, nested parameters, and dependencies on other tools, the description is complete: it covers prerequisites, parameter semantics, behavioral notes, error conditions, and an example. An output schema exists, so return value details are not required. No gaps remain.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Despite low schema description coverage (33%), the description adds substantial meaning: it explains search_term usage, how search_parameters inherit from prerequisites, the narrowing behavior of search_properties, and provides a complete example. This far exceeds the schema's minimal descriptions.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states it searches documents by content and metadata criteria. It distinguishes itself from sibling tools like repository_object_search (searches other objects) and lookup_documents_by_name/path (different search methods), making its purpose specific and unambiguous.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explicitly lists a prerequisite sequence: must first call determine_class and get_searchable_property_descriptions. It also mentions that the tool errors if CBR is not enabled for content search, providing clear guidance on when to use and what conditions are required.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
download_document_contentARead-only
Downloads a document's original content (e.g., the raw PDF file) from the content repository to a local folder WITHOUT checking the document out.
This is a read-only operation: it places NO reservation/lock on the document, so no checkin_document or cancel_document_checkout call is needed afterwards. Use this tool when the original file bytes are needed (e.g., for downstream image or PDF processing) rather than the extracted text.
:param identifier: The document id or path (required). This can be either the document's ID (GUID) or its path in the repository (e.g., "/Folder1/document.pdf"). :param download_folder_path: Path to the folder where the document content will be saved (required). The folder is created if it does not exist.
:returns: If successful, returns a dictionary containing: - document_id (str): The document's ID. - files (list): One entry per downloaded content element, each containing: - file_path (str): The full path of the downloaded file. - retrieval_name (str): The content element's original file name. - content_type (str): The MIME type of the content. - content_size (int): The size of the content in bytes. If unsuccessful, returns a ToolError with details about the failure.
| Name | Required | Description | Default |
|---|---|---|---|
| identifier | Yes | ||
| download_folder_path | Yes |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
While annotations already declare readOnlyHint=true, the description adds significant behavioral context: it confirms the operation places no reservation/lock, so no checkin or cancel is needed. It also details the return format (dictionary with document_id, files list) and failure mode (ToolError), which go beyond the annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is well-structured with a clear opening, usage context, parameter documentation using :param tags, and return documentation using :returns. It is concise but comprehensive, with no superfluous information.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool's low complexity (2 parameters, output schema present), the description is fully complete. It covers purpose, behavior, parameters, return format, and error handling. No missing details are needed for an agent to invoke it correctly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The input schema has 0% description coverage, but the description fully explains both parameters: identifier can be an ID or path, and download_folder_path is a required folder path that is created if missing. This adds critical meaning beyond the basic schema types.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states that the tool downloads original content (e.g., raw PDF) without checking out the document, distinguishing it from sibling tools like checkout_document, checkin_document, and others. The verb 'downloads' and resource 'document content' are specific and unambiguous.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explicitly tells when to use this tool: when original file bytes are needed instead of extracted text. It also clarifies that no checkin or cancel checkout is needed, implying it's a read-only alternative to checkout. However, it does not explicitly state when not to use it, but the contrast with sibling tools provides indirect guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
extract_survey_dataARead-only
Reads an easement document with a vision model and returns the structured survey data needed to map it — regardless of whether the document is a clean text PDF, an OCR-quality scan, or a pure image scan. The document's pages are rendered to images in memory and read by the model; nothing is written to disk and no lock is placed on the document.
Call this INSTEAD of parsing document text yourself. Pass its outputs directly to map_easement_to_parcel (the *_json fields are pre-formatted for that tool's parameters).
:param identifier: The document id or path (required). GUID or repository path.
:returns: If successful, returns a dictionary containing: - line_table (list) and line_table_json (str, ready for map_easement_to_parcel) - closure_ok (bool), closure_gap_ft, closure_perimeter_ft — arithmetic check of the extracted courses; if false, treat extraction as unreliable - apn, address, subdivision, lot, county — parcel identification (null if absent) - pob_anchor, pob_corner, pob_edge, pob_from_end, pob_from_corner_ft, section, township, range_, tie_courses_json — anchor fields, matching map_easement_to_parcel's parameters - page_count, pages_read, legibility, notes If unsuccessful, returns a ToolError with details about the failure.
| Name | Required | Description | Default |
|---|---|---|---|
| identifier | Yes |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Beyond the readOnlyHint annotation, the description discloses that pages are rendered to images in memory, no data is written to disk, and no lock is placed on the document. It also mentions failure behavior (returns ToolError). This adds significant context about safety and execution.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is well-structured with the core action first, followed by usage instructions, parameter details, and return value breakdown. It is slightly verbose but every sentence adds information. A minor simplification could improve conciseness.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool's complexity, single parameter, and presence of an output schema, the description fully compensates by listing all return fields, their types, and conditions. It explains the closure check for reliability and the mapping to map_easement_to_parcel, making it complete for an agent to use correctly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The schema only defines 'identifier' as a string, with 0% coverage. The description adds that it is a document id or path (required) and can be a GUID or repository path. While valuable, it could further specify acceptable formats or examples to be even more helpful.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states it reads easement documents with a vision model and returns structured survey data for mapping. It specifies it works across different document qualities (clean PDF, OCR, image scan), differentiating it from sibling tools like get_document_pdf_text which only handle text extraction.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explicitly advises users to call this tool instead of parsing document text themselves, and directs the output into map_easement_to_parcel. This provides clear when-to-use and alternative guidance, leveraging the sibling tool context.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
file_documentA
File a document to a folder in the content repository. This tool interfaces with the GraphQL API to create a referential containment relationship between a document and a folder.
:param document_id_or_path string Yes The unique identifier or path for the document. :param folder_id_or_path string Yes The unique identifier or path for the folder.
:returns: If successful, returns the reference containment relationship ID
Else, return a ToolError instance that describes the error.
| Name | Required | Description | Default |
|---|---|---|---|
| folder_id_or_path | Yes | ||
| document_id_or_path | Yes |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description bears the full burden. It explains that the tool creates a referential containment relationship, returns a relationship ID on success, and returns a ToolError on failure. However, it does not mention permissions, idempotency, or what happens if the document is already filed.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is moderately concise but includes structured param and return docs in reStructuredText format. It could be more succinct without losing clarity, but it is not overly verbose.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The tool has a simple signature with two required parameters and no output schema provided in the definition. The description explains the return type and error handling, and given the low complexity and sibling context, it is largely complete.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The schema coverage is 0%, so the description must compensate. It provides parameter descriptions stating that 'document_id_or_path' is 'The unique identifier or path for the document' and similarly for the folder, adding meaning beyond the schema's mere type definition.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states 'File a document to a folder in the content repository' using a specific verb and resource, and distinguishes itself from sibling tools like 'unfile_document' and 'create_document'.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description implies usage by describing the action and parameters, but does not explicitly state when to use this tool versus alternatives like 'unfile_document' or 'create_document'. No when-not or exclusions are provided.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_class_property_descriptionsA
Retrieves ALL properties of a class including system properties.
IMPORTANT: Use this tool ONLY for general document updates where you need to see ALL properties of a class, including system-owned and hidden properties.
DO NOT use this tool for property extraction workflows.
:param class_symbolic_name: The symbolic name of the class to retrieve properties for
:returns: A list of CachePropertyDescription objects for each property (including system properties)
| Name | Required | Description | Default |
|---|---|---|---|
| class_symbolic_name | Yes |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations provided, so description carries full burden. It discloses it is a retrieval operation ('Retrieves'), but does not explicitly state safety or lack of side effects. However, the return type and parameter are explained. Minor gap for a read-only tool.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two distinct sections: a short purpose sentence, then an IMPORTANT usage guideline, then parameter/returns. Every sentence adds value; front-loaded with purpose.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given an output schema exists, description need not detail return fields. It covers purpose, usage, parameter, and return type. Complete for a retrieval tool with one parameter.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema has no description for the parameter (0% coverage). The description adds ':param class_symbolic_name: The symbolic name of the class to retrieve properties for', providing full semantic meaning beyond the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states 'Retrieves ALL properties of a class including system properties' – clear verb+resource with scope. It distinguishes from siblings like get_searchable_property_descriptions by emphasizing 'ALL' and 'system properties'.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicitly says 'Use this tool ONLY for general document updates...' and 'DO NOT use for property extraction workflows' – clear when and when-not to use, with implied alternative tool.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_document_pdf_textARead-only
Extracts the embedded text of a PDF document directly from its content bytes.
Unlike get_document_text_extract (which depends on text extract annotations created by the repository's text extraction service), this tool downloads the PDF content in memory and extracts its embedded text layer directly. It is read-only: no reservation/lock is placed and nothing is written to disk. Use it when a PDF's text is needed but no text extract annotation exists.
Note: scanned PDFs with no embedded text layer will return empty pages — those require OCR or a vision model instead.
:param identifier: The document id or path (required). This can be either the document's ID (GUID) or its path in the repository (e.g., "/Folder1/document.pdf").
:returns: If successful, returns a dictionary containing: - document_id (str): The document's ID. - page_count (int): Number of pages in the PDF. - characters (int): Total characters extracted. - text (str): The extracted text, with pages separated by form-feed markers. If unsuccessful, returns a ToolError with details about the failure.
| Name | Required | Description | Default |
|---|---|---|---|
| identifier | Yes |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true; the description adds that no reservation/lock is placed and nothing is written to disk, and that scanned PDFs return empty pages, providing useful behavioral context beyond annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is concise, front-loads the core purpose, and efficiently uses sentences to cover usage, parameters, and return. No extraneous information.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the output schema exists and the description explains the return dictionary, and the tool is read-only with a single parameter, the description covers all necessary aspects: purpose, when to use, parameter, and return value.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 0%, but the description fully documents the single required parameter 'identifier', explaining it can be a GUID or path, and provides an example, thus adding complete meaning.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states it extracts embedded text from a PDF's content bytes, and distinguishes itself from get_document_text_extract by explaining the difference in method and dependency on text extract annotations.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicitly advises using when PDF text is needed but no text extract annotation exists, and warns against using for scanned PDFs without embedded text, recommending OCR or vision models instead.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_document_propertiesA
Retrieves a document's properties from the content repository by ID or path.
Note: Use this tool ONLY when you need to retrieve a document using its ID or file path. For searching documents by other properties, use the repository_search tool instead.
:param identifier: The document id or path (required). This can be either the document's ID (GUID) or its path in the repository (e.g., "/Folder1/document.pdf").
:returns: If successful, returns the Document object with its properties. If unsuccessful, returns a ToolError with details about the failure.
| Name | Required | Description | Default |
|---|---|---|---|
| identifier | Yes |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Describes successful return (Document object) and failure (ToolError), but lacks details about read-only nature, permissions, or other behavioral traits. With no annotations, more could be added.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Description is concise and well-structured with a note, parameter doc, and return info. Slightly verbose but not excessive.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given there is an output schema and one parameter, description covers key aspects: purpose, usage, parameter format, and return types. No obvious gaps.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Input schema has 0% coverage, but description fully explains the parameter: it can be a GUID or path, with an example. This adds significant meaning beyond the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
Description clearly states it retrieves document properties by ID or path. While it distinguishes from repository_search, it does not explicitly differentiate from other sibling tools like lookup_documents_by_path.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicitly states when to use (by ID or path) and when not (use repository_search for other properties). However, it does not mention other sibling alternatives.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_document_text_extractA
Retrieves a document's text extract content.
:param identifier: The document id or path (required). This can be either the document's ID (GUID) or its path in the repository (e.g., "/Folder1/document.pdf").
:returns: The text content of the document's text extract annotation. If multiple text extracts are found, they will be concatenated. Returns an empty string if no text extract is found.
| Name | Required | Description | Default |
|---|---|---|---|
| identifier | Yes |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description discloses key behaviors: concatenation of multiple extracts and returning empty string if none. This adequately covers the read-only nature and edge cases.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is concise with a clear first-line summary. The docstring format is well-structured, with no redundant sentences.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the output schema exists, the description's return value explanation is sufficient. It covers the main cases but could mention error handling or authentication expectations.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The sole parameter 'identifier' is explained as accepting either a GUID or path, adding meaning beyond the schema's plain string type. Since schema coverage is 0%, this compensation is valuable.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states 'Retrieves a document's text extract content,' using a specific verb and resource. It distinguishes from siblings like get_document_pdf_text and get_document_properties.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides clear usage info for the identifier parameter and return behavior but lacks explicit guidance on when to use this tool versus alternatives (e.g., get_document_pdf_text).
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_document_versionsA
Retrieves all versions in the version series that includes the specified document. This returns all versions (past, current, and future) that belong to the same version series.
:param identifier: The document id or path (required). This can be either the document's ID (GUID) or its path in the repository (e.g., "/Folder1/document.pdf").
:returns: A dictionary containing the version series details, including: - versionSeries (dict): A dictionary containing version series details, including: - versions (list): A list of all versions in the series, with each version containing: - versionables (list): A list of versionable objects, each containing: - majorVersionNumber (int): The major version number. The format to print out version number is majorVersionNumber.minorVersionNumber. - minorVersionNumber (int): The minor version number. The format to print out version number is majorVersionNumber.minorVersionNumber. - id (str): The unique identifier of the version's document id.
| Name | Required | Description | Default |
|---|---|---|---|
| identifier | Yes |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations provided, so description bears full load. It details return structure (past, current, future versions) but does not explicitly confirm read-only behavior or mention side effects, permissions, or error handling.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is front-loaded with the main action and well-structured with param and returns sections. However, it is slightly verbose due to docstring formatting which could be more concise.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the simple tool (1 param, returns version series details) and the presence of an output schema, the description covers purpose, parameter, and return structure adequately. Missing error conditions or prerequisites but still fairly complete.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The input schema has 0% description coverage for the 'identifier' parameter, but the description compensates by specifying that it can be a document ID (GUID) or path, adding significant meaning beyond just 'string'.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the purpose: 'Retrieves all versions in the version series that includes the specified document.' It specifies the resource (versions in a series) and distinguishes from siblings like delete_document_version.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description implies usage for fetching version history but does not explicitly state when to use this tool versus alternatives like delete_document_version. No guidance on prerequisites or when not to use.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_folder_detailC
Description: Get an existing folder in the content repository information given a folder id
:param identifier: The folder identifier (required). This can be either the folder's ID (GUID). :param folder_properties: Properties to update for the folder including name, etc
:returns: If successful, returns a Folder object with its properties. If unsuccessful, returns a ToolError with details about the failure.
| Name | Required | Description | Default |
|---|---|---|---|
| identifier | Yes |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations provided, so the description bears full responsibility. It states it returns a Folder object or ToolError but lacks details on permissions, idempotency, or side effects. The description does not adequately disclose behavioral traits.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is moderately concise but includes unnecessary details (wrong parameter documentation) and could be more front-loaded. The structure is adequate but not optimal.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the presence of an output schema, the return value description is acceptable. However, the erroneous parameter information and lack of error context beyond ToolError make the description incomplete and potentially confusing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The input schema has only 'identifier', but the description incorrectly includes a non-existent 'folder_properties' parameter. This misleading information degrades semantics. Schema description coverage is 0%, so the description should compensate, but it adds erroneous content.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool retrieves an existing folder's information given a folder ID. However, the mention of 'folder_properties' as a parameter (not in schema) introduces minor confusion, slightly reducing clarity.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No guidance on when to use this tool versus siblings like 'get_folder_documents' or 'get_document_properties'. The description only states what it does, not when it's appropriate.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_folder_documentsB
Retrieves a folder's contained documents.
:param folder_id_or_path: The folder id or path.
:returns: A list contains documents in the folder
| Name | Required | Description | Default |
|---|---|---|---|
| folder_id_or_path | Yes |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations provided, so description must carry full burden. It only states 'retrieves' (read operation) but lacks details on permissions, error handling, pagination, or any behavioral traits beyond the basic action.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Extremely concise: two sentences and a parameter description. No redundant information, front-loaded with purpose. Every word earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given an output schema exists, description need not detail return, but it omits important context like pagination, filtering, sorting, or behavior on missing folder. Incomplete for a list-retrieval tool with many siblings.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 0%, but description explains the sole parameter can be 'folder id or path', adding meaning beyond the schema's mere type 'string'. This helps the agent understand usage, though format details are missing.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
Description clearly states the verb 'Retrieves' and resource 'folder's contained documents'. Purpose is specific and easy to understand, but does not explicitly differentiate from sibling tools like get_folder_detail or document_search.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No guidance on when to use this tool versus alternatives. No mention of prerequisites, exclusions, or context for invocation. Agent receives no help in deciding between this and siblings.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_searchable_property_descriptionsA
Retrieves only the searchable properties of a class.
:param class_symbolic_name: The symbolic name of the class to retrieve searchable properties for
:returns: A list of CachePropertyDescription objects for properties that are searchable
| Name | Required | Description | Default |
|---|---|---|---|
| class_symbolic_name | Yes |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description bears full burden. It mentions the return type (CachePropertyDescription objects) but does not disclose read-only behavior, authentication needs, error conditions, or side effects. The verb 'retrieves' weakly implies non-destructiveness but is insufficient.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is concise with a single sentence plus a structured parameter and return description. It is front-loaded and avoids unnecessary words, though the docstring format adds slight verbosity.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the existence of an output schema, the description adequately covers the return type. It compensates for 0% schema coverage by explaining the parameter. However, it lacks information about errors, permissions, or behavior for invalid classes.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
With 0% schema description coverage, the description provides a clear parameter explanation: 'The symbolic name of the class to retrieve searchable properties for'. This adds meaning beyond the bare schema definition.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states it retrieves only the searchable properties of a class. The verb 'retrieves' and target 'searchable properties' are specific. It distinguishes from the sibling tool 'get_class_property_descriptions' by limiting to searchable ones.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description implies usage for retrieving searchable properties but does not explicitly state when to use this tool versus alternatives like 'get_class_property_descriptions'. No exclusions or prerequisites are given.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
list_root_classesA
List all available root class types in the repository.
This tool should be called first to get a list of valid root class names before using the list_all_classes tool.
:returns: A list of all available root class types (e.g., ["Document", "Folder", "Annotation", "CustomObject"])
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description must disclose behavior. It states the tool returns a list and gives an example, but does not mention side effects, authentication needs, rate limits, or other traits. For a zero-parameter read-only tool, this is adequate but not enriched.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Four sentences: purpose, usage guideline, and return description. No extraneous words. Efficient and front-loaded.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given zero parameters, existence of output schema, and simple purpose, the description fully covers what is needed. It explains the return value with an example, leaving no gaps.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Input schema has 0 parameters with 100% coverage, so description need not add parameter info. Baseline of 4 is appropriate; the description does not detract.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool lists all available root class types, with a specific verb ('list') and resource ('root class types'). It distinguishes from siblings by mentioning it should be called before 'list_all_classes', and provides an example return value.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicitly says 'should be called first to get a list of valid root class names before using the list_all_classes tool', indicating when to use. Lacks explicit when-not or alternatives among the listed sibling tools, but is sufficient for this simple case.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
lookup_documents_by_nameA
:param keywords: Up to 3 words from the user's message that might contain the document's name. Avoid using very common words such as "and", "or", "the", etc. :param class_symbolic_name: If specified, a specific document class to look in for matching documents. The root Document class is used by default. Specify a class only if the user indicates that the documents should belong to a specific class. Use the determine_class tool to lookup the class symbolic name based on the user's message.
:returns: A list of matching documents, or a ToolError if no matches are found or there is some other problem. Each match is a DocumentMatch object with information about the document including its name and a confidence score.
Description: This tool will execute a search to lookup documents by name. A list of the most likely documents matching the keywords is returned. Use this list to select the appropriate document based on the user's message.
| Name | Required | Description | Default |
|---|---|---|---|
| keywords | Yes | ||
| class_symbolic_name | No |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description states it returns a list of matching documents or a ToolError if no matches are found. It mentions confidence scores but does not disclose if the tool is read-only or any side effects. With no annotations, the description is adequate but could be more explicit about its behavioral traits.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is well-structured with parameter documentation first, followed by a concise general description. It is reasonably concise, though the param descriptions are slightly verbose and could be tightened. Nonetheless, it front-loads important details.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the presence of an output schema (not shown but indicated), the description covers the return type (DocumentMatch with name and confidence) and error condition. For a search tool with two parameters, the description is complete enough, though it could mention pagination or result limits.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The description thoroughly explains both parameters: keywords (up to 3 words, avoid common words) and class_symbolic_name (optional, use determine_class for lookup). Since the input schema has 0% description coverage, the description fully compensates, providing clear and actionable guidance beyond the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool searches for documents by name and returns matching documents. It specifies that it uses keywords from the user's message, distinguishing it from siblings like document_search or lookup_documents_by_path, though not explicitly naming alternatives.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides guidance on when to use the class_symbolic_name parameter and suggests using determine_class to find the symbolic name. However, it does not explicitly advise when to use this tool versus siblings like document_search or lookup_documents_by_path, leaving some ambiguity.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
lookup_documents_by_pathA
PREREQUISITE: To use this tool, you MUST call the determine_class tool first to get the class_symbolic_name. If the user does not specify a specific clas then call determine_class with the root Document class.
:param keywords_at_path_levels: A list of lists of keywords to search for at each path level. The first dimension list is the number of path levels entered by the user. For each path level a sub list contains up to 3 words from the user's message for that level that might contain either the intermediate folder name or the actual document's containment name. Avoid using very common words such as "and", "or", "the", etc. for these keywords. Note that the matching of documents by path is based on the containment names of the documents filed in the folder, not the name of the documents themselves. The containment names of documents are usually the same or similar to the documents but they can be different in some scenarios. :param class_symbolic_name: If specified, a specific document class to look in for matching documents. The root Document class is used by default. Specify a class only if the user indicates that the documents should belong to a specific class.
:returns: A list of matching document filings, or a ToolError if no matches are found or if there is some other problem. Each match is a DocumentMatch object with information about the document filing including its name.
Description: This tool will execute a search to lookup documents based on where they are filed in a folder hierarchy. One indication that a lookup by path is appropriate rather than a more basic lookup by name is if the user has used a path separator character ('/') to describe the document. A list of the most likely documents matching the keywords is returned. Use this list to select the appropriate document based on the user's message.
| Name | Required | Description | Default |
|---|---|---|---|
| class_symbolic_name | No | ||
| keywords_at_path_levels | Yes |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations provided, so description bears full burden. It explains matching is based on containment names, returns a list of DocumentMatch objects or ToolError, and details parameter semantics. Covers all relevant behavioral aspects.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Description is verbose and contains redundant sections (docstring-style followed by separate 'Description:' line). Could be more streamlined. Front-loading is decent with prerequisite in bold, but overall structure is cluttered.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool's complexity (two parameters, no annotations, output schema exists), the description sufficiently covers usage and behavior. Lacks details on error types beyond ToolError, but overall complete for agent use.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema has 0% description coverage, but description compensates fully. Explains keywords_at_path_levels as list of lists with constraints (up to 3 words per level, avoid common words) and class_symbolic_name as optional with default root class. Adds meaning beyond schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool searches for documents based on their folder path. It distinguishes from sibling lookup_documents_by_name by mentioning path separator usage and 'rather than a more basic lookup by name'.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicitly requires calling determine_class first as a prerequisite. Provides guidance on when to use this tool (path separator) and how to construct the keywords parameter. No exclusions, but clear context.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
map_easement_to_parcelARead-only
Places an easement survey traverse onto real-world map coordinates and returns GeoJSON. The traverse (from the survey's line table or prose metes-and-bounds courses) is chained and closure-checked, then anchored to the ground using county parcel and/or PLSS section GIS data.
This tool performs no repository operations — it is a pure geospatial computation using public county GIS data.
:param line_table_json: JSON array of the traverse courses in order, e.g.
'[{"line": "L1", "bearing": "S00-07-32E", "distance_ft": 10.30}, ...]'.
Bearings accept degree symbols or dashes (N89°51'34"E or N89-51-34E).
:param apn: Assessor's Parcel Number as printed (e.g. "200-18-001S"). Optional if
address or subdivision+lot is given, or when pob_anchor="section_corner".
:param address: Street address printed in the document (e.g. "6361 S Power Rd") —
alternative way to find the parcel when the APN is missing or illegible.
:param subdivision: Subdivision/plat name (e.g. "Sundance Groves") — used with lot
as a third way to find the parcel.
:param lot: Lot number within the subdivision (e.g. "104").
:param county: County whose GIS to query. Currently supported: maricopa.
:param pob_anchor: How the Point of Beginning is located (required choice):
- "parcel_edge": POB lies ON a parcel edge, pob_from_corner_ft from one end.
Uses pob_edge / pob_from_end / pob_from_corner_ft. (e.g. "a point on the
north line of the parcel, 122.93 feet west of the NE corner")
- "parcel_corner": POB IS a named corner of the parcel/lot. Uses pob_corner.
(e.g. "BEGINNING at the southwest corner of said Lot 104")
- "section_corner": POB is reached by walking tie course(s) from a named
corner of a PLSS section. Uses pob_corner, section, township, range_,
tie_courses_json. (e.g. "COMMENCING at the SE corner of Section 32...
THENCE N89-29-34W 65.00 FEET; THENCE ... TO THE POINT OF BEGINNING")
:param pob_edge: (parcel_edge) Which parcel edge: north, south, east, west.
:param pob_from_end: (parcel_edge) Which end of that edge the tie is measured from.
:param pob_from_corner_ft: (parcel_edge) Distance in feet from that end to the POB.
:param pob_corner: (parcel_corner / section_corner) Named corner: NW, NE, SW or SE.
:param section: (section_corner) PLSS section number as printed, e.g. "31".
:param township: (section_corner) Township, e.g. "1S" or "T1S".
:param range_: (section_corner) Range, e.g. "7E" or "R7E".
:param tie_courses_json: (section_corner) JSON array (same row format as
line_table_json) of the course(s) walked from the section corner to the POB,
in order. Use [] or omit if the POB is the section corner itself.
:returns: If successful, returns a dictionary containing: - summary (dict): flat result fields — report these values verbatim. - geojson_io_url (str): ready-made link opening the exact polygons on an interactive map. Present as a link; NEVER re-type coordinates. - geojson (dict): full-precision FeatureCollection for programmatic consumers only — do not reproduce it in a chat response. If unsuccessful, returns a ToolError with details about the failure.
| Name | Required | Description | Default |
|---|---|---|---|
| apn | No | ||
| lot | No | ||
| county | No | maricopa | |
| range_ | No | ||
| address | No | ||
| section | No | ||
| pob_edge | No | north | |
| township | No | ||
| pob_anchor | No | parcel_edge | |
| pob_corner | No | ||
| subdivision | No | ||
| pob_from_end | No | east | |
| line_table_json | Yes | ||
| tie_courses_json | No | ||
| pob_from_corner_ft | No |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Aligns with readOnlyHint annotation, describing no repository operations. Details return structure (summary, geojson_io_url, geojson) and failure behavior (ToolError). Adds guidance on how to present results, e.g., 'NEVER re-type coordinates.'
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Well-structured with clear sections: purpose, parameter details, returns. Some verbosity, but each part earns its place given complexity. Could be slightly more compact but still effective.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Comprehensive for a tool with 15 parameters and geospatial context. Covers purpose, every parameter, return values, and usage instructions. Output schema exists, so return description is adequate.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Despite 0% schema description coverage, the description provides thorough explanations for all 15 parameters, including formats, examples, conditional usage, and defaults. Compensates fully.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
Stated clearly: 'Places an easement survey traverse onto real-world map coordinates and returns GeoJSON.' Differentiated from sibling tools (document management) by being a pure geospatial computation.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicitly states it performs no repository operations and is a pure computation, indicating when to use. For parameters, describes optional conditions. Could be improved by stating when not to use, but context is clear enough.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
repository_object_searchA
PREREQUISITES IN ORDER: To use this tool, you MUST call two other tools first in a specific sequence.
determine_class tool to get the class_name for search_class.
get_searchable_property_descriptions to get a list of valid property_name for search_properties
Description: This tool retrieves repository objects other than Document instances.
:param search_parameters (SearchParameters): parameters for the searching including the object being searched for and any search conditions.
:returns: A the repository object details, including: - repositoryObjects (dict): a dictionary containing independentObjects: - independentObjects (list): A list of independent objects, each containing: - properties (list): A list of properties, each containing: - label (str): The name of the property. - value (str): The value of the property.
| Name | Required | Description | Default |
|---|---|---|---|
| search_parameters | Yes | Complete set of parameters for executing a repository search. |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries the full burden. It implies a read-only operation ('retrieves') but does not explicitly state safety or side effects; however, it does describe return structure in detail.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is verbose with a prerequisite block and param docs that repeat schema; while the prerequisite info is valuable, the structure could be more concise and front-loaded.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool's complexity (nested params, no annotations), the description covers prerequisites and return structure, making it mostly complete. Missing details on pagination or error handling keep it from a 5.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, and the description's param docs largely mirror the schema. The description adds no new meaning beyond the schema, so baseline 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states it 'retrieves repository objects other than Document instances,' which is specific verb+resource and distinguishes it from the sibling tool 'document_search'.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explicitly lists prerequisites in order (determine_class then get_searchable_property_descriptions) and implies this tool is for non-document objects, providing clear when-to-use and when-not-to-use guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
unfile_documentA
Unfile a document from a folder in the content repository. This tool interfaces with the GraphQL API to unfile document from folder with the provided ids.
:param folder_id_or_path string Yes The unique identifier or path for the folder. If not provided, an error will be returned. :param document_id string Yes The unique identifier for the document. If not provided, an error will be returned.
:returns: If successful, return the folder id. Else, return a ToolError instance that describes the error.
| Name | Required | Description | Default |
|---|---|---|---|
| document_id | Yes | ||
| folder_id_or_path | Yes |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Without annotations, the description carries the transparency burden. It mentions using the GraphQL API and indicates success returns a folder ID, while failure returns a ToolError. However, it does not disclose whether the operation is destructive or requires authentication.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is fairly concise, starting with the primary purpose and including parameter details. The docstring format is slightly lengthy but well-organized.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a simple tool with two required string parameters, the description covers purpose, parameter semantics, and return value. It is adequate for an agent to understand and invoke the tool correctly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The description includes docstring-like parameter documentation explaining that folder_id_or_path and document_id are unique identifiers and that they are required, adding meaning beyond the schema's type-only definitions.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool's purpose: 'Unfile a document from a folder in the content repository.' This directly matches the name and distinguishes it from sibling tools like file_document.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides no guidance on when to use this tool versus alternatives, nor does it mention prerequisites or common usage scenarios. It only describes the basic operation.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
update_document_classA
PREREQUISITES: Before using this tool, you MUST call ONE of these tools first:
list_all_classes - Call this tool only IF IT EXISTS and the user is using a (re)classification workflow where we need highest accuracy.
determine_class - For general class update.
Description: Changes a document's class in the content repository. WARNING: Changing a document's class can result in loss of properties if the new class does not have the same properties as the old class. Properties that don't exist in the new class will be removed from the document.
This tool ONLY changes the document's class and does NOT update any properties. To update properties after changing the class, use the update_document_properties tool.
:param identifier: The document id or path (required). This can be either the document's ID (GUID) or its path in the repository (e.g., "/Folder1/document.pdf"). :param class_identifier: The new class identifier for the document (required).
:returns: If successful, returns a Document object with the new class. If unsuccessful, returns a ToolError with details about the failure.
| Name | Required | Description | Default |
|---|---|---|---|
| identifier | Yes | ||
| class_identifier | Yes |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Discloses the destructive potential (property loss if new class lacks properties) and that the tool does not update properties. Does not mention permissions or rate limits, but with no annotations, the description carries a fair burden and provides important context.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Well-structured with prerequisites, description, warning, and parameter details. Front-loaded with critical information. Slightly lengthy but each part serves a purpose. Could be more concise without losing clarity.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Covers prerequisites, operation, side effects, and return values. With no annotations, it provides sufficient context for a mutation tool. Could specify class_identifier format and if the new class must exist.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The input schema has no descriptions (0% coverage), but the description explains identifier accepts document id or path and class_identifier is the new class identifier. Provides an example for identifier. This adds meaning beyond the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool changes a document's class in the content repository. It distinguishes from siblings by explicitly noting it only changes class and not properties, and points to update_document_properties for property updates.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Provides prerequisites: must call list_all_classes or determine_class first. Advises when to use the tool (class change) and when not to (property updates), offering explicit alternatives.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
update_document_propertiesA
PREREQUISITES: Before using this tool, you MUST call ONE of these tools first:
property_extraction - For content based property extraction workflows (provides class specific property names and document text content for AI-based extraction)
get_class_property_descriptions - For general property updates (provides full property metadata including data types, cardinality, etc.)
Description: Updates an existing document's properties in the content repository. This tool ONLY updates properties and does NOT change the document's class. To change a document's class, use the update_document_class tool instead.
:param identifier: The document id or path (required). This can be either the document's ID (GUID) or its path in the repository (e.g., "/Folder1/document.pdf"). :param document_properties: Properties to update for the document including name, mimeType, etc.
:returns: If successful, returns a Document object with its updated properties. If unsuccessful, returns a ToolError with details about the failure.
| Name | Required | Description | Default |
|---|---|---|---|
| identifier | Yes | ||
| document_properties | No |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, description carries full burden. It discloses mutability (updates properties), return values (Document object or ToolError), and identifier formats. However, it does not specify merge vs overwrite behavior for properties, concurrency, or permission requirements.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Structured with prerequisites, description, parameters, and returns. Front-loaded important usage guidance. Slightly verbose but well-organized.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Covers purpose, prerequisites, parameters, return types, and sibling differentiation. Lacks details on behavioral specifics like idempotency and property overwrite semantics. Output schema existence reduces need to describe Document object.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema has 0% top-level description coverage, but nested properties have descriptions. Description adds value by clarifying identifier as GUID or path and listing key updatable properties (name, mimeType, etc.), though it does not enumerate all subfields explicitly.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
Description clearly states it updates document properties, specifying verb and resource. It explicitly differentiates from the sibling tool update_document_class, eliminating ambiguity.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Prerequisites section mandates calling property_extraction or get_class_property_descriptions first, providing explicit when-to-use guidance. It also clarifies this tool does not change class and directs to the appropriate sibling for that.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
update_folderA
PREREQUISITES IN ORDER: To use this tool, you MUST call two other tools first in a specific sequence.
determine_class tool to get the class_identifier.
get_class_property_descriptions to get a list of valid properties for the given class_identifier
Description: Updates an existing folder in the content repository with specified properties.
:param identifier: String The folder identifier or path (required). This can be either the folder's ID (GUID) or its path in the repository (e.g., "/Folder1/folder123"). :param class_identifier: String Optional. The class identifier for the folder. If provided, allows changing the folder's class. :param folder_properties: FolderPropertiesInput Properties to update for the folder including name, etc
:returns: If successful, returns a Folder object with its updated properties. If unsuccessful, returns a ToolError with details about the failure.
| Name | Required | Description | Default |
|---|---|---|---|
| identifier | Yes | ||
| class_identifier | No | ||
| folder_properties | No |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, and the description only mentions returning a Folder object or ToolError. It does not disclose potential side effects (e.g., overwriting properties), required permissions, or other behavioral traits beyond the basic update operation.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description includes a separate prerequisites section and docstring format, which provides structure but is somewhat verbose. It could be more concise by integrating prerequisites into the main flow.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The description covers key aspects: prerequisites, parameters, and return type. However, it does not explain error scenarios fully or how to obtain identifiers. Given the output schema exists but is not shown, completeness is adequate but not outstanding.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The description adds meaningful parameter details beyond the schema, such as identifier being a GUID or path, and class_identifier allowing class change. Schema coverage is 0%, so the description compensates well.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool updates an existing folder with properties. It distinguishes from sibling tools like create_folder and delete_folder. However, the inclusion of prerequisites makes the purpose slightly less immediate.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explicitly provides a prerequisite sequence (determine_class then get_class_property_descriptions) and notes when to call them, offering excellent guidance on when and how to use this tool.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections. Dates show when Glama detected each change.
30 tool updates
v0.1.0- First observed
cancel_document_checkout - First observed
checkin_document - First observed
checkout_document - First observed
create_document - First observed
create_folder - First observed
delete_document_version - First observed
delete_folder - First observed
delete_version_series - First observed
determine_class - First observed
document_search - First observed
download_document_content - First observed
extract_survey_data - First observed
file_document - First observed
get_class_property_descriptions - First observed
get_document_pdf_text - First observed
get_document_properties - First observed
get_document_text_extract - First observed
get_document_versions - First observed
get_folder_detail - First observed
get_folder_documents - First observed
get_searchable_property_descriptions - First observed
list_root_classes - First observed
lookup_documents_by_name - First observed
lookup_documents_by_path - First observed
map_easement_to_parcel - First observed
repository_object_search - First observed
unfile_document - First observed
update_document_class - First observed
update_document_properties - First observed
update_folder
TDQS
Most tools have distinct purposes, but some overlap exists between content retrieval tools (e.g., get_document_pdf_text vs get_document_text_extract vs download_document_content) and search tools (e.g., lookup_documents_by_name vs lookup_documents_by_path vs document_search). However, detailed descriptions help differentiate them.
The majority of tool names follow a verb_noun pattern (e.g., create_document, delete_folder). A few exceptions like document_search, repository_object_search, and determine_class deviate slightly, but overall the naming is coherent and predictable.
With 30 tools, the set is on the higher side but appropriate for a full-featured content management server. The tools cover document lifecycle, folder operations, search, and domain-specific surveys. A few specialized tools could be considered extraneous, but they do not detract significantly.
Core CRUD operations for documents and folders are present, along with checkin/checkout, version management, search, and metadata retrieval. Minor gaps exist (e.g., no explicit document copy/move, access control), but the surface is largely complete for typical CMS workflows.
Maintenance
Resources
Unclaimed servers have limited discoverability.
Looking for Admin?
If you are the server author, to access and configure the admin panel.
Related MCP Connectors
Connect MCP clients to 2,000+ AI models without managing provider API keys.
Let AI agents query data and act across all your business apps via MCP.
Your memory, everywhere AI goes. Build knowledge once, access it via MCP anywhere.
Governed data discovery, exact queries, decisions, simulations, and runtime utilities over MCP.
Related MCP Servers
AlicenseAqualityBmaintenanceEnables AI models to interact with IBM FileNet Content Manager for document management, folder operations, metadata handling, search, and content extraction through a standardized interface.2615Apache 2.0- AlicenseNot gradedqualityDmaintenanceProvides secure integration between MCP clients and IBM Data Intelligence services, enabling AI assistants to interact with IBM's data intelligence capabilities for data management and analytics operations.Apache 2.0
- FlicenseNot gradedqualityDmaintenanceEnables document conversion and processing through an MCP server interface for AI assistants.-
- AlicenseCqualityDmaintenanceEnables AI models to interact with IBM FileNet Content Manager for document lifecycle management, metadata extraction, legal holds, and AI-powered search, summaries, and Q\&A.26Apache 2.0
Latest Blog Posts
- Who's Calling? MCP Hosts Are an Identity Blind Spot (And the Spec Knows It)By Om-Shree-0709 on .mcpAgent IdentityOAuth 2.1
- Your AI Chatbot Just Exposed Your CEO's Salary to an InternBy Om-Shree-0709 on .Agent IdentityMCP SecurityOAuth Delegation
- Why MCP Servers Need Execution Sandboxing (And Why Your Current Stack Isn't Enough)By Om-Shree-0709 on .Agentic AiPrompt InjectionWebAssembly
MCP directory API
We provide all the information about MCP servers via our MCP API.
curl -X GET 'https://glama.ai/api/mcp/v1/servers/ahamedfo/ibm-content-services-mcp-server'
If you have feedback or need assistance with the MCP directory API, please join our Discord server