Skip to main content
Glama
Core Content Services MCP Server

Core Content Services MCP Server

Official
by ibm-ecm

update_document_properties

Updates properties on an existing document in the content repository. Use it to change fields like name, owner, MIME type, retention date, or custom properties without changing the document class.

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.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "identifier": "<identifier>"
    },
    "name": "update_document_properties"
  }
}

Input 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

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv1.0.5
    • addedInput schema / properties / document_properties / description
      Added value: +"Properties to update for the document including name, mimeType, etc."
    • addedInput schema / properties / identifier / description
      Added value: +"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\")."
  2. Changed10 schema fields changedv1.0.4
    • removedInput schema / $defs
      Removed value: -{
      -  "DocumentPropertiesInput": {
      -    "description": "Input for document properties.",
      -    "properties": {
      -      "cmRetentionDate": {
      -        "anyOf": [
      -          {
      -            "format": "date-time",
      -            "type": "string"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ],
      -        "default": null,
      -        "description": "Retention date",
      -        "title": "Cmretentiondate"
      -      },
      -      "compoundDocumentState": {
      -        "anyOf": [
      -          {
      -            "type": "string"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ],
      -        "default": null,
      -        "description": "Compound document state",
      -        "title": "Compounddocumentstate"
      -      },
      -      "content": {
      -        "anyOf": [
      -          {
      -            "type": "string"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ],
      -        "default": null,
      -        "description": "Content can be specified if this represents a Reservation document or document creation",
      -        "title": "Content"
      -      },
      -      "mimeType": {
      -        "anyOf": [
      -          {
      -            "type": "string"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ],
      -        "default": null,
      -        "description": "Mime type",
      -        "title": "Mimetype"
      -      },
      -      "name": {
      -        "anyOf": [
      -          {
      -            "type": "string"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ],
      -        "default": null,
      -        "description": "Name sets DocumentTitle or whatever property is configured as the Name property",
      -        "title": "Name"
      -      },
      -      "owner": {
      -        "anyOf": [
      -          {
      -            "type": "string"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ],
      -        "default": null,
      -        "description": "Owner",
      -        "title": "Owner"
      -      },
      -      "properties": {
      -        "anyOf": [
      -          {
      -            "items": {
      -              "$ref": "#/$defs/PropertyIdentifierAndScalarValue"
      -            },
      -            "type": "array"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ],
      -        "default": null,
      -        "description": "Properties for Document",
      -        "title": "Properties"
      -      }
      -    },
      -    "title": "DocumentPropertiesInput",
      -    "type": "object"
      -  },
      -  "PropertyIdentifierAndScalarValue": {
      -    "description": "Represents a property with an identifier and scalar value.",
      -    "properties": {
      -      "identifier": {
      -        "description": "Property identifier",
      -        "title": "Identifier",
      -        "type": "string"
      -      },
      -      "value": {
      -        "anyOf": [
      -          {
      -            "type": "string"
      -          },
      -          {
      -            "type": "integer"
      -          },
      -          {
      -            "type": "number"
      -          },
      -          {
      -            "type": "boolean"
      -          },
      -          {},
      -          {
      -            "type": "null"
      -          }
      -        ],
      -        "default": null,
      -        "description": "Property value",
      -        "title": "Value"
      -      }
      -    },
      -    "required": [
      -      "identifier"
      -    ],
      -    "title": "PropertyIdentifierAndScalarValue",
      -    "type": "object"
      -  }
      -}
    • addedInput schema / additionalProperties
      Added value: +false
    • changedInput schema / properties / document_properties / anyOf
      Previous value: -[
      -  {
      -    "$ref": "#/$defs/DocumentPropertiesInput"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]New value: +[
      +  {
      +    "description": "Input for document properties.",
      +    "properties": {
      +      "cmRetentionDate": {
      +        "anyOf": [
      +          {
      +            "format": "date-time",
      +            "type": "string"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ],
      +        "default": null,
      +        "description": "Retention date"
      +      },
      +      "compoundDocumentState": {
      +        "anyOf": [
      +          {
      +            "type": "string"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ],
      +        "default": null,
      +        "description": "Compound document state"
      +      },
      +      "content": {
      +        "anyOf": [
      +          {
      +            "type": "string"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ],
      +        "default": null,
      +        "description": "Content can be specified if this represents a Reservation document or document creation"
      +      },
      +      "mimeType": {
      +        "anyOf": [
      +          {
      +            "type": "string"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ],
      +        "default": null,
      +        "description": "Mime type"
      +      },
      +      "name": {
      +        "anyOf": [
      +          {
      +            "type": "string"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ],
      +        "default": null,
      +        "description": "Name sets DocumentTitle or whatever property is configured as the Name property"
      +      },
      +      "owner": {
      +        "anyOf": [
      +          {
      +            "type": "string"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ],
      +        "default": null,
      +        "description": "Owner"
      +      },
      +      "properties": {
      +        "anyOf": [
      +          {
      +            "items": {
      +              "description": "Represents a property with an identifier and scalar value.",
      +              "properties": {
      +                "identifier": {
      +                  "description": "Property identifier",
      +                  "type": "string"
      +                },
      +                "value": {
      +                  "anyOf": [
      +                    {
      +                      "type": "string"
      +                    },
      +                    {
      +                      "type": "integer"
      +                    },
      +                    {
      +                      "type": "number"
      +                    },
      +                    {
      +                      "type": "boolean"
      +                    },
      +                    {},
      +                    {
      +                      "type": "null"
      +                    }
      +                  ],
      +                  "default": null,
      +                  "description": "Property value"
      +                }
      +              },
      +              "required": [
      +                "identifier"
      +              ],
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ],
      +        "default": null,
      +        "description": "Properties for Document"
      +      }
      +    },
      +    "type": "object"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
    • removedInput schema / properties / identifier / title
      Removed value: -"Identifier"
    • removedInput schema / title
      Removed value: -"update_document_propertiesArguments"
    • removedOutput schema / $defs
      Removed value: -{
      -  "Document": {
      -    "description": "Document class for the MCP server.",
      -    "properties": {
      -      "className": {
      -        "default": "Document",
      -        "description": "Class identifier for the document",
      -        "title": "Classname",
      -        "type": "string"
      -      },
      -      "contentSize": {
      -        "anyOf": [
      -          {
      -            "type": "number"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ],
      -        "default": null,
      -        "description": "Size of the document content",
      -        "title": "Contentsize"
      -      },
      -      "creator": {
      -        "anyOf": [
      -          {
      -            "type": "string"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ],
      -        "default": null,
      -        "description": "The creator of the document",
      -        "title": "Creator"
      -      },
      -      "dateCreated": {
      -        "anyOf": [
      -          {
      -            "format": "date-time",
      -            "type": "string"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ],
      -        "default": null,
      -        "description": "Date when document was created",
      -        "title": "Datecreated"
      -      },
      -      "dateLastModified": {
      -        "anyOf": [
      -          {
      -            "format": "date-time",
      -            "type": "string"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ],
      -        "default": null,
      -        "description": "Date when document was last modified",
      -        "title": "Datelastmodified"
      -      },
      -      "id": {
      -        "description": "The id of the document",
      -        "title": "Id",
      -        "type": "string"
      -      },
      -      "isVersioningEnabled": {
      -        "anyOf": [
      -          {
      -            "type": "boolean"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ],
      -        "default": null,
      -        "description": "Whether versioning is enabled",
      -        "title": "Isversioningenabled"
      -      },
      -      "lastModifier": {
      -        "anyOf": [
      -          {
      -            "type": "string"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ],
      -        "default": null,
      -        "description": "The last modifier of the document",
      -        "title": "Lastmodifier"
      -      },
      -      "majorVersionNumber": {
      -        "anyOf": [
      -          {
      -            "type": "integer"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ],
      -        "default": null,
      -        "description": "Major version number",
      -        "title": "Majorversionnumber"
      -      },
      -      "mimeType": {
      -        "anyOf": [
      -          {
      -            "type": "string"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ],
      -        "default": null,
      -        "description": "MIME type of the document",
      -        "title": "Mimetype"
      -      },
      -      "minorVersionNumber": {
      -        "anyOf": [
      -          {
      -            "type": "integer"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ],
      -        "default": null,
      -        "description": "Minor version number",
      -        "title": "Minorversionnumber"
      -      },
      -      "name": {
      -        "anyOf": [
      -          {
      -            "type": "string"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ],
      -        "default": null,
      -        "description": "The name of the document",
      -        "title": "Name"
      -      },
      -      "owner": {
      -        "anyOf": [
      -          {
      -            "type": "string"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ],
      -        "default": null,
      -        "description": "The owner of the document",
      -        "title": "Owner"
      -      },
      -      "properties": {
      -        "anyOf": [
      -          {
      -            "items": {
      -              "additionalProperties": true,
      -              "type": "object"
      -            },
      -            "type": "array"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ],
      -        "default": null,
      -        "description": "Document properties",
      -        "title": "Properties"
      -      }
      -    },
      -    "required": [
      -      "id"
      -    ],
      -    "title": "Document",
      -    "type": "object"
      -  },
      -  "ToolError": {
      -    "description": "Represents an error response from a tool execution.\n\nThis class helps the LLM understand error messages and provides suggestions\nfor potential resolutions.",
      -    "properties": {
      -      "isError": {
      -        "const": true,
      -        "default": true,
      -        "description": "Indicates that an error occurred during tool execution if value is True",
      -        "title": "Iserror",
      -        "type": "boolean"
      -      },
      -      "message": {
      -        "description": "Detailed error message",
      -        "title": "Message",
      -        "type": "string"
      -      },
      -      "suggestions": {
      -        "description": "List of suggestions for resolving the error",
      -        "items": {
      -          "type": "string"
      -        },
      -        "title": "Suggestions",
      -        "type": "array"
      -      }
      -    },
      -    "required": [
      -      "message"
      -    ],
      -    "title": "ToolError",
      -    "type": "object"
      -  }
      -}
    • changedOutput schema / properties / result / anyOf
      Previous value: -[
      -  {
      -    "$ref": "#/$defs/Document"
      -  },
      -  {
      -    "$ref": "#/$defs/ToolError"
      -  }
      -]New value: +[
      +  {
      +    "description": "Document class for the MCP server.",
      +    "properties": {
      +      "className": {
      +        "default": "Document",
      +        "description": "Class identifier for the document",
      +        "type": "string"
      +      },
      +      "contentSize": {
      +        "anyOf": [
      +          {
      +            "type": "number"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ],
      +        "default": null,
      +        "description": "Size of the document content"
      +      },
      +      "creator": {
      +        "anyOf": [
      +          {
      +            "type": "string"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ],
      +        "default": null,
      +        "description": "The creator of the document"
      +      },
      +      "dateCreated": {
      +        "anyOf": [
      +          {
      +            "format": "date-time",
      +            "type": "string"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ],
      +        "default": null,
      +        "description": "Date when document was created"
      +      },
      +      "dateLastModified": {
      +        "anyOf": [
      +          {
      +            "format": "date-time",
      +            "type": "string"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ],
      +        "default": null,
      +        "description": "Date when document was last modified"
      +      },
      +      "id": {
      +        "description": "The id of the document",
      +        "type": "string"
      +      },
      +      "isVersioningEnabled": {
      +        "anyOf": [
      +          {
      +            "type": "boolean"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ],
      +        "default": null,
      +        "description": "Whether versioning is enabled"
      +      },
      +      "lastModifier": {
      +        "anyOf": [
      +          {
      +            "type": "string"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ],
      +        "default": null,
      +        "description": "The last modifier of the document"
      +      },
      +      "majorVersionNumber": {
      +        "anyOf": [
      +          {
      +            "type": "integer"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ],
      +        "default": null,
      +        "description": "Major version number"
      +      },
      +      "mimeType": {
      +        "anyOf": [
      +          {
      +            "type": "string"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ],
      +        "default": null,
      +        "description": "MIME type of the document"
      +      },
      +      "minorVersionNumber": {
      +        "anyOf": [
      +          {
      +            "type": "integer"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ],
      +        "default": null,
      +        "description": "Minor version number"
      +      },
      +      "name": {
      +        "anyOf": [
      +          {
      +            "type": "string"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ],
      +        "default": null,
      +        "description": "The name of the document"
      +      },
      +      "owner": {
      +        "anyOf": [
      +          {
      +            "type": "string"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ],
      +        "default": null,
      +        "description": "The owner of the document"
      +      },
      +      "properties": {
      +        "anyOf": [
      +          {
      +            "items": {
      +              "additionalProperties": true,
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ],
      +        "default": null,
      +        "description": "Document properties"
      +      }
      +    },
      +    "required": [
      +      "id"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "description": "Represents an error response from a tool execution.\n\nThis class helps the LLM understand error messages and provides suggestions\nfor potential resolutions.",
      +    "properties": {
      +      "isError": {
      +        "const": true,
      +        "default": true,
      +        "description": "Indicates that an error occurred during tool execution if value is True",
      +        "type": "boolean"
      +      },
      +      "message": {
      +        "description": "Detailed error message",
      +        "type": "string"
      +      },
      +      "suggestions": {
      +        "description": "List of suggestions for resolving the error",
      +        "items": {
      +          "type": "string"
      +        },
      +        "type": "array"
      +      }
      +    },
      +    "required": [
      +      "message"
      +    ],
      +    "type": "object"
      +  }
      +]
    • removedOutput schema / properties / result / title
      Removed value: -"Result"
    • removedOutput schema / title
      Removed value: -"update_document_propertiesOutput"
    • addedOutput schema / x-fastmcp-wrap-result
      Added value: +true
  3. First observedv1.0.0

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.