get_catalog_item
Retrieve a specific service catalog item using its ID or sys_id via the ServiceNow API.
Instructions
Get a specific service catalog item.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| params | Yes |
Implementation Reference
- Main handler function that retrieves a specific ServiceNow service catalog item by ID using the Table API, formats the item details including variables, and returns a structured CatalogResponse.
def get_catalog_item( config: ServerConfig, auth_manager: AuthManager, params: GetCatalogItemParams, ) -> CatalogResponse: """ Get a specific service catalog item from ServiceNow. Args: config: Server configuration auth_manager: Authentication manager params: Parameters for getting a catalog item Returns: Response containing the catalog item details """ logger.info(f"Getting service catalog item: {params.item_id}") # Build the API URL url = f"{config.instance_url}/api/now/table/sc_cat_item/{params.item_id}" # Prepare query parameters query_params = { "sysparm_display_value": "true", "sysparm_exclude_reference_link": "true", } # 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() item = result.get("result", {}) if not item: return CatalogResponse( success=False, message=f"Catalog item not found: {params.item_id}", data=None, ) # Format the response formatted_item = { "sys_id": item.get("sys_id", ""), "name": item.get("name", ""), "short_description": item.get("short_description", ""), "description": item.get("description", ""), "category": item.get("category", ""), "price": item.get("price", ""), "picture": item.get("picture", ""), "active": item.get("active", ""), "order": item.get("order", ""), "delivery_time": item.get("delivery_time", ""), "availability": item.get("availability", ""), "variables": get_catalog_item_variables(config, auth_manager, params.item_id), } return CatalogResponse( success=True, message=f"Retrieved catalog item: {item.get('name', '')}", data=formatted_item, ) except requests.exceptions.RequestException as e: logger.error(f"Error getting catalog item: {str(e)}") return CatalogResponse( success=False, message=f"Error getting catalog item: {str(e)}", data=None, ) - Pydantic model defining the input parameters for the get_catalog_item tool, requiring an item_id.
class GetCatalogItemParams(BaseModel): """Parameters for getting a specific service catalog item.""" item_id: str = Field(..., description="Catalog item ID or sys_id") - Pydantic model used for the output response of the get_catalog_item tool and other catalog operations.
class CatalogResponse(BaseModel): """Response from catalog operations.""" success: bool = Field(..., description="Whether the operation was successful") message: str = Field(..., description="Message describing the result") data: Optional[Dict[str, Any]] = Field(None, description="Response data") - src/servicenow_mcp/utils/tool_utils.py:418-424 (registration)Tool registration in the central tool definitions dictionary, mapping the tool name to its handler, params schema, return type, description, and serialization method.
"get_catalog_item": ( get_catalog_item_tool, GetCatalogItemParams, str, # Expects JSON string "Get a specific service catalog item.", "json_dict", # Tool returns Pydantic model ), - Helper function called by get_catalog_item to fetch and format the variables (options) for the catalog item from the item_option_new table.
def get_catalog_item_variables( config: ServerConfig, auth_manager: AuthManager, item_id: str, ) -> List[Dict[str, Any]]: """ Get variables for a specific service catalog item. Args: config: Server configuration auth_manager: Authentication manager item_id: Catalog item ID or sys_id Returns: List of variables for the catalog item """ logger.info(f"Getting variables for catalog item: {item_id}") # Build the API URL url = f"{config.instance_url}/api/now/table/item_option_new" # Prepare query parameters query_params = { "sysparm_query": f"cat_item={item_id}^ORDERBYorder", "sysparm_display_value": "true", "sysparm_exclude_reference_link": "true", } # 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() variables = result.get("result", []) # Format the response formatted_variables = [] for variable in variables: formatted_variables.append({ "sys_id": variable.get("sys_id", ""), "name": variable.get("name", ""), "label": variable.get("question_text", ""), "type": variable.get("type", ""), "mandatory": variable.get("mandatory", ""), "default_value": variable.get("default_value", ""), "help_text": variable.get("help_text", ""), "order": variable.get("order", ""), }) return formatted_variables except requests.exceptions.RequestException as e: logger.error(f"Error getting catalog item variables: {str(e)}") return []