Skip to main content
Glama
mohamedarif-m

IBM Content Services MCP Server

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: Watsonx.data Document Library Retrieval 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

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.

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

/resources

None

Accepts all documents without prefix validation

AI Document Insight

/resources/AIDocumentInsight

DI_

Only loads documents starting with DI_

Legal Hold

/resources/LegalHold

LH_

Only loads documents starting with LH_

Property Extraction & Classification

/resources/Classification

CL_, PE_

Only loads documents starting with CL_ or PE_

Configuration

RESOURCES_FOLDER

Override the default resource folder path for any server:

RESOURCES_FOLDER=/custom/path  # Override default folder path

The 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: warn

Validation 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=strict

Security 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=off

Documents 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

create_documentupdate_document_propertiescheckout_documentcheckin_documentupdate_folderrepository_object_search

Watson Orchestrate

Sporadic 'Invalid tool call object' error when agent tries to invoke MCP tools

create_documentcheckin_documentcheckout_documentget_document_versionsrepository_object_search

Note: These limitations are due to the MCP client's input handling capabilities, not the MCP server itself.


Setup and Configuration

Prerequisites

  • Python 3.13+

  • uv

    • on macOS: brew install uv

    • on 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_extract tool and Resources functionality

    • Property Extraction and Classification Server: property_extraction tool

    • AI 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

SERVER_URL

Content Services GraphQL API endpoint URL (required)

-

USERNAME

Authentication username (required)

-

PASSWORD

Authentication password (required)

-

OBJECT_STORE

Object store identifier (required)

-

Optional Environment Variables

Environment Variable

Description

Default

SSL_ENABLED

Whether SSL is enabled. Can be set to true, a path to a certificate file, or false (not recommended for production)

true

TOKEN_SSL_ENABLED

Whether SSL is enabled for token endpoint. Can be set to true, a path to a certificate file, or false (not recommended for production)

true

TOKEN_REFRESH

Token refresh interval in seconds

1800

TOKEN_URL

OAuth token URL

-

GRANT_TYPE

OAuth grant type

-

SCOPE

OAuth scope

-

CLIENT_ID

OAuth client ID

-

CLIENT_SECRET

OAuth client secret

-

REQUEST_TIMEOUT

Request timeout in seconds

30.0

POOL_CONNECTIONS

Number of connection pool connections

100

POOL_MAXSIZE

Maximum pool size

100

LOG_LEVEL

Logging level for the server. Valid values: DEBUG, INFO, WARNING, ERROR, CRITICAL

INFO

RESOURCES_FOLDER

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 ibm-cs://{object_store}/documents/{folder_path}/{document_name}. Resource names will be displayed as [IBM CS] {document_name} in MCP clients. Requires Persistent Text Extract Add-on.

Server-specific (see Resources)

RESOURCES_PREFIX_VALIDATION

Controls prefix validation for resource documents. Valid values: strict (skip invalid documents, log errors), warn (skip invalid documents, log warnings), off (no validation). See Resources section for server-specific prefix requirements.

warn

Cloud Pak for Business Automation Environment Variables

Environment Variable

Description

Default

ZENIAM_ZEN_URL

Zen url to send IAM token for exchange to Zen token, for example: /v1/preauth/validateAuth

-

ZENIAM_ZEN_SSL_ENABLED

Whether SSL is enabled for Zen exchange route. Can be set to true, a path to a certificate file, or false (not recommended for production)

true

ZENIAM_IAM_URL

IAM url to send user/pwd or client_id/client_secret to IAM to get back IAM token, for example: /idprovider/v1/auth/identitytoken

-

ZENIAM_IAM_SSL_ENABLED

Whether SSL is enabled for IAM route. Can be set to true, a path to a certificate file, or false (not recommended for production)

true

ZENIAM_IAM_GRANT_TYPE

IAM grant type

-

ZENIAM_IAM_SCOPE

IAM scope

-

ZENIAM_IAM_USER

if grant type is password, specify the IAM user

-

ZENIAM_IAM_PASSWORD

if grant type is password, specify the IAM password

-

ZENIAM_CLIENT_ID

if grant type is client_credentials, specify the IAM client id

-

