ServiceNow MCP Server

Instructions

Implementation Reference

• src/servicenow_mcp/tools/workflow_tools.py:648-702 (handler)

  The core handler function for the 'deactivate_workflow' tool. It validates the workflow_id, prepares a PATCH request to set the workflow's 'active' field to 'false' on the 'wf_workflow' table, and returns the updated workflow details or an error.
  def deactivate_workflow( auth_manager: AuthManager, server_config: ServerConfig, params: Dict[str, Any], ) -> Dict[str, Any]: """ Deactivate a workflow in ServiceNow. Args: auth_manager: Authentication manager server_config: Server configuration params: Parameters for deactivating a workflow Returns: Dict[str, Any]: Deactivated workflow details """ # Unwrap parameters if needed params = _unwrap_params(params, DeactivateWorkflowParams) # 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"} # Prepare data for the API request data = { "active": "false", } # 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.patch(url, headers=headers, json=data) response.raise_for_status() result = response.json() return { "workflow": result.get("result", {}), "message": "Workflow deactivated successfully", } except requests.RequestException as e: logger.error(f"Error deactivating workflow: {e}") return {"error": str(e)} except Exception as e: logger.error(f"Unexpected error deactivating workflow: {e}") return {"error": str(e)}
• src/servicenow_mcp/tools/workflow_tools.py:82-86 (schema)

  Pydantic model defining the input parameters for the deactivate_workflow tool, requiring a workflow_id.
  class DeactivateWorkflowParams(BaseModel): """Parameters for deactivating a workflow.""" workflow_id: str = Field(..., description="Workflow ID or sys_id")
• src/servicenow_mcp/utils/tool_utils.py:539-545 (registration)

  Registers the 'deactivate_workflow' tool in the central tool definitions dictionary, linking the handler function, input schema, return type, description, and serialization method for use by the MCP server.
  "deactivate_workflow": ( deactivate_workflow_tool, DeactivateWorkflowParams, str, "Deactivate a workflow in ServiceNow", "str", # Tool returns simple message ),