Skip to main content
Glama
ibm-ecm

Core Content Services MCP Server

Official
by ibm-ecm

document_search

Search for documents by content and metadata criteria, narrowing results with filter conditions. Returns only released versions of matching documents.

Instructions

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_name for search_class. The search class must be a document class or a document subclass.

  2. get_searchable_property_descriptions to get a list of valid property_name for search_properties

Description: This tool will execute a request to search for documents based on content and the metadata criteria.

:param search_term: The words for CBR search. This will be used to search for documents based on their CBR indexed content and metadata If empty string or None, then only search by metadata.

:param search_parameters (SearchParameters): provide parameters search_class and addiontal search conditions. Note the search_class is filled in by determine_class tool. search_properties inside search_parameters include any property being searched for and any search conditions. Note: additional properties beside the search_class are used to narrow down the result set, not to expand the result set, ie it does not make sense to support prompt such as: get me all XXXCBRDocClass documents that are created by XXXuser OR contains 'XXX Content' . For CBR, Content search will be carried out first to get a result set and additional properties are placed on this result set to narrow it down.

:returns: the released versions of documents that fit the search criteria. - if search by content and CBR is not enabled, tool will return a ToolError.

Example of search by content and class is CBR enabled: Prompt: get me all XXXCBRDocClass documents that are created by XXXuser and contains 'XXX Content' Request: { "doc_class": "XXXCBRDocClass", "max_results": 50, "search_parameters": { "search_class": "XXXCBRDocClass", "search_properties": [ { "operator": "=", "property_name": "Creator", "property_value": "XXXuser" } ] }, "search_term": "XXX Content" }

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
search_parametersYesComplete set of parameters for executing a repository search.
search_termNo
max_resultsNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv1.0.4

TDQS

A4.9/5.0
Behavior5/5

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

With no annotations, the description fully discloses behavior: content search is performed first and then narrowed by metadata properties, search_term empty means metadata-only search, only released versions are returned, and a ToolError occurs if CBR is not enabled. This is comprehensive.

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

Conciseness4/5

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

The description is long but well-structured with sections for prerequisites, parameter details, notes, and an example. Every part serves a purpose, though the prerequisites could be slightly condensed. Overall, it earns its length for the tool's complexity.

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

Completeness5/5

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

Given the tool's complexity, nested parameters, and dependencies on other tools, the description is complete: it covers prerequisites, parameter semantics, behavioral notes, error conditions, and an example. An output schema exists, so return value details are not required. No gaps remain.

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

Parameters5/5

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

Despite low schema description coverage (33%), the description adds substantial meaning: it explains search_term usage, how search_parameters inherit from prerequisites, the narrowing behavior of search_properties, and provides a complete example. This far exceeds the schema's minimal descriptions.

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

Purpose5/5

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

The description clearly states it searches documents by content and metadata criteria. It distinguishes itself from sibling tools like repository_object_search (searches other objects) and lookup_documents_by_name/path (different search methods), making its purpose specific and unambiguous.

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

Usage Guidelines5/5

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

The description explicitly lists a prerequisite sequence: must first call determine_class and get_searchable_property_descriptions. It also mentions that the tool errors if CBR is not enabled for content search, providing clear guidance on when to use and what conditions are required.

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