ZENIAM_CLIENT_SECRET

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:

  1. Use System Certificates (Recommended for Production): Set to true to use your system's certificate store.

  2. Provide Custom Certificate Path: Set to the file path of your certificate (e.g., /path/to/certificate.pem).

  3. Disable SSL Verification (Not Recommended for Production): Set to false to 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 | false

OAuth 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_store

Zen/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_password

Integration with MCP Clients/Agent Frameworks

Claude Desktop Configuration

  1. 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. Screenshot showing Settings

  2. Navigate to the Developer tab and click Edit Config:

    • macOS: ~/Library/Application Support/Claude/claude_desktop_config.json

    • Windows: %APPDATA%\Claude\claude_desktop_config.json Screenshot showing "Edit Config"

  3. 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"
          }
        }
      }
    }
  4. 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

  5. Check Available Tools:

    • To see all the available tools in Claude Desktop, proceed as follows:

      • first click the settings icon, and you should see: Screenshot showing MCP Servers

      • then click core-cs-mcp-server, and you should see all your tools: Screenshot showing Claude 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 URL

      • USERNAME: Authentication username

      • PASSWORD: Authentication password

      • OBJECT_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

    Build > Agent Builder

  • Navigate to All agents

  • Click Create agent + to add a new agent

    Create an 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

    Create an agent (continued)

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

    Add tools +

  • Click Import

    Import MCP Server

  • Click Import from MCP server

    Import MCP Server (continued)

  • Click Add MCP server

    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-server

    For 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-server
    • Legal Hold Server:

      uvx --from git+https://github.com/ibm-ecm/ibm-content-services-mcp-server legal-hold-cs-mcp-server
    • AI 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-server

    Replace core-cs-mcp-server with the name of the server you want to install (property-extraction-and-classification-cs-mcp-server, legal-hold-cs-mcp-server, or ai-document-insight-cs-mcp-server).

  • Click Connect

  • If you see "Connection successful", click Done

    Add MCP Server (continued)

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

    Enable Tools

  • Associate your previously created connection with this agent

4. Deploy the agent
  • Click Deploy

    Configuration completed

  • 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

    select the 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"

    chat

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

chat reasoning


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-server

Property 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-server

Legal 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-server

AI 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-server

Integration 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:

  1. Access and retrieve document properties

  2. Extract text from documents

  3. Create, update, check-in, and check-out documents

  4. Manage folders and document classifications

  5. Execute searches

  6. Access resources for LLM context

Property Extraction and Classification Server capabilities:

  1. Extract property values from document content using AI

  2. List and match document classes for reclassification

Legal Hold Server capabilities:

  1. Create and manage legal holds

  2. Place objects under hold

  3. Track and query held objects

AI Document Insight Server capabilities:

  1. Perform AI-powered hybrid searches combining vector search with metadata filtering

  2. Generate document summaries using GenAI

  3. Compare documents and analyze differences

  4. Answer natural language questions across the entire document repository

  5. Answer natural language questions based on one document or a set of documents

Example Workflows

Core Server Workflow: Search and Document Management

  1. 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_descriptions to discover valid search properties

      • repository_object_search for property-based searches

    • Search results include object IDs needed for subsequent operations

  2. 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

  3. Document Creation: Users can ask the AI Agent to create new documents with specific properties and content.

  4. 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

  5. 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)

  1. Property Extraction:

    • Use property_extraction tool with a document ID

    • The 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_properties to save the extracted values

  2. Document Classification:

    • Use list_all_classes to get all available document classes

    • AI analyzes document content and matches it to the most appropriate class

    • Use Core Server's update_document_class to reclassify the document

  1. Creating a Hold:

    • Use create_hold with a descriptive name (e.g., "Litigation ABC vs XYZ")

    • Returns the hold object with its ID

  2. Placing Objects Under Hold:

    • Identify documents using Core Server search tools (if needed)

    • Use add_object_to_hold with the hold ID and object ID

    • Repeat for all relevant documents/objects

  3. Managing Holds:

    • Use get_holds_by_name to find holds by name

    • Use get_held_objects_for_hold to see all objects under a specific hold

    • Use delete_object_from_hold to release specific objects

    • Use delete_hold to 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

26 tools
cancel_document_checkoutA

Cancels a document checkout in the content repository.

ParametersJSON Schema
NameRequiredDescriptionDefault
identifierYesThe identifier (required). This can be either a reservation_id or document_id. Reservation ID (GUID) is prioritized. Otherwise, we use document_id (GUID).

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

