buddypress_delete_friendship
Remove a BuddyPress friendship connection between users by providing the specific friendship ID to manage community relationships.
Instructions
Delete a friendship
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Friendship ID |
Implementation Reference
- src/index.ts:682-684 (handler)Handler function that executes the tool by sending a DELETE request to the BuddyPress /friends/{id} endpoint using the shared buddypressRequest helper.else if (name === 'buddypress_delete_friendship') { result = await buddypressRequest(`/friends/${args.id}`, 'DELETE'); }
- src/index.ts:393-399 (schema)Input schema defining the required 'id' parameter of type number for the friendship ID.inputSchema: { type: 'object', properties: { id: { type: 'number', description: 'Friendship ID', required: true }, }, required: ['id'], },
- src/index.ts:390-400 (registration)Tool registration in the tools array, including name, description, and input schema.{ name: 'buddypress_delete_friendship', description: 'Delete a friendship', inputSchema: { type: 'object', properties: { id: { type: 'number', description: 'Friendship ID', required: true }, }, required: ['id'], }, },
- src/index.ts:18-46 (helper)Shared helper function used by all BuddyPress tools, including this one, to make authenticated HTTP 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(); }