create_epic
Create a new epic in ServiceNow to organize and track large bodies of work, specifying details like description, priority, state, assignment group, and work notes.
Instructions
Create a new epic in ServiceNow
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| assigned_to | No | User assigned to the epic | |
| assignment_group | No | Group assigned to the epic | |
| description | No | Detailed description of the epic | |
| priority | No | Priority of epic (1 is Critical, 2 is High, 3 is Moderate, 4 is Low, 5 is Planning) | |
| short_description | Yes | Short description of the epic | |
| state | No | State of story (-6 is Draft,1 is Ready,2 is Work in progress, 3 is Complete, 4 is Cancelled) | |
| work_notes | No | Work notes to add to the epic. Used for adding notes and comments to an epic |
Implementation Reference
- The core handler function for the 'create_epic' tool. It validates input parameters using CreateEpicParams, constructs the request data, authenticates via auth_manager and server_config, and performs a POST request to the ServiceNow rm_epic table API.def create_epic( auth_manager: AuthManager, server_config: ServerConfig, params: Dict[str, Any], ) -> Dict[str, Any]: """ Create a new epic in ServiceNow. Args: auth_manager: The authentication manager. server_config: The server configuration. params: The parameters for creating the epic. Returns: The created epic. """ # Unwrap and validate parameters result = _unwrap_and_validate_params( params, CreateEpicParams, required_fields=["short_description"] ) if not result["success"]: return result validated_params = result["params"] # Prepare the request data data = { "short_description": validated_params.short_description, } # Add optional fields if provided if validated_params.description: data["description"] = validated_params.description if validated_params.priority: data["priority"] = validated_params.priority if validated_params.assignment_group: data["assignment_group"] = validated_params.assignment_group if validated_params.assigned_to: data["assigned_to"] = validated_params.assigned_to if validated_params.work_notes: data["work_notes"] = validated_params.work_notes # Get the instance URL instance_url = _get_instance_url(auth_manager, server_config) if not instance_url: return { "success": False, "message": "Cannot find instance_url in either server_config or auth_manager", } # Get the headers headers = _get_headers(auth_manager, server_config) if not headers: return { "success": False, "message": "Cannot find get_headers method in either auth_manager or server_config", } # Add Content-Type header headers["Content-Type"] = "application/json" # Make the API request url = f"{instance_url}/api/now/table/rm_epic" try: response = requests.post(url, json=data, headers=headers) response.raise_for_status() result = response.json() return { "success": True, "message": "Epic created successfully", "epic": result["result"], } except requests.exceptions.RequestException as e: logger.error(f"Error creating epic: {e}") return { "success": False, "message": f"Error creating epic: {str(e)}", }
- Pydantic model defining the input schema for the create_epic tool, including required short_description and optional fields like description, priority, etc.class CreateEpicParams(BaseModel): """Parameters for creating an epic.""" short_description: str = Field(..., description="Short description of the epic") description: Optional[str] = Field(None, description="Detailed description of the epic") priority: Optional[str] = Field(None, description="Priority of epic (1 is Critical, 2 is High, 3 is Moderate, 4 is Low, 5 is Planning)") state: Optional[str] = Field(None, description="State of story (-6 is Draft,1 is Ready,2 is Work in progress, 3 is Complete, 4 is Cancelled)") assignment_group: Optional[str] = Field(None, description="Group assigned to the epic") assigned_to: Optional[str] = Field(None, description="User assigned to the epic") work_notes: Optional[str] = Field(None, description="Work notes to add to the epic. Used for adding notes and comments to an epic")
- src/servicenow_mcp/utils/tool_utils.py:880-886 (registration)Registers the 'create_epic' tool in the MCP tool definitions dictionary within get_tool_definitions(), mapping the name to its handler (create_epic_tool), input schema (CreateEpicParams), return type, description, and serialization method."create_epic": ( create_epic_tool, CreateEpicParams, str, "Create a new epic in ServiceNow", "str", ),
- src/servicenow_mcp/tools/__init__.py:100-104 (registration)Imports the create_epic function from epic_tools.py into the tools package namespace, making it available for higher-level registration.from servicenow_mcp.tools.epic_tools import ( create_epic, update_epic, list_epics, )