A3.5/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations provided, so description must disclose traits. It implies mutation but does not mention permissions, reversibility, or error cases. Parameter description adds lookup behavior (prioritizes reservation_id), providing moderate context.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Single sentence that is front-loaded and contains no unnecessary words. Efficient and clear.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

While output schema exists (handling return values), the description lacks context about prerequisites (active checkout) and potential side effects, leaving gaps for an agent unfamiliar with the domain.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100% and already explains the parameter's dual-purpose behavior. Description adds no additional parameter insight beyond schema, so baseline 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

Description uses specific verb 'cancels' and resource 'document checkout', clearly distinguishing from sibling tools like checkin_document and checkout_document.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

No guidance on when to use this tool vs alternatives, such as prerequisites (e.g., existing checkout) or exclusions. Sibling tools are listed but not referenced.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

checkin_documentC

Checks in a document in the content repository with specified properties.

ParametersJSON Schema
NameRequiredDescriptionDefault
identifierYesThe identifier (required). This can be either a reservation_id or document_id. Reservation ID (GUID) is prioritized. Otherwise, we use document_id (GUID).
checkin_actionNoCheck-in action parameters for the document.
document_propertiesNoProperties to update for the document during check-in.
file_pathsNoOptional list of file paths to upload as the document's content.

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

C2.9/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description alone must disclose behavioral traits. It only states the basic action, failing to mention side effects (e.g., overwriting content, creating a new version), required permissions, or whether the operation is reversible. The description does not add any behavioral context beyond the name.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, clear sentence with no wasted words. It is front-loaded with the action verb. However, it could be slightly expanded to include key context without losing conciseness.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the complexity (4 parameters, including nested objects) and the presence of an output schema, the description is incomplete. It does not explain the check-in workflow (e.g., prerequisite checkout), what happens to file_paths, or how properties are applied. The description does not compensate for the lack of annotations.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the baseline is 3. The description adds no meaning beyond the schema—'with specified properties' is already implied by the parameters. No parameter details in the description itself, which meets the minimum but adds no value.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description uses a specific verb ('checks in') and resource ('document'), clearly indicating the action. It implicitly distinguishes from the sibling 'checkout_document' by being the inverse, but does not explicitly differentiate from other document tools like 'create_document' or 'update_document_properties'.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

No guidance is provided on when to use this tool versus alternatives. It does not mention that a document must be checked out first, nor does it state when not to use it. Sibling tools like 'checkout_document' or 'create_document' are not referenced in the description.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

checkout_documentC

Checks out a document in the content repository.

ParametersJSON Schema
NameRequiredDescriptionDefault
identifierYesThe 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").
document_propertiesNoProperties to update for the document during check-out.
checkout_actionNoCheck-out action parameters for the document.
download_folder_pathNoOptional 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.

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

C2.6/5.0
Behavior1/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description bears full responsibility for disclosing behavioral traits. It fails to mention any side effects (e.g., document locking, reservation creation, permission requirements, or what happens to the document content). The description merely states the action without any 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.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is extremely concise at one sentence, but it is too brief to be informative. It front-loads the core action but omits critical details, making it minimally adequate but not optimally structured for agent understanding.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool has a complex input schema with 4 parameters and an output schema, the description is incomplete. It does not explain return values, the effect of the checkout action, or how the parameters relate to the overall behavior. The description fails to provide the additional context needed for an agent to use the tool correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, meaning every parameter already has a description in the input schema. The tool description adds no additional semantic value beyond what is in the schema, so the baseline score of 3 is appropriate.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the verb 'checks out' and the resource 'document in the content repository', providing a specific action and target. However, it does not differentiate from sibling tools like 'checkin_document' or 'cancel_document_checkout', though the opposite nature of checkout vs checkin is implied.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

No guidance is provided on when to use this tool versus alternatives such as 'checkin_document' or 'cancel_document_checkout'. There is no mention of prerequisites, side effects, or context for proper invocation.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

create_documentB

PREREQUISITES IN ORDER: To use this tool, you MUST call two other tools first in a specific sequence.

  1. determine_class tool to get the class_identifier.

  2. 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.

