ServiceNow MCP Server

Instructions

Implementation Reference

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

  The handler function implementing the deactivate_workflow tool. It unwraps parameters using DeactivateWorkflowParams, authenticates, and sends a PATCH request to the ServiceNow wf_workflow table to set active to false.

  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 BaseModel defining the input schema 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)

  Registration of the deactivate_workflow tool in the tool definitions dictionary, mapping the name to the imported handler function, schema, return type, description, and serialization method.

  "deactivate_workflow": (
      deactivate_workflow_tool,
      DeactivateWorkflowParams,
      str,
      "Deactivate a workflow in ServiceNow",
      "str",  # Tool returns simple message
  ),

• src/servicenow_mcp/utils/tool_utils.py:264-265 (registration)

  Import of the deactivate_workflow handler aliased as deactivate_workflow_tool for use in tool registration.

      deactivate_workflow as deactivate_workflow_tool,
  )

• src/servicenow_mcp/tools/__init__.py:78-91 (registration)

  Re-export of deactivate_workflow from workflow_tools.py in the tools package __init__.

  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,
  )