get-group-list
Retrieve and manage browser profile groups from AdsPower LocalAPI, enabling search by name with pagination support for efficient organization.
Instructions
Get the list of groups
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| groupName | No | The name of the group to search, use like to search, often used group name to find the group id, so eg: "test" will search "test" and "test1" | |
| size | No | The size of the page, max is 100, if get more than 100, you need to use the page to get the next page, default is 10 | |
| page | No | The page of the group, default is 1 |
Implementation Reference
- src/handlers/group.ts:45-59 (handler)The handler function that implements the logic for the 'get-group-list' tool by making an API request to fetch the list of groups based on optional filters (groupName, size, page).
async getGroupList({ groupName, size, page }: GetGroupListParams) { const params = new URLSearchParams(); if (groupName) { params.set('group_name', groupName); } if (size) { params.set('page_size', size.toString()); } if (page) { params.set('page', page.toString()); } const response = await axios.get(`${LOCAL_API_BASE}${API_ENDPOINTS.GET_GROUP_LIST}`, { params }); return `Group list: ${JSON.stringify(response.data.data.list, null, 2)}`; } - src/types/schemas.ts:152-156 (schema)Zod schema defining the input parameters for the 'get-group-list' tool.
getGroupListSchema: z.object({ groupName: z.string().optional().describe('The name of the group to search, use like to search, often used group name to find the group id, so eg: "test" will search "test" and "test1"'), size: z.number().optional().describe('The size of the page, max is 100, if get more than 100, you need to use the page to get the next page, default is 10'), page: z.number().optional().describe('The page of the group, default is 1') }).strict(), - src/utils/toolRegister.ts:42-43 (registration)Registration of the 'get-group-list' tool on the MCP server, linking the name, description, schema, and wrapped handler.
server.tool('get-group-list', 'Get the list of groups', schemas.getGroupListSchema.shape, wrapHandler(groupHandlers.getGroupList));