ParametersJSON Schema
NameRequiredDescriptionDefault
class_identifierNoThe class identifier for the document. If not provided, defaults to "Document".
idNoThe unique GUID for the document. If not provided, a new GUID with curly braces will be generated.
document_propertiesNoProperties for the document including name, content, mimeType, etc.
file_in_folder_identifierNoThe identifier or path of the folder to file the document in. This always starts with "/".
checkin_actionNoCheck-in action parameters. CheckinMinorVersion should always be included.
file_pathsNoOptional list of file paths to upload as the document's content.

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

B3.2/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description carries full burden. It does not disclose side effects (e.g., check-in behavior, auto-classification), required permissions, or what happens to existing documents. The prerequisites are helpful but not behavioral.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description includes a bold prerequisites section and a one-sentence summary, but the structure is somewhat redundant (two 'Description:' labels). It could be more concise by integrating the prerequisites into a single directive.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Despite the output schema, the description lacks details about default behaviors (e.g., defaults for class_identifier and id generation) and the overall creation flow. It feels incomplete for a tool with 6 parameters.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the input schema already documents all parameters. The description adds no extra meaning beyond the schema, which is adequate but not exceptional.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the action ('Creates a document in the content repository with specified properties'), which identifies the verb and resource. It distinguishes from sibling tools like create_folder, but could be more specific about the underlying system.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

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, get_class_property_descriptions), guiding the agent on when and how to prepare. It does not explicitly state when not to use the tool, but the prerequisites provide strong context.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

create_folderB

PREREQUISITES IN ORDER: To use this tool, you MUST call two other tools first in a specific sequence.

  1. determine_class tool to get the class_identifier.

  2. 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.

ParametersJSON Schema
NameRequiredDescriptionDefault
nameYes
parent_folderYes
class_identifierNo
idNo
folder_propertiesNo

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

B3.3/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description must disclose behavioral traits. It mentions GraphQL API interaction but fails to explain side effects (e.g., overwrite behavior, access rights, idempotency) or what happens on failure.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The prerequisites section is well-structured and bolded, but the sentence about GraphQL API is redundant. The description could be more concise without losing essential guidance.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the complexity (5 params, nested objects), the description is incomplete. It lacks explanations for parameters like 'id' and 'folder_properties', and does not cover error handling or naming constraints. The output schema may compensate for return values, but behavioral gaps remain.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters1/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0% and the tool description does not explain any of the five parameters. Parameters like 'id' and 'folder_properties' remain ambiguous, forcing reliance on prerequisite tools alone.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

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 with specified properties.' The verb and resource are explicit, and it distinguishes from sibling tools like update_folder 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.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description explicitly lists required prerequisite tools in order (determine_class and get_class_property_descriptions), providing clear when-to-use guidance and preventing misuse.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

delete_document_versionC
Destructive

Deletes a specific document version in the content repository.

ParametersJSON Schema
NameRequiredDescriptionDefault
identifierYesThe 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").

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

C2.9/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

The description only states the action ('deletes'), which is already implied by the tool name. While annotations provide destructiveHint=true, the description adds no extra behavioral context (e.g., impact on other versions, reversibility, or required permissions).

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single sentence, concise and front-loaded. It contains no unnecessary words, but could be slightly more informative without becoming verbose.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the simple parameter and presence of output schema and annotations, the description is minimally adequate. However, it lacks details about the effect on version history and does not differentiate from the sibling delete_version_series tool, leaving room for confusion.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The single parameter 'identifier' is fully described in the input schema (100% coverage). The tool description does not add any additional meaning beyond what the schema provides, so baseline score of 3 is appropriate.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states it deletes a specific document version, distinguishing it from sibling tools like delete_folder or delete_version_series. However, it does not explicitly clarify the difference between deleting a version and deleting the whole document, which could be ambiguous.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

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 like delete_version_series or other deletion tools. The description does not mention context, prerequisites, or exclusions, leaving the agent without decision support.

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.

ParametersJSON Schema
NameRequiredDescriptionDefault
id_or_pathYes

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

A3.6/5.0
Behavior3/5

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.

Conciseness4/5

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.

Completeness3/5

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.

Parameters3/5

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.

Purpose5/5

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.

Usage Guidelines3/5

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_seriesA
Destructive

Deletes an entire version series (all versions of a document) in the content repository.

ParametersJSON Schema
NameRequiredDescriptionDefault
version_series_idYesThe 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.

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

A4/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

