Skip to main content
Glama
ibm-ecm

Core Content Services MCP Server

Official
by ibm-ecm

get_class_property_descriptions

Obtain a complete list of all properties for a specified class, including system and hidden properties, to facilitate general document updates.

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.

:param class_symbolic_name: The symbolic name of the class to retrieve properties for

:returns: A list of CachePropertyDescription objects for each property (including system properties)

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
class_symbolic_nameYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. 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
  2. First observedv1.0.0

TDQS

A4.8/5.0
Behavior4/5

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

No annotations provided, so description carries full burden. It discloses it is a retrieval operation ('Retrieves'), but does not explicitly state safety or lack of side effects. However, the return type and parameter are explained. Minor gap for a read-only tool.

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 distinct sections: a short purpose sentence, then an IMPORTANT usage guideline, then parameter/returns. Every sentence adds value; front-loaded with purpose.

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 an output schema exists, description need not detail return fields. It covers purpose, usage, parameter, and return type. 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.

Parameters5/5

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

Schema has no description for the parameter (0% coverage). The description adds ':param class_symbolic_name: The symbolic name of the class to retrieve properties for', providing full semantic meaning beyond the schema.

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 states 'Retrieves ALL properties of a class including system properties' – clear verb+resource with scope. It distinguishes from siblings like get_searchable_property_descriptions by emphasizing 'ALL' and 'system properties'.

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?

Explicitly says 'Use this tool ONLY for general document updates...' and 'DO NOT use for property extraction workflows' – clear when and when-not to use, with implied alternative tool.

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