create_group
Create a new group in ServiceNow by specifying name, description, manager, parent group, type, email, members, and active status.
Instructions
Create a new group in ServiceNow
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | 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 | ||
| members | No | List of user sys_ids or usernames to add as members | |
| active | No | Whether the group is active |
Implementation Reference
- The handler function that implements the create_group tool. It constructs a POST request to the ServiceNow sys_user_group table API to create a new group, handles optional fields, adds members if specified, and returns a GroupResponse.def create_group( config: ServerConfig, auth_manager: AuthManager, params: CreateGroupParams, ) -> GroupResponse: """ Create a new group in ServiceNow. Args: config: Server configuration. auth_manager: Authentication manager. params: Parameters for creating the group. Returns: Response with the created group details. """ api_url = f"{config.api_url}/table/sys_user_group" # Build request data data = { "name": params.name, "active": str(params.active).lower(), } 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 # Make request try: response = requests.post( api_url, json=data, headers=auth_manager.get_headers(), timeout=config.timeout, ) response.raise_for_status() result = response.json().get("result", {}) group_id = result.get("sys_id") # Add members if provided if params.members and group_id: add_group_members( config, auth_manager, AddGroupMembersParams(group_id=group_id, members=params.members), ) return GroupResponse( success=True, message="Group created successfully", group_id=group_id, group_name=result.get("name"), ) except requests.RequestException as e: logger.error(f"Failed to create group: {e}") return GroupResponse( success=False, message=f"Failed to create group: {str(e)}", )
- Pydantic BaseModel defining the input parameters and validation for the create_group tool, including required name and optional fields like description, manager, members, etc.class CreateGroupParams(BaseModel): """Parameters for creating a group.""" name: str = Field(..., 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") members: Optional[List[str]] = Field( None, description="List of user sys_ids or usernames to add as members" ) active: Optional[bool] = Field(True, description="Whether the group is active")
- src/servicenow_mcp/utils/tool_utils.py:755-761 (registration)Tool registration entry in get_tool_definitions() dictionary that maps 'create_group' to its handler function (create_group_tool), input schema (CreateGroupParams), return type, description, and serialization method."create_group": ( create_group_tool, CreateGroupParams, Dict[str, Any], # Expects dict "Create a new group in ServiceNow", "raw_dict", ),
- src/servicenow_mcp/tools/__init__.py:67-77 (registration)Import statement in tools/__init__.py that exposes create_group function for use across the tools module.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, )
- Pydantic BaseModel defining the output response structure for group operations including create_group.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")