The destructiveHint annotation already signals destructive behavior; the description adds context about deleting all versions. No contradictory information, but no additional behaviors disclosed beyond what annotations provide.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Single sentence that is front-loaded with the key action and resource, with no extraneous information.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool has one parameter and an output schema, the description is sufficient. Could explicitly mention irreversibility, but destructiveHint covers that indirectly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema covers 100% of parameters, and the description for version_series_id includes helpful guidance on how to obtain the ID by calling get_document_property, adding value beyond the schema itself.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

Description clearly states 'Deletes an entire version series (all versions of a document)', using a specific verb and resource, and implicitly distinguishes from sibling 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.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

While the parameter description advises to call get_document_property if the ID is unknown, the tool description does not explicitly state when to use this tool vs alternatives like delete_document_version, leaving some ambiguity for the agent.

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.

ParametersJSON Schema
NameRequiredDescriptionDefault
root_classYesThe root class to search within (eg. "Document", "Folder")
keywordsYesUp to 3 words from the user's message that might contain the class's name

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

A3.7/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description carries full burden. It mentions substring matching and a prerequisite, but does not disclose whether the operation is read-only, case sensitivity, pagination, or return format. This is minimal 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.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is concise with two sentences, no redundancy, and the important prerequisite is highlighted. Every sentence earns its place.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given no annotations and an output schema (not described), the description is adequate but sparse. It doesn't cover error handling, permissions, or behavior with no matches, but the output schema can clarify return values.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the schema already describes both parameters. The description adds marginal value; it mentions 'up to 3 words' which is also in the schema. No new parameter-specific semantics are provided beyond what the schema offers.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states it finds classes via substring matching. It specifies both the action and resource (classes). However, it does not explicitly distinguish from sibling tools like document_search, but the context of 'classes' vs documents is clear enough.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides a specific prerequisite: call list_root_classes_tool first to get valid root_class names. This is good guidance. It does not, however, discuss when to use this tool versus alternatives for searching classes.

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.

ParametersJSON Schema
NameRequiredDescriptionDefault
document_id_or_pathYes
folder_id_or_pathYes

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

A3.8/5.0
Behavior3/5

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.

Conciseness3/5

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.

Completeness4/5

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.

Parameters4/5

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.

Purpose5/5

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.

Usage Guidelines3/5

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.

ParametersJSON Schema
NameRequiredDescriptionDefault
class_symbolic_nameYesThe symbolic name of the class to retrieve properties for

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

A4.4/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries full burden. It discloses that the tool retrieves all properties including system and hidden, which is the key behavioral trait. However, it does not mention any permissions, side effects, or rate limits, but for a read-only retrieval, the current detail is adequate.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is concise with three sentences: the first states the core function, and the next two provide usage guidance. It is front-loaded and every sentence adds value without redundancy.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool has an output schema (so return values need not be explained) and only one parameter, the description covers the essential context: what it retrieves and explicit usage restrictions. It lacks details on prerequisites or limitations, but completeness is sufficient for a low-complexity tool.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100% and the parameter description in the schema already explains the class_symbolic_name clearly. The tool description adds no additional meaning or context beyond what the schema provides, so baseline 3 is appropriate.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool retrieves ALL properties of a class including system properties. It distinguishes itself from sibling tools like get_document_properties and get_searchable_property_descriptions by focusing on class-level properties and including system-owned and hidden ones.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description explicitly states when to use (general document updates needing all properties) and when not to use (property extraction workflows), providing clear context and an implicit alternative.

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.

ParametersJSON Schema
NameRequiredDescriptionDefault
identifierYesThe 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").

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

A4/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description must cover all behavioral traits. It only states 'retrieves' but does not disclose return format, permissions, rate limits, or any side effects. The presence of an output schema is not mentioned.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is two sentences, immediately stating the purpose and then providing usage guidance. Every sentence is necessary and there is no redundancy.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With only one parameter and an output schema present, the description is fairly complete. However, it could mention that the output contains document properties as defined in the output schema.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The input schema has 100% coverage with a clear description of the 'identifier' parameter. The tool description does not add any additional meaning beyond what the schema already provides, so baseline 3 is appropriate.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states it retrieves document properties by ID or path, which is a specific verb-resource pair. It distinguishes from sibling tools like repository_search by specifying the retrieval method.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description explicitly says 'Use this tool ONLY when you need to retrieve a document using its ID or file path' and directs to repository_search for other queries, providing clear guidance on when to use versus when not.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

