Skip to main content
Glama

buddypress_get_group

Retrieve a specific BuddyPress group by its ID to access group details for community management tasks.

Instructions

Get a single group by ID

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesGroup ID

Implementation Reference

  • The execution handler for the 'buddypress_get_group' tool. It retrieves the group by calling the BuddyPress REST API endpoint `/groups/${args.id}` using the shared `buddypressRequest` helper.
    else if (name === 'buddypress_get_group') {
      result = await buddypressRequest(`/groups/${args.id}`);
    }
  • src/index.ts:199-209 (registration)
    Tool registration in the tools array. Defines the name, description, and input schema for 'buddypress_get_group', which is returned by the ListTools handler.
    {
      name: 'buddypress_get_group',
      description: 'Get a single group by ID',
      inputSchema: {
        type: 'object',
        properties: {
          id: { type: 'number', description: 'Group ID', required: true },
        },
        required: ['id'],
      },
    },
  • Input schema definition for the tool, specifying that a numeric 'id' parameter is required.
    inputSchema: {
      type: 'object',
      properties: {
        id: { type: 'number', description: 'Group ID', required: true },
      },
      required: ['id'],
    },
  • Shared helper function used by all BuddyPress tools, including buddypress_get_group, 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();
    }

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/vapvarun/buddypress-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server