buddypress_update_group
Modify an existing BuddyPress group by updating its name, description, or privacy status using the group ID.
Instructions
Update an existing group
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Group ID | |
| name | No | Group name | |
| description | No | Group description | |
| status | No | Group status (public, private, hidden) |
Implementation Reference
- src/index.ts:614-617 (handler)Handler logic that extracts the group ID and body from arguments and makes a PUT request to the BuddyPress /groups/{id} endpoint using the shared buddypressRequest helper.
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)Registers the buddypress_update_group tool in the tools list, including its name, description, and input schema definition.
{ 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 defining the parameters for the buddypress_update_group tool: required group ID and optional name, description, 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)Helper function that performs authenticated HTTP requests to the BuddyPress REST API endpoints, used by all tool handlers including buddypress_update_group.
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(); }