get_document_text_extractC

Retrieves a document's text extract content.

ParametersJSON Schema
NameRequiredDescriptionDefault
identifierYesThe 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").

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

C2.9/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations, the description should inform about behavior like read-only nature, permission requirements, or data volume. It only states it retrieves content, missing critical behavioral details.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single short sentence that is concise and front-loaded. However, it could include more context while remaining concise.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Despite having an output schema, the description lacks behavioral and usage context. For a simple tool with one parameter, it is minimally adequate but not complete.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the schema already describes the 'identifier' parameter. The description adds no additional meaning beyond what the schema provides, meeting the baseline but no extra value.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description uses a specific verb 'Retrieves' and clearly identifies the resource as 'document's text extract content'. It is clear what the tool does but does not differentiate from sibling tools like 'get_document_properties' or 'get_document_versions'.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

No guidance is provided on when to use this tool instead of alternatives, such as when a text extract versus properties is needed. The description lacks context on prerequisites or exclusion cases.

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.

ParametersJSON Schema
NameRequiredDescriptionDefault
identifierYesThe 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").

Output Schema

ParametersJSON Schema
NameRequiredDescription

No output parameters

TDQS

A3.6/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations provided; description adds context that it returns all versions in a series, but lacks disclosure of authorization needs, side effects (none expected), or limits. Adequate but not rich.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two sentences, no fluff. Clearly front-loaded with the purpose. Every sentence adds value.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With an output schema present, the description does not need to detail return values. It covers the essential scope (all versions in series) and is 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.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100% and the parameter description is already provided in the input schema. The tool description does not add additional meaning or usage hints beyond what the schema already offers.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

Description clearly states the tool retrieves all versions in a version series, specifying 'past, current, and future'. This verb-resource combination is specific and distinguishes it from sibling tools like get_document_properties or lookup_documents_by_name.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

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. Does not mention prerequisites, exclusions, or context for choosing this over sibling tools like delete_document_version or checkout_document.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

get_folder_detailB

Description: Get an existing folder in the content repository information given a folder id

ParametersJSON Schema
NameRequiredDescriptionDefault
identifierYesThe folder identifier (required). This can be either the folder's ID (GUID).

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

B3.3/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, and the description does not disclose behavioral traits beyond the basic 'get' operation. There is no mention of read-only nature, authentication requirements, rate limits, or any side effects.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, front-loaded sentence with no redundant words. It efficiently conveys the core purpose.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

While the tool has an output schema, the description does not explain what information is returned. Given the low complexity (single parameter) and presence of output schema, it is minimally adequate but could be more complete.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The input schema describes the identifier parameter fully, including its required status and that it can be a GUID. The description adds no additional meaning beyond the schema, so baseline score applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the verb 'get' and the resource 'folder', and specifies the input condition 'given a folder id'. This distinguishes it from sibling tools like create_folder or get_folder_documents.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

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, such as get_folder_documents for retrieving documents within a folder or update_folder for modifications. The description lacks context for decision-making.

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.

ParametersJSON Schema
NameRequiredDescriptionDefault
folder_id_or_pathYesThe folder id or path.

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

B3/5.0
Behavior1/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations, the description carries the full burden of disclosing behavioral traits. It fails to mention permissions, pagination, depth (recursive?), or whether full document objects or summaries are returned.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

One sentence with no wasted words. Appropriately front-loaded and concise.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Despite an output schema existing, the description lacks details on depth, permissions, or ordering. For a retrieval tool, this is too sparse.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the baseline is 3. The description adds no extra meaning beyond the parameter's schema description 'The folder id or path.'

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description uses the specific verb 'Retrieves' and resource 'folder's contained documents', clearly distinguishing it from sibling tools like get_folder_detail (folder properties) and document_search (search across all documents).

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

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. Sibling tools are listed but no differentiators or conditions for use are provided.

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.

ParametersJSON Schema
NameRequiredDescriptionDefault
class_symbolic_nameYesThe symbolic name of the class to retrieve searchable properties for

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

