get_workflow_details
Retrieve detailed information about a specific ServiceNow workflow, including configuration and optional version history, to understand and manage automation processes.
Instructions
Get detailed information about a specific workflow
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| workflow_id | Yes | Workflow ID or sys_id | |
| include_versions | No | Include workflow versions |
Implementation Reference
- Main handler function that retrieves detailed information about a specific workflow by making a GET request to the ServiceNow wf_workflow table API endpoint using the provided workflow_id.def get_workflow_details( auth_manager: AuthManager, server_config: ServerConfig, params: Dict[str, Any], ) -> Dict[str, Any]: """ Get detailed information about a specific workflow. Args: auth_manager: Authentication manager server_config: Server configuration params: Parameters for getting workflow details Returns: Dictionary containing the workflow details """ params = _unwrap_params(params, GetWorkflowDetailsParams) # Get the correct auth_manager and server_config try: auth_manager, server_config = _get_auth_and_config(auth_manager, server_config) except ValueError as e: logger.error(f"Error getting auth and config: {e}") return {"error": str(e)} workflow_id = params.get("workflow_id") if not workflow_id: return {"error": "Workflow ID is required"} # Make the API request try: headers = auth_manager.get_headers() url = f"{server_config.instance_url}/api/now/table/wf_workflow/{workflow_id}" response = requests.get(url, headers=headers) response.raise_for_status() result = response.json() return { "workflow": result.get("result", {}), } except requests.RequestException as e: logger.error(f"Error getting workflow details: {e}") return {"error": str(e)} except Exception as e: logger.error(f"Unexpected error getting workflow details: {e}") return {"error": str(e)}
- Pydantic model defining the input schema for the tool: requires 'workflow_id' (str), optional 'include_versions' (bool).class GetWorkflowDetailsParams(BaseModel): """Parameters for getting workflow details.""" workflow_id: str = Field(..., description="Workflow ID or sys_id") include_versions: Optional[bool] = Field(False, description="Include workflow versions")
- src/servicenow_mcp/utils/tool_utils.py:543-549 (registration)Tool registration in get_tool_definitions() dictionary, mapping the tool name to its implementation function alias, params model, return type, description, and serialization hint. Used by server.py to dynamically register tools."get_workflow_details": ( get_workflow_details_tool, GetWorkflowDetailsParams, str, # Expects JSON string "Get detailed information about a specific workflow", "json", # Tool returns list/dict ),
- Helper function used by the handler (and other tools) to normalize auth_manager and server_config parameters, handling swapped order or attribute detection.def _get_auth_and_config( auth_manager_or_config: Union[AuthManager, ServerConfig], server_config_or_auth: Union[ServerConfig, AuthManager], ) -> tuple[AuthManager, ServerConfig]: """ Get the correct auth_manager and server_config objects. This function handles the case where the parameters might be swapped. Args: auth_manager_or_config: Either an AuthManager or a ServerConfig. server_config_or_auth: Either a ServerConfig or an AuthManager. Returns: tuple[AuthManager, ServerConfig]: The correct auth_manager and server_config. Raises: ValueError: If the parameters are not of the expected types. """ # Check if the parameters are in the correct order if isinstance(auth_manager_or_config, AuthManager) and isinstance(server_config_or_auth, ServerConfig): return auth_manager_or_config, server_config_or_auth # Check if the parameters are swapped if isinstance(auth_manager_or_config, ServerConfig) and isinstance(server_config_or_auth, AuthManager): return server_config_or_auth, auth_manager_or_config # If we get here, at least one of the parameters is not of the expected type if hasattr(auth_manager_or_config, "get_headers"): auth_manager = auth_manager_or_config elif hasattr(server_config_or_auth, "get_headers"): auth_manager = server_config_or_auth else: raise ValueError("Cannot find get_headers method in either auth_manager or server_config") if hasattr(auth_manager_or_config, "instance_url"): server_config = auth_manager_or_config elif hasattr(server_config_or_auth, "instance_url"): server_config = server_config_or_auth else: raise ValueError("Cannot find instance_url attribute in either auth_manager or server_config") return auth_manager, server_config
- Helper function to unwrap parameters if passed as Pydantic model instance, converting to dict for internal use.def _unwrap_params(params: Any, param_class: Type[T]) -> Dict[str, Any]: """ Unwrap parameters if they're wrapped in a Pydantic model. This helps handle cases where the parameters are passed as a model instead of a dict. """ if isinstance(params, dict): return params if isinstance(params, param_class): return params.dict(exclude_none=True) return params