list_catalog_items
Retrieve available service catalog items from ServiceNow with filtering options for category, search query, and active status to support service request management.
Instructions
List service catalog items.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| active | No | Whether to only return active catalog items | |
| category | No | Filter by category | |
| limit | No | Maximum number of catalog items to return | |
| offset | No | Offset for pagination | |
| query | No | Search query for catalog items |
Implementation Reference
- Implementation of the list_catalog_items tool handler, which queries the ServiceNow sc_cat_item table API with filters and returns formatted catalog items.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.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 central tool definitions dictionary used by the MCP server."list_catalog_items": ( list_catalog_items_tool, ListCatalogItemsParams, str, # Expects JSON string "List service catalog items.", "json", # Tool returns list/dict ),
- src/servicenow_mcp/utils/tool_utils.py:32-34 (registration)Import and alias of the list_catalog_items function for use 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)Re-export of list_catalog_items from catalog_tools in the tools package __init__.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, )