Skip to main content
Glama
ibm-ecm

IBM Core Content Services MCP Server

Official
by ibm-ecm

update_document_properties

Update a document's properties like name, owner, or metadata in the content repository without changing its class. Retrieve property metadata first using prerequisite tools.

Instructions

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.

:param identifier: The document id or path (required). This can be either the document's ID (GUID) or its path in the repository (e.g., "/Folder1/document.pdf"). :param document_properties: Properties to update for the document including name, mimeType, etc.

:returns: If successful, returns a Document object with its updated properties. If unsuccessful, returns a ToolError with details about the failure.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
identifierYes
document_propertiesNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes
Behavior4/5

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

The description discloses that the tool only updates properties and does not change class, and specifies return behavior (Document object on success, ToolError on failure). It also explains identifier accepts ID or path. No annotations are provided, so the description carries the full burden; it covers key behaviors but lacks details on side effects like overwrite vs merge.

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 well-structured with a prerequisites section, a description paragraph, parameter docs, and return info. It front-loads important information. However, it is somewhat verbose with multiple paragraphs; could be more concise.

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's simplicity (2 params, no annotations, output schema exists), the description covers prerequisites, purpose, parameters, and return behavior. It lacks details on property update semantics (merge vs replace) and error scenarios beyond 'ToolError', but is largely sufficient.

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 0% based on context, but the provided schema actually includes descriptions for many subfields of document_properties. The description adds minimal value beyond listing 'name, mimeType, etc.' and explaining the identifier parameter. It does not explain the properties array structure in detail, but schema descriptions compensate.

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 updates an existing document's properties, with verb 'updates' and resource 'document properties'. It distinguishes from sibling tool 'update_document_class' by explicitly saying this tool does not change the class.

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 (must call property_extraction or get_class_property_descriptions first) and directs users to update_document_class for class changes. However, it does not specify other scenarios when not to use this tool.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/ibm-ecm/ibm-content-services-mcp-server'

If you have feedback or need assistance with the MCP directory API, please join our Discord server