buddypress_list_activities
Retrieve activity stream items from BuddyPress communities with filters for users, groups, search terms, and comment display options.
Instructions
List activity stream items with optional filters
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| display_comments | No | Include comments | |
| group_id | No | Filter by group ID | |
| page | No | Page number (default: 1) | |
| per_page | No | Items per page (default: 20) | |
| scope | No | Activity scope (all, friends, groups, favorites, mentions) | |
| search | No | Search term | |
| user_id | No | Filter by user ID |
Implementation Reference
- src/index.ts:545-554 (handler)Handler logic for the buddypress_list_activities tool. Builds URL query parameters from tool arguments and calls the BuddyPress API endpoint /activity via the helper function.if (name === 'buddypress_list_activities') { const params = new URLSearchParams(); if (args.page) params.append('page', String(args.page)); if (args.per_page) params.append('per_page', String(args.per_page)); if (args.search) params.append('search', String(args.search)); if (args.user_id) params.append('user_id', String(args.user_id)); if (args.group_id) params.append('group_id', String(args.group_id)); if (args.scope) params.append('scope', String(args.scope)); if (args.display_comments !== undefined) params.append('display_comments', String(args.display_comments)); result = await buddypressRequest(`/activity?${params}`);
- src/index.ts:51-66 (registration)Registration of the buddypress_list_activities tool in the tools array, including name, description, and input schema definition.{ name: 'buddypress_list_activities', description: 'List activity stream items with optional filters', inputSchema: { type: 'object', properties: { page: { type: 'number', description: 'Page number (default: 1)' }, per_page: { type: 'number', description: 'Items per page (default: 20)' }, search: { type: 'string', description: 'Search term' }, user_id: { type: 'number', description: 'Filter by user ID' }, group_id: { type: 'number', description: 'Filter by group ID' }, scope: { type: 'string', description: 'Activity scope (all, friends, groups, favorites, mentions)' }, display_comments: { type: 'boolean', description: 'Include comments' }, }, }, },
- src/index.ts:54-65 (schema)Input schema definition for validating tool arguments.inputSchema: { type: 'object', properties: { page: { type: 'number', description: 'Page number (default: 1)' }, per_page: { type: 'number', description: 'Items per page (default: 20)' }, search: { type: 'string', description: 'Search term' }, user_id: { type: 'number', description: 'Filter by user ID' }, group_id: { type: 'number', description: 'Filter by group ID' }, scope: { type: 'string', description: 'Activity scope (all, friends, groups, favorites, mentions)' }, display_comments: { type: 'boolean', description: 'Include comments' }, }, },
- src/index.ts:18-46 (helper)Shared helper function used by all BuddyPress tools to make authenticated API requests to the BuddyPress REST API.async function buddypressRequest( endpoint: string, method: string = 'GET', body?: any ): Promise<any> { const url = `${BUDDYPRESS_URL}/wp-json/buddypress/v2${endpoint}`; const auth = Buffer.from(`${BUDDYPRESS_USERNAME}:${BUDDYPRESS_PASSWORD}`).toString('base64'); const options: any = { method, headers: { 'Authorization': `Basic ${auth}`, 'Content-Type': 'application/json', }, }; if (body && method !== 'GET') { options.body = JSON.stringify(body); } const response = await fetch(url, options); if (!response.ok) { const errorText = await response.text(); throw new Error(`BuddyPress API Error (${response.status}): ${errorText}`); } return await response.json(); }