get_searchable_property_descriptions
Retrieve searchable properties for a class in IBM FileNet Content Manager to enable targeted metadata searches and document management.
Instructions
Retrieves only the searchable properties of a class.
:param class_symbolic_name: The symbolic name of the class to retrieve searchable properties for
:returns: A list of CachePropertyDescription objects for properties that are searchable
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| class_symbolic_name | Yes |
Implementation Reference
- The core handler function for the 'get_searchable_property_descriptions' tool. It retrieves class metadata using get_class_metadata_tool, filters for searchable properties (where prop.is_searchable is true), and returns the list or propagates any ToolError.def get_searchable_property_descriptions( class_symbolic_name: str, ) -> Union[List[CachePropertyDescription], ToolError]: """ Retrieves only the searchable properties of a class. :param class_symbolic_name: The symbolic name of the class to retrieve searchable properties for :returns: A list of CachePropertyDescription objects for properties that are searchable """ class_metadata = get_class_metadata_tool( graphql_client=graphql_client, class_symbolic_name=class_symbolic_name, metadata_cache=metadata_cache, ) # If there was an error retrieving the class metadata, return it if isinstance(class_metadata, ToolError): return class_metadata # Filter the properties to include only searchable ones searchable_properties = [ prop for prop in class_metadata.property_descriptions if prop.is_searchable ] # Return only the list of searchable property descriptions return searchable_properties
- src/cs_mcp_server/tools/search.py:188-190 (registration)The @mcp.tool decorator registers the nested function as the 'get_searchable_property_descriptions' tool within the register_search_tools function.@mcp.tool( name="get_searchable_property_descriptions", )
- Input schema defined by function parameter 'class_symbolic_name: str' and output as Union[List[CachePropertyDescription], ToolError], described in docstring.class_symbolic_name: str, ) -> Union[List[CachePropertyDescription], ToolError]: """ Retrieves only the searchable properties of a class. :param class_symbolic_name: The symbolic name of the class to retrieve searchable properties for :returns: A list of CachePropertyDescription objects for properties that are searchable