create_scrum_task
Create a new scrum task in ServiceNow to manage agile development work by specifying story, description, priority, hours, and assignment details.
Instructions
Create a new scrum task in ServiceNow
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| story | Yes | Short description of the story. It requires the System ID of the story. | |
| short_description | Yes | Short description of the scrum task | |
| priority | No | Priority of scrum task (1 is Critical, 2 is High, 3 is Moderate, 4 is Low) | |
| planned_hours | No | Planned hours for the scrum task | |
| remaining_hours | No | Remaining hours for the scrum task | |
| hours | No | Actual Hours for the scrum task | |
| description | No | Detailed description of the scrum task | |
| type | No | Type of scrum task (1 is Analysis, 2 is Coding, 3 is Documentation, 4 is Testing) | |
| state | No | State of scrum task (-6 is Draft,1 is Ready, 2 is Work in progress, 3 is Complete, 4 is Cancelled) | |
| assignment_group | No | Group assigned to the scrum task | |
| assigned_to | No | User assigned to the scrum task | |
| work_notes | No | Work notes to add to the scrum task |
Implementation Reference
- The core handler function that implements the logic for the 'create_scrum_task' tool. It validates parameters using CreateScrumTaskParams, prepares the data, makes a POST request to ServiceNow's rm_scrum_task table, and returns the result.def create_scrum_task( auth_manager: AuthManager, server_config: ServerConfig, params: Dict[str, Any], ) -> Dict[str, Any]: """ Create a new scrum task in ServiceNow. Args: auth_manager: The authentication manager. server_config: The server configuration. params: The parameters for creating the scrum task. Returns: The created scrum task. """ # Unwrap and validate parameters result = _unwrap_and_validate_params( params, CreateScrumTaskParams, required_fields=["short_description", "story"] ) if not result["success"]: return result validated_params = result["params"] # Prepare the request data data = { "story": validated_params.story, "short_description": validated_params.short_description, } # Add optional fields if provided if validated_params.priority: data["priority"] = validated_params.priority if validated_params.planned_hours: data["planned_hours"] = validated_params.planned_hours if validated_params.remaining_hours: data["remaining_hours"] = validated_params.remaining_hours if validated_params.hours: data["hours"] = validated_params.hours if validated_params.description: data["description"] = validated_params.description if validated_params.type: data["type"] = validated_params.type if validated_params.state: data["state"] = validated_params.state 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_scrum_task" try: response = requests.post(url, json=data, headers=headers) response.raise_for_status() result = response.json() return { "success": True, "message": "Scrum Task created successfully", "scrum_task": result["result"], } except requests.exceptions.RequestException as e: logger.error(f"Error creating scrum task: {e}") return { "success": False, "message": f"Error creating scrum task: {str(e)}", }
- Pydantic model defining the input parameters and validation schema for the create_scrum_task tool.class CreateScrumTaskParams(BaseModel): """Parameters for creating a scrum task.""" story: str = Field(..., description="Short description of the story. It requires the System ID of the story.") short_description: str = Field(..., description="Short description of the scrum task") priority: Optional[str] = Field(None, description="Priority of scrum task (1 is Critical, 2 is High, 3 is Moderate, 4 is Low)") planned_hours: Optional[int] = Field(None, description="Planned hours for the scrum task") remaining_hours: Optional[int] = Field(None, description="Remaining hours for the scrum task") hours: Optional[int] = Field(None, description="Actual Hours for the scrum task") description: Optional[str] = Field(None, description="Detailed description of the scrum task") type: Optional[str] = Field(None, description="Type of scrum task (1 is Analysis, 2 is Coding, 3 is Documentation, 4 is Testing)") state: Optional[str] = Field(None, description="State of scrum task (-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 scrum task") assigned_to: Optional[str] = Field(None, description="User assigned to the scrum task") work_notes: Optional[str] = Field(None, description="Work notes to add to the scrum task")
- src/servicenow_mcp/utils/tool_utils.py:902-908 (registration)The registration entry in the tool_definitions dictionary that registers 'create_scrum_task' with its handler function (aliased as create_scrum_task_tool), input schema CreateScrumTaskParams, return type, description, and serialization method."create_scrum_task": ( create_scrum_task_tool, CreateScrumTaskParams, str, "Create a new scrum task in ServiceNow", "str", ),
- src/servicenow_mcp/utils/tool_utils.py:321-325 (registration)Import of the create_scrum_task function aliased as create_scrum_task_tool for use in tool registration.from servicenow_mcp.tools.scrum_task_tools import ( create_scrum_task as create_scrum_task_tool, update_scrum_task as update_scrum_task_tool, list_scrum_tasks as list_scrum_tasks_tool, )
- Helper function used by the handler to unwrap, validate parameters against the Pydantic schema, and handle common input formats.def _unwrap_and_validate_params(params: Any, model_class: Type[T], required_fields: List[str] = None) -> Dict[str, Any]: """ Helper function to unwrap and validate parameters. Args: params: The parameters to unwrap and validate. model_class: The Pydantic model class to validate against. required_fields: List of required field names. Returns: A tuple of (success, result) where result is either the validated parameters or an error message. """ # Handle case where params might be wrapped in another dictionary if isinstance(params, dict) and len(params) == 1 and "params" in params and isinstance(params["params"], dict): logger.warning("Detected params wrapped in a 'params' key. Unwrapping...") params = params["params"] # Handle case where params might be a Pydantic model object if not isinstance(params, dict): try: # Try to convert to dict if it's a Pydantic model logger.warning("Params is not a dictionary. Attempting to convert...") params = params.dict() if hasattr(params, "dict") else dict(params) except Exception as e: logger.error(f"Failed to convert params to dictionary: {e}") return { "success": False, "message": f"Invalid parameters format. Expected a dictionary, got {type(params).__name__}", } # Validate required parameters are present if required_fields: for field in required_fields: if field not in params: return { "success": False, "message": f"Missing required parameter '{field}'", } try: # Validate parameters against the model validated_params = model_class(**params) return { "success": True, "params": validated_params, } except Exception as e: logger.error(f"Error validating parameters: {e}") return { "success": False, "message": f"Error validating parameters: {str(e)}", }