A3.5/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description carries full burden. It only states the filtering behavior ('only searchable'), but lacks details on side effects, permissions, or performance. Minimal disclosure.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, compact sentence that directly communicates the tool's purpose. No redundancy or unnecessary detail.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's simplicity (one parameter, output schema exists), the description is functionally adequate but lacks usage context and guidance for when to choose this over similar sibling tools.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, and the schema already describes the single parameter adequately. The description adds no additional parameter meaning beyond what the schema provides.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool retrieves 'only the searchable properties of a class', specifying the exact resource and scope. This distinguishes it from the sibling tool '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.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implies usage when only searchable properties are needed, but provides no explicit guidance, alternatives, or when not to use. No comparison with sibling tools.

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"])

ParametersJSON Schema
NameRequiredDescriptionDefault

No parameters

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

A4.3/5.0
Behavior3/5

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.

Conciseness5/5

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.

Completeness5/5

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.

Parameters4/5

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.

Purpose5/5

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.

Usage Guidelines4/5

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_nameD
ParametersJSON Schema
NameRequiredDescriptionDefault
keywordsYesUp 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.
class_symbolic_nameNoIf 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.

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

D1/5.0
Behavior1/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Tool has no description.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness1/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Tool has no description.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness1/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Tool has no description.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters1/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Tool has no description.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose1/5

Does the description clearly state what the tool does and how it differs from similar tools?

Tool has no description.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines1/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Tool has no description.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

lookup_documents_by_pathB

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.

ParametersJSON Schema
NameRequiredDescriptionDefault
keywords_at_path_levelsYesA 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.
class_symbolic_nameNoIf 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.

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

B3.4/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations, the description carries the full burden. It explains the matching logic (by containment names) and parameter format but does not mention return behavior, errors, or side effects. Adequate but could be more transparent.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is somewhat verbose, especially with the prerequisite emphasis. It is front-loaded with important info but could be more concise. Some repetition exists (e.g., calling determine_class explained twice).

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

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 and full parameter coverage, the description covers prerequisites and matching logic. However, it lacks comparison with sibling tools (e.g., lookup_documents_by_name) and does not discuss edge cases or limitations. Adequate but not comprehensive.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, and the description adds meaningful context beyond schema: explains the list-of-lists structure for keywords_at_path_levels, warns against common words, and clarifies class_symbolic_name usage. This adds value.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose3/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description does not explicitly state the tool's purpose in a single sentence, but the title and context indicate it looks up documents by path. It lacks a clear verb+resource statement differentiating it from siblings like lookup_documents_by_name.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description clearly states a prerequisite: must call determine_class first. It provides guidance on when to specify a class vs using root class. However, it does not directly contrast with sibling tools for alternative lookup methods.

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.

ParametersJSON Schema
NameRequiredDescriptionDefault
folder_id_or_pathYes
document_idYes

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

A3.7/5.0
Behavior3/5

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.

Conciseness4/5

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.

Completeness4/5

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.

Parameters4/5

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.

Purpose5/5

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.

Usage Guidelines2/5

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:

  1. list_all_classes - Call this tool only IF IT EXISTS and the user is using a (re)classification workflow where we need highest accuracy.

  2. 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.

ParametersJSON Schema
NameRequiredDescriptionDefault
identifierYesThe 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").
class_identifierYesThe new class identifier for the document (required).

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

A4.5/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations provided, so description carries full burden. It includes a warning about potential property loss if the new class lacks matching properties. It also clarifies that only the class changes, not properties.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is front-loaded with prerequisites in bold, followed by the main description, warning, and note. While each sentence adds value, it could be slightly more concise. Still clear and well-structured.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

The tool has an output schema, so return value explanation is not needed. Description covers purpose, usage, side effects, and relationships with other tools. However, it does not mention error conditions or output format, but overall complete for the complexity level.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema descriptions already cover both parameters (identifier as document id/path, class_identifier as new class). Description adds no extra semantic value beyond the schema. Schema coverage is 100%, so baseline is 3.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states it 'Changes a document's class in the content repository.' The verb 'change' and resource 'document's class' are specific. Among siblings, there are tools like 'determine_class' and 'update_document_properties', making this tool distinct.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicit prerequisites are provided: must call 'list_all_classes' or 'determine_class' first. It also clarifies when not to use it by stating it only changes class and directs to 'update_document_properties' for property updates.

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:

  1. property_extraction - For content based property extraction workflows (provides class specific property names and document text content for AI-based extraction)

  2. 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.

