buddypress_update_group
Modify existing BuddyPress groups by updating their name, description, or privacy status to maintain current community information.
Instructions
Update an existing group
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| description | No | Group description | |
| id | Yes | Group ID | |
| name | No | Group name | |
| status | No | Group status (public, private, hidden) |
Implementation Reference
- src/index.ts:614-617 (handler)The execution handler for the 'buddypress_update_group' tool. It destructures the 'id' and remaining properties as 'body' from the input arguments, then makes a PUT request to the BuddyPress '/groups/{id}' endpoint using the shared 'buddypressRequest' helper function.else if (name === 'buddypress_update_group') { const { id, ...body } = args as any; result = await buddypressRequest(`/groups/${id}`, 'PUT', body); }
- src/index.ts:225-238 (registration)Registration of the 'buddypress_update_group' tool in the tools array, including its name, description, and input schema definition. This array is returned by the ListToolsRequestHandler.{ name: 'buddypress_update_group', description: 'Update an existing group', inputSchema: { type: 'object', properties: { id: { type: 'number', description: 'Group ID', required: true }, name: { type: 'string', description: 'Group name' }, description: { type: 'string', description: 'Group description' }, status: { type: 'string', description: 'Group status (public, private, hidden)' }, }, required: ['id'], }, },
- src/index.ts:228-237 (schema)Input schema definition for the 'buddypress_update_group' tool, specifying the required 'id' parameter and optional fields like name, description, and status.inputSchema: { type: 'object', properties: { id: { type: 'number', description: 'Group ID', required: true }, name: { type: 'string', description: 'Group name' }, description: { type: 'string', description: 'Group description' }, status: { type: 'string', description: 'Group status (public, private, hidden)' }, }, required: ['id'], },
- src/index.ts:18-46 (helper)Shared helper function 'buddypressRequest' used by all BuddyPress tools, including 'buddypress_update_group', to make authenticated API requests to the BuddyPress REST API endpoints.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(); }