update_group
Modify an existing ServiceNow group by updating its name, description, manager, parent group, type, email, or active status using the group ID.
Instructions
Update an existing group in ServiceNow
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| group_id | Yes | Group ID or sys_id to update | |
| name | No | Name of the group | |
| description | No | Description of the group | |
| manager | No | Manager of the group (sys_id or username) | |
| parent | No | Parent group (sys_id or name) | |
| type | No | Type of the group | |
| No | Email address for the group | ||
| active | No | Whether the group is active |
Implementation Reference
- The main handler function that executes the update_group tool logic by sending a PATCH request to the ServiceNow sys_user_group table.
def update_group( config: ServerConfig, auth_manager: AuthManager, params: UpdateGroupParams, ) -> GroupResponse: """ Update an existing group in ServiceNow. Args: config: Server configuration. auth_manager: Authentication manager. params: Parameters for updating the group. Returns: Response with the updated group details. """ api_url = f"{config.api_url}/table/sys_user_group/{params.group_id}" # Build request data data = {} if params.name: data["name"] = params.name if params.description: data["description"] = params.description if params.manager: data["manager"] = params.manager if params.parent: data["parent"] = params.parent if params.type: data["type"] = params.type if params.email: data["email"] = params.email if params.active is not None: data["active"] = str(params.active).lower() # Make request try: response = requests.patch( api_url, json=data, headers=auth_manager.get_headers(), timeout=config.timeout, ) response.raise_for_status() result = response.json().get("result", {}) return GroupResponse( success=True, message="Group updated successfully", group_id=result.get("sys_id"), group_name=result.get("name"), ) except requests.RequestException as e: logger.error(f"Failed to update group: {e}") return GroupResponse( success=False, message=f"Failed to update group: {str(e)}", ) - Pydantic BaseModel defining the input schema (parameters) for the update_group tool.
class UpdateGroupParams(BaseModel): """Parameters for updating a group.""" group_id: str = Field(..., description="Group ID or sys_id to update") name: Optional[str] = Field(None, description="Name of the group") description: Optional[str] = Field(None, description="Description of the group") manager: Optional[str] = Field(None, description="Manager of the group (sys_id or username)") parent: Optional[str] = Field(None, description="Parent group (sys_id or name)") type: Optional[str] = Field(None, description="Type of the group") email: Optional[str] = Field(None, description="Email address for the group") active: Optional[bool] = Field(None, description="Whether the group is active") - src/servicenow_mcp/utils/tool_utils.py:762-768 (registration)Registers the 'update_group' tool in the central tool_definitions dictionary, associating the handler function, input schema, return type hint, description, and serialization method.
"update_group": ( update_group_tool, UpdateGroupParams, Dict[str, Any], # Expects dict "Update an existing group in ServiceNow", "raw_dict", ), - src/servicenow_mcp/tools/__init__.py:67-174 (registration)Imports the update_group function into the tools package namespace, making it available for further registration.
from servicenow_mcp.tools.user_tools import ( create_user, update_user, get_user, list_users, create_group, update_group, add_group_members, remove_group_members, list_groups, ) 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, ) # from servicenow_mcp.tools.problem_tools import create_problem, update_problem # from servicenow_mcp.tools.request_tools import create_request, update_request __all__ = [ # Incident tools "create_incident", "update_incident", "add_comment", "resolve_incident", "list_incidents", # Catalog tools "list_catalog_items", "get_catalog_item", "list_catalog_categories", "create_catalog_category", "update_catalog_category", "move_catalog_items", "get_optimization_recommendations", "update_catalog_item", "create_catalog_item_variable", "list_catalog_item_variables", "update_catalog_item_variable", # Change management tools "create_change_request", "update_change_request", "list_change_requests", "get_change_request_details", "add_change_task", "submit_change_for_approval", "approve_change", "reject_change", # Workflow management tools "list_workflows", "get_workflow_details", "list_workflow_versions", "get_workflow_activities", "create_workflow", "update_workflow", "activate_workflow", "deactivate_workflow", "add_workflow_activity", "update_workflow_activity", "delete_workflow_activity", "reorder_workflow_activities", # Changeset tools "list_changesets", "get_changeset_details", "create_changeset", "update_changeset", "commit_changeset", "publish_changeset", "add_file_to_changeset", # Script Include tools "list_script_includes", "get_script_include", "create_script_include", "update_script_include", "delete_script_include", # Knowledge Base tools "create_knowledge_base", "list_knowledge_bases", "create_category", "list_categories", "create_article", "update_article", "publish_article", "list_articles", "get_article", # User management tools "create_user", "update_user", "get_user", "list_users", "create_group", "update_group", - Imports the update_group handler from user_tools.py with an alias for use in tool registration.
update_group as update_group_tool, )