update_group
Modify existing ServiceNow group details like name, description, manager, 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 handler function that executes the update_group tool logic by sending a PATCH request to the ServiceNow sys_user_group table endpoint.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 parameters and validation schema 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:808-814 (registration)Registration of the 'update_group' tool in the central tool_definitions dictionary, associating the handler function, input schema, 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-73 (registration)Re-export/import of the update_group function in the tools package __init__.py for easy access.from servicenow_mcp.tools.user_tools import ( create_user, update_user, get_user, list_users, create_group, update_group,
- Pydantic model used for the return type of the update_group handler and other group operations.class GroupResponse(BaseModel): """Response from group operations.""" success: bool = Field(..., description="Whether the operation was successful") message: str = Field(..., description="Message describing the result") group_id: Optional[str] = Field(None, description="ID of the affected group") group_name: Optional[str] = Field(None, description="Name of the affected group")