Skip to main content
Glama
Core Content Services MCP Server

Core Content Services MCP Server

Official
by ibm-ecm

get_class_property_descriptions

Retrieves all properties of a class, including system-owned and hidden fields, for general document updates where full property visibility is required.

Instructions

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.

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": {
      "class_symbolic_name": "<class_symbolic_name>"
    },
    "name": "get_class_property_descriptions"
  }
}

Input Schema

NameRequiredDescriptionDefault
class_symbolic_nameYesThe symbolic name of the class to retrieve properties for

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv1.0.5
    • addedInput schema / properties / class_symbolic_name / description
      Added value: +"The symbolic name of the class to retrieve properties for"
  2. Changed8 schema fields changedv1.0.4
    • addedInput schema / additionalProperties
      Added value: +false
    • removedInput schema / properties / class_symbolic_name / title
      Removed value: -"Class Symbolic Name"
    • removedInput schema / title
      Removed value: -"get_class_property_descriptionsArguments"
    • removedOutput schema / $defs
      Removed value: -{
      -  "CachePropertyDescription": {
      -    "description": "Describes detailed attributes or metadata about a property.",
      -    "properties": {
      -      "cardinality": {
      -        "$ref": "#/$defs/Cardinality",
      -        "description": "Whether this property holds a single value or multiple values."
      -      },
      -      "data_type": {
      -        "$ref": "#/$defs/TypeID",
      -        "description": "The type of data this property can hold"
      -      },
      -      "descriptive_text": {
      -        "description": "Describes additional details about this property",
      -        "title": "Descriptive Text",
      -        "type": "string"
      -      },
      -      "display_name": {
      -        "description": "A user displayable name for this property",
      -        "title": "Display Name",
      -        "type": "string"
      -      },
      -      "is_hidden": {
      -        "default": false,
      -        "description": "Indicates whether this property is hidden",
      -        "title": "Is Hidden",
      -        "type": "boolean"
      -      },
      -      "is_searchable": {
      -        "description": "Indicates whether searches can include conditions involving this property",
      -        "title": "Is Searchable",
      -        "type": "boolean"
      -      },
      -      "is_system_owned": {
      -        "default": false,
      -        "description": "Indicates whether this property is system-owned",
      -        "title": "Is System Owned",
      -        "type": "boolean"
      -      },
      -      "symbolic_name": {
      -        "description": "Symbolic name that is used to reference this property",
      -        "title": "Symbolic Name",
      -        "type": "string"
      -      },
      -      "valid_search_operators": {
      -        "description": "The valid operators that can be used with this property in a search condition",
      -        "items": {
      -          "$ref": "#/$defs/SearchOperator"
      -        },
      -        "title": "Valid Search Operators",
      -        "type": "array"
      -      }
      -    },
      -    "required": [
      -      "symbolic_name",
      -      "display_name",
      -      "descriptive_text",
      -      "data_type",
      -      "cardinality",
      -      "is_searchable",
      -      "valid_search_operators"
      -    ],
      -    "title": "CachePropertyDescription",
      -    "type": "object"
      -  },
      -  "Cardinality": {
      -    "description": "Indicates whether a data variable has a single value or multiple values",
      -    "enum": [
      -      "SINGLE",
      -      "LIST",
      -      "ENUM"
      -    ],
      -    "title": "Cardinality",
      -    "type": "string"
      -  },
      -  "SearchOperator": {
      -    "description": "Enum defining all valid search operators for repository searches.\n\nThese operators determine how property values are compared during searches.",
      -    "enum": [
      -      "=",
      -      ">",
      -      "<",
      -      ">=",
      -      "<=",
      -      "!=",
      -      "CONTAINS",
      -      "STARTS",
      -      "ENDS"
      -    ],
      -    "title": "SearchOperator",
      -    "type": "string"
      -  },
      -  "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"
      -  },
      -  "TypeID": {
      -    "description": "Indicates the type of a data variable",
      -    "enum": [
      -      "BOOLEAN",
      -      "DATE",
      -      "DOUBLE",
      -      "GUID",
      -      "LONG",
      -      "STRING",
      -      "OBJECT",
      -      "BINARY"
      -    ],
      -    "title": "TypeID",
      -    "type": "string"
      -  }
      -}
    • changedOutput schema / properties / result / anyOf
      Previous value: -[
      -  {
      -    "items": {
      -      "$ref": "#/$defs/CachePropertyDescription"
      -    },
      -    "type": "array"
      -  },
      -  {
      -    "$ref": "#/$defs/ToolError"
      -  }
      -]New value: +[
      +  {
      +    "items": {
      +      "description": "Describes detailed attributes or metadata about a property.",
      +      "properties": {
      +        "cardinality": {
      +          "description": "Whether this property holds a single value or multiple values.",
      +          "enum": [
      +            "SINGLE",
      +            "LIST",
      +            "ENUM"
      +          ],
      +          "type": "string"
      +        },
      +        "data_type": {
      +          "description": "The type of data this property can hold",
      +          "enum": [
      +            "BOOLEAN",
      +            "DATE",
      +            "DOUBLE",
      +            "GUID",
      +            "LONG",
      +            "STRING",
      +            "OBJECT",
      +            "BINARY"
      +          ],
      +          "type": "string"
      +        },
      +        "descriptive_text": {
      +          "description": "Describes additional details about this property",
      +          "type": "string"
      +        },
      +        "display_name": {
      +          "description": "A user displayable name for this property",
      +          "type": "string"
      +        },
      +        "is_hidden": {
      +          "default": false,
      +          "description": "Indicates whether this property is hidden",
      +          "type": "boolean"
      +        },
      +        "is_searchable": {
      +          "description": "Indicates whether searches can include conditions involving this property",
      +          "type": "boolean"
      +        },
      +        "is_system_owned": {
      +          "default": false,
      +          "description": "Indicates whether this property is system-owned",
      +          "type": "boolean"
      +        },
      +        "symbolic_name": {
      +          "description": "Symbolic name that is used to reference this property",
      +          "type": "string"
      +        },
      +        "valid_search_operators": {
      +          "description": "The valid operators that can be used with this property in a search condition",
      +          "items": {
      +            "description": "Enum defining all valid search operators for repository searches.\n\nThese operators determine how property values are compared during searches.",
      +            "enum": [
      +              "=",
      +              ">",
      +              "<",
      +              ">=",
      +              "<=",
      +              "!=",
      +              "CONTAINS",
      +              "STARTS",
      +              "ENDS"
      +            ],
      +            "type": "string"
      +          },
      +          "type": "array"
      +        }
      +      },
      +      "required": [
      +        "symbolic_name",
      +        "display_name",
      +        "descriptive_text",
      +        "data_type",
      +        "cardinality",
      +        "is_searchable",
      +        "valid_search_operators"
      +      ],
      +      "type": "object"
      +    },
      +    "type": "array"
      +  },
      +  {
      +    "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: -"get_class_property_descriptionsOutput"
    • addedOutput schema / x-fastmcp-wrap-result
      Added value: +true
  3. First observedv1.0.0

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.