ParametersJSON Schema
NameRequiredDescriptionDefault
identifierYesThe 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").
document_propertiesNoProperties to update for the document including name, mimeType, etc.

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

A4.5/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are present, so the description must carry the burden. It clarifies that only properties are updated, not class, and mandates prerequisites. No contradictions. Could add details on side effects or permissions, but the information is sufficient for safe usage.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is front-loaded with prerequisites in bold, followed by a concise statement of functionality and a cross-reference to another tool. Every sentence serves a purpose with no redundancy.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With an existing output schema and detailed input schema, the description covers the tool's purpose, scope, prerequisites, and limitations. It is fully contextual for correct invocation.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100% and the description adds little beyond what the schema already conveys about parameters. Baseline of 3 is appropriate since the schema does the heavy lifting.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

Clearly states it updates document properties and explicitly distinguishes from update_document_class for class changes. Verb 'updates' plus resource 'document's properties' is specific.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicit prerequisites are listed, along with guidance on when not to use (for class changes) and reference to the alternative tool (update_document_class). This provides strong usage context.

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.

  1. determine_class tool to get the class_identifier.

  2. 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.

ParametersJSON Schema
NameRequiredDescriptionDefault
identifierYesString 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").
class_identifierNoString Optional. The class identifier for the folder. If provided, allows changing the folder's class.
folder_propertiesNoFolderPropertiesInput Properties to update for the folder including name, etc

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

A3.6/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries full responsibility for behavioral disclosure. It indicates mutation ('Updates') but lacks details on permissions, error conditions, side effects, or irreversibility. The brief description does not compensate for the absence of annotations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is structured with bold prerequisites first, then the core purpose. It is front-loaded but slightly verbose due to the repeated 'Description:', though still efficient overall.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the output schema exists, return values need not be explained. The description covers purpose and prerequisites, but lacks details on validation, partial updates, or constraints. It is adequate but leaves gaps for a mutation tool.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, and the input schema already fully documents each parameter including descriptions for identifier, class_identifier, and folder_properties. The description adds no new semantic information beyond what the schema provides, so baseline score of 3 is appropriate.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description explicitly states 'Updates an existing folder in the content repository with specified properties,' using a specific verb and resource. It clearly distinguishes from sibling tools like create_folder or delete_folder by focusing on modification.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides explicit prerequisites in order, stating that determine_class and get_class_property_descriptions must be called first. However, it does not explicitly state when not to use this tool or mention alternatives for other scenarios.

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.

  1. 26 tool updatesv1.0.4
    • First observedcancel_document_checkout
    • First observedcheckin_document
    • First observedcheckout_document
    • First observedcreate_document
    • First observedcreate_folder
    • First observeddelete_document_version
    • First observeddelete_folder
    • First observeddelete_version_series
    • First observeddetermine_class
    • First observeddocument_search
    • First observedfile_document
    • First observedget_class_property_descriptions
    • First observedget_document_properties
    • First observedget_document_text_extract
    • First observedget_document_versions
    • First observedget_folder_detail
    • First observedget_folder_documents
    • First observedget_searchable_property_descriptions
    • First observedlist_root_classes
    • First observedlookup_documents_by_name
    • First observedlookup_documents_by_path
    • First observedrepository_object_search
    • First observedunfile_document
    • First observedupdate_document_class
    • First observedupdate_document_properties
    • First observedupdate_folder

TDQS

C2.9/5.0

Scored across 26 tools

Disambiguation4/5

Most tools have distinct purposes, but some overlap exists between 'lookup_documents_by_name' and 'document_search', and between the various class-related tools, though descriptions help differentiate them.

Naming Consistency4/5

The majority of tools follow a consistent verb_noun pattern (e.g., create_document, delete_folder), but 'document_search' and 'repository_object_search' use noun_verb order, creating a minor inconsistency.

Tool Count4/5

26 tools is slightly above the typical range but appropriate for the complexity of enterprise content management, covering documents, folders, classes, and search.

Completeness4/5

The tool set covers the core document lifecycle (create, checkout/checkin, update, delete versions, filing) and folder operations, though it lacks a simple 'delete document' (only version series deletion) and may miss some advanced features like annotations.

Maintenance

ActivityInactive
ResponsivenessNo issues

Related MCP Connectors

Related MCP Servers