ServiceNow MCP Server

Instructions

Implementation Reference

• src/servicenow_mcp/tools/workflow_tools.py:251-297 (handler)

  Core handler function that retrieves workflow details by querying the ServiceNow wf_workflow table API with the given 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)}
• src/servicenow_mcp/tools/workflow_tools.py:33-38 (schema)

  Pydantic input schema defining required workflow_id and optional include_versions for the tool.
  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:497-503 (registration)

  MCP tool registration mapping tool name to its implementation function, input schema, description, and serialization hint.
  "get_workflow_details": ( get_workflow_details_tool, GetWorkflowDetailsParams, str, # Expects JSON string "Get detailed information about a specific workflow", "json", # Tool returns list/dict ),
• src/servicenow_mcp/tools/__init__.py:78-91 (registration)

  Python package export/import of workflow tools including get_workflow_details for use across the codebase.
  from servicenow_mcp.tools.workflow_tools import ( activate_workflow, add_workflow_activity, create_workflow, deactivate_workflow, delete_workflow_activity, get_workflow_activities, get_workflow_details, list_workflow_versions, list_workflows, reorder_workflow_activities, update_workflow, update_workflow_activity, )
• src/servicenow_mcp/tools/workflow_tools.py:138-181 (helper)

  Helper function to normalize auth_manager and server_config arguments, handling potential order swaps.
  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