ServiceNow MCP Server

Instructions

Implementation Reference

• src/servicenow_mcp/tools/user_tools.py:747-812 (handler)

  The core handler function that adds users to a group by resolving user IDs and creating sys_user_grmember records via the ServiceNow API.

  def add_group_members(
      config: ServerConfig,
      auth_manager: AuthManager,
      params: AddGroupMembersParams,
  ) -> GroupResponse:
      """
      Add members to a group in ServiceNow.
  
      Args:
          config: Server configuration.
          auth_manager: Authentication manager.
          params: Parameters for adding members to the group.
  
      Returns:
          Response with the result of the operation.
      """
      api_url = f"{config.api_url}/table/sys_user_grmember"
  
      success = True
      failed_members = []
  
      for member in params.members:
          # Get user ID if username is provided
          user_id = member
          if not member.startswith("sys_id:"):
              user = get_user(config, auth_manager, GetUserParams(user_name=member))
              if not user.get("success"):
                  user = get_user(config, auth_manager, GetUserParams(email=member))
  
              if user.get("success"):
                  user_id = user.get("user", {}).get("sys_id")
              else:
                  success = False
                  failed_members.append(member)
                  continue
  
          # Create group membership
          data = {
              "group": params.group_id,
              "user": user_id,
          }
  
          try:
              response = requests.post(
                  api_url,
                  json=data,
                  headers=auth_manager.get_headers(),
                  timeout=config.timeout,
              )
              response.raise_for_status()
          except requests.RequestException as e:
              logger.error(f"Failed to add member '{member}' to group: {e}")
              success = False
              failed_members.append(member)
  
      if failed_members:
          message = f"Some members could not be added to the group: {', '.join(failed_members)}"
      else:
          message = "All members added to the group successfully"
  
      return GroupResponse(
          success=success,
          message=message,
          group_id=params.group_id,
      )

• src/servicenow_mcp/tools/user_tools.py:105-112 (schema)

  Pydantic model defining the input parameters for the add_group_members tool: group_id and list of members.

  class AddGroupMembersParams(BaseModel):
      """Parameters for adding members to a group."""
  
      group_id: str = Field(..., description="Group ID or sys_id")
      members: List[str] = Field(
          ..., description="List of user sys_ids or usernames to add as members"
      )

• src/servicenow_mcp/utils/tool_utils.py:769-775 (registration)

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

  "add_group_members": (
      add_group_members_tool,
      AddGroupMembersParams,
      Dict[str, Any],  # Expects dict
      "Add members to an existing group in ServiceNow",
      "raw_dict",
  ),

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

  Import of add_group_members function from user_tools.py into the tools namespace.

  add_group_members,