ServiceNow Service Catalog Integration
This document provides information about the ServiceNow Service Catalog integration in the ServiceNow MCP server.
Overview
Section titled “Overview”The ServiceNow Service Catalog integration allows you to:
- List service catalog categories
- List service catalog items
- Get detailed information about specific catalog items, including their variables
- Filter catalog items by category or search query
The following tools are available for interacting with the ServiceNow Service Catalog:
manage_catalog(action="list_categories")
Section titled “manage_catalog(action="list_categories")”Lists available service catalog categories.
Parameters:
limit(int, default: 10): Maximum number of categories to returnoffset(int, default: 0): Offset for paginationquery(string, optional): Search query for categoriesactive(boolean, default: true): Whether to only return active categories
Example:
from servicenow_mcp.tools.catalog_tools import ListCatalogCategoriesParams, list_catalog_categories
params = ListCatalogCategoriesParams( limit=5, query="hardware")result = list_catalog_categories(config, auth_manager, params)manage_catalog(action="list_items")
Section titled “manage_catalog(action="list_items")”Lists available service catalog items.
Parameters:
limit(int, default: 10): Maximum number of items to returnoffset(int, default: 0): Offset for paginationcategory(string, optional): Filter by categoryquery(string, optional): Search query for itemsactive(boolean, default: true): Whether to only return active items
Example:
from servicenow_mcp.tools.catalog_tools import ListCatalogItemsParams, list_catalog_items
params = ListCatalogItemsParams( limit=5, category="hardware", query="laptop")result = list_catalog_items(config, auth_manager, params)manage_catalog(action="get_item")
Section titled “manage_catalog(action="get_item")”Gets detailed information about a specific catalog item.
Parameters:
item_id(string, required): Catalog item ID or sys_id
Example:
from servicenow_mcp.tools.catalog_tools import GetCatalogItemParams, get_catalog_item
params = GetCatalogItemParams( item_id="item123")result = get_catalog_item(config, auth_manager, params)Resources
Section titled “Resources”The following resources are available for accessing the ServiceNow Service Catalog:
catalog://items
Section titled “catalog://items”Lists service catalog items.
Example:
catalog://itemscatalog://categories
Section titled “catalog://categories”Lists service catalog categories.
Example:
catalog://categoriescatalog://{item_id}
Section titled “catalog://{item_id}”Gets a specific catalog item by ID.
Example:
catalog://item123Integration with Claude Desktop
Section titled “Integration with Claude Desktop”To use the ServiceNow Service Catalog with Claude Desktop:
- Configure the ServiceNow MCP server in Claude Desktop
- Ask Claude questions about the service catalog
Example prompts:
- “Can you list the available service catalog categories in ServiceNow?”
- “Can you show me the available items in the ServiceNow service catalog?”
- “Can you list the catalog items in the Hardware category?”
- “Can you show me the details of the ‘New Laptop’ catalog item?”
- “Can you find catalog items related to ‘software’ in ServiceNow?”
- “Can you create a new category called ‘Cloud Services’ in the service catalog?”
- “Can you update the ‘Hardware’ category to rename it to ‘IT Equipment’?”
- “Can you move the ‘Virtual Machine’ catalog item to the ‘Cloud Services’ category?”
- “Can you create a subcategory called ‘Monitors’ under the ‘IT Equipment’ category?”
- “Can you reorganize our catalog by moving all software items to the ‘Software’ category?”
Example Scripts
Section titled “Example Scripts”Integration Test
Section titled “Integration Test”The examples/catalog_integration_test.py script demonstrates how to use the catalog tools directly:
python examples/catalog_integration_test.pyClaude Desktop Demo
Section titled “Claude Desktop Demo”The examples/claude_catalog_demo.py script demonstrates how to use the catalog functionality with Claude Desktop:
python examples/claude_catalog_demo.pyData Models
Section titled “Data Models”CatalogItemModel
Section titled “CatalogItemModel”Represents a ServiceNow catalog item.
Fields:
sys_id(string): Unique identifier for the catalog itemname(string): Name of the catalog itemshort_description(string, optional): Short description of the catalog itemdescription(string, optional): Detailed description of the catalog itemcategory(string, optional): Category of the catalog itemprice(string, optional): Price of the catalog itempicture(string, optional): Picture URL of the catalog itemactive(boolean, optional): Whether the catalog item is activeorder(integer, optional): Order of the catalog item in its category
CatalogCategoryModel
Section titled “CatalogCategoryModel”Represents a ServiceNow catalog category.
Fields:
sys_id(string): Unique identifier for the categorytitle(string): Title of the categorydescription(string, optional): Description of the categoryparent(string, optional): Parent category IDicon(string, optional): Icon of the categoryactive(boolean, optional): Whether the category is activeorder(integer, optional): Order of the category
CatalogItemVariableModel
Section titled “CatalogItemVariableModel”Represents a ServiceNow catalog item variable.
Fields:
sys_id(string): Unique identifier for the variablename(string): Name of the variablelabel(string): Label of the variabletype(string): Type of the variablemandatory(boolean, optional): Whether the variable is mandatorydefault_value(string, optional): Default value of the variablehelp_text(string, optional): Help text for the variableorder(integer, optional): Order of the variable