ServiceNow MCP Server

Instructions

Implementation Reference

• src/servicenow_mcp/tools/workflow_tools.py:592-646 (handler)

  The main handler function that implements the logic for activating a workflow by sending a PATCH request to set the 'active' field to 'true' in the ServiceNow wf_workflow table.

  def activate_workflow(
      auth_manager: AuthManager,
      server_config: ServerConfig,
      params: Dict[str, Any],
  ) -> Dict[str, Any]:
      """
      Activate a workflow in ServiceNow.
      
      Args:
          auth_manager: Authentication manager
          server_config: Server configuration
          params: Parameters for activating a workflow
          
      Returns:
          Dict[str, Any]: Activated workflow details
      """
      # Unwrap parameters if needed
      params = _unwrap_params(params, ActivateWorkflowParams)
      
      # 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": "true",
      }
      
      # 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 activated successfully",
          }
      except requests.RequestException as e:
          logger.error(f"Error activating workflow: {e}")
          return {"error": str(e)}
      except Exception as e:
          logger.error(f"Unexpected error activating workflow: {e}")
          return {"error": str(e)}

• src/servicenow_mcp/tools/workflow_tools.py:76-80 (schema)

  Pydantic BaseModel defining the input schema for the activate_workflow tool, requiring a 'workflow_id' string.

  class ActivateWorkflowParams(BaseModel):
      """Parameters for activating a workflow."""
      
      workflow_id: str = Field(..., description="Workflow ID or sys_id")

• src/servicenow_mcp/utils/tool_utils.py:578-584 (registration)

  Explicit registration of the 'activate_workflow' tool in the central tool_definitions dictionary used by the MCP server, specifying the handler function alias, input schema model, return type hint, description, and serialization method.

  "activate_workflow": (
      activate_workflow_tool,
      ActivateWorkflowParams,
      str,
      "Activate a workflow in ServiceNow",
      "str",  # Tool returns simple message
  ),

• src/servicenow_mcp/utils/tool_utils.py:254-256 (registration)

  Import of the activate_workflow handler function from workflow_tools.py, aliased as activate_workflow_tool for use in the tool definitions.

  from servicenow_mcp.tools.workflow_tools import (
      activate_workflow as activate_workflow_tool,
  )

• src/servicenow_mcp/utils/tool_utils.py:240-253 (schema)

  Import of the ActivateWorkflowParams schema model (among others) from workflow_tools.py for use in tool registration.

  from servicenow_mcp.tools.workflow_tools import (
      ActivateWorkflowParams,
      AddWorkflowActivityParams,
      CreateWorkflowParams,
      DeactivateWorkflowParams,
      DeleteWorkflowActivityParams,
      GetWorkflowActivitiesParams,
      GetWorkflowDetailsParams,
      ListWorkflowsParams,
      ListWorkflowVersionsParams,
      ReorderWorkflowActivitiesParams,
      UpdateWorkflowActivityParams,
      UpdateWorkflowParams,
  )