list_catalog_items
Retrieve available service catalog items from ServiceNow with filtering options for category, search query, and active status.
Instructions
List service catalog items.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Maximum number of catalog items to return | |
| offset | No | Offset for pagination | |
| category | No | Filter by category | |
| query | No | Search query for catalog items | |
| active | No | Whether to only return active catalog items |
Implementation Reference
- The main handler function that implements the list_catalog_items tool. It queries the ServiceNow API for sc_cat_item table with filters, formats the response, and returns a structured dictionary.def list_catalog_items( config: ServerConfig, auth_manager: AuthManager, params: ListCatalogItemsParams, ) -> Dict[str, Any]: """ List service catalog items from ServiceNow. Args: config: Server configuration auth_manager: Authentication manager params: Parameters for listing catalog items Returns: Dictionary containing catalog items and metadata """ logger.info("Listing service catalog items") # Build the API URL url = f"{config.instance_url}/api/now/table/sc_cat_item" # Prepare query parameters query_params = { "sysparm_limit": params.limit, "sysparm_offset": params.offset, "sysparm_display_value": "true", "sysparm_exclude_reference_link": "true", } # Add filters filters = [] if params.active: filters.append("active=true") if params.category: filters.append(f"category={params.category}") if params.query: filters.append(f"short_descriptionLIKE{params.query}^ORnameLIKE{params.query}") if filters: query_params["sysparm_query"] = "^".join(filters) # Make the API request headers = auth_manager.get_headers() headers["Accept"] = "application/json" try: response = requests.get(url, headers=headers, params=query_params) response.raise_for_status() # Process the response result = response.json() items = result.get("result", []) # Format the response formatted_items = [] for item in items: formatted_items.append({ "sys_id": item.get("sys_id", ""), "name": item.get("name", ""), "short_description": item.get("short_description", ""), "category": item.get("category", ""), "price": item.get("price", ""), "picture": item.get("picture", ""), "active": item.get("active", ""), "order": item.get("order", ""), }) return { "success": True, "message": f"Retrieved {len(formatted_items)} catalog items", "items": formatted_items, "total": len(formatted_items), "limit": params.limit, "offset": params.offset, } except requests.exceptions.RequestException as e: logger.error(f"Error listing catalog items: {str(e)}") return { "success": False, "message": f"Error listing catalog items: {str(e)}", "items": [], "total": 0, "limit": params.limit, "offset": params.offset, }
- Pydantic model defining the input parameters for the list_catalog_items tool, including pagination, filtering by category/query/active status.class ListCatalogItemsParams(BaseModel): """Parameters for listing service catalog items.""" limit: int = Field(10, description="Maximum number of catalog items to return") offset: int = Field(0, description="Offset for pagination") category: Optional[str] = Field(None, description="Filter by category") query: Optional[str] = Field(None, description="Search query for catalog items") active: bool = Field(True, description="Whether to only return active catalog items")
- src/servicenow_mcp/utils/tool_utils.py:400-406 (registration)Registration of the 'list_catalog_items' tool in the get_tool_definitions dictionary, mapping name to implementation function, input schema model, return type hint, description, and serialization method. This is used by the MCP server to expose the tool."list_catalog_items": ( list_catalog_items_tool, ListCatalogItemsParams, str, # Expects JSON string "List service catalog items.", "json", # Tool returns list/dict ),
- Import alias for the list_catalog_items function, used in tool registration.from servicenow_mcp.tools.catalog_tools import ( list_catalog_items as list_catalog_items_tool, )
- src/servicenow_mcp/tools/__init__.py:10-17 (registration)Import of catalog tools including list_catalog_items into the tools package __init__, making it available for further imports and tool_utils.from servicenow_mcp.tools.catalog_tools import ( create_catalog_category, get_catalog_item, list_catalog_categories, list_catalog_items, move_catalog_items, update_catalog_category, )