Skip to main content
Glama

buddypress_favorite_activity

Mark activity items as favorites or remove them from favorites to highlight important community content and personalize user feeds in BuddyPress sites.

Instructions

Favorite or unfavorite an activity item

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesActivity ID

Implementation Reference

  • Handler that toggles favorite status of an activity item by sending a PUT request to the BuddyPress /activity/{id}/favorite endpoint.
    else if (name === 'buddypress_favorite_activity') {
      result = await buddypressRequest(`/activity/${args.id}/favorite`, 'PUT');
    }
  • src/index.ts:117-127 (registration)
    Tool registration in the tools array, defining name, description, and input schema (requires activity ID).
    {
      name: 'buddypress_favorite_activity',
      description: 'Favorite or unfavorite an activity item',
      inputSchema: {
        type: 'object',
        properties: {
          id: { type: 'number', description: 'Activity ID', required: true },
        },
        required: ['id'],
      },
    },
  • Input schema validation for the tool, requiring a numeric activity ID.
    inputSchema: {
      type: 'object',
      properties: {
        id: { type: 'number', description: 'Activity ID', required: true },
      },
      required: ['id'],
    },
  • Shared helper function used by all BuddyPress tools to make authenticated API requests.
    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();
    }
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description carries the full burden of behavioral disclosure. It states the action but doesn't reveal if this is a toggle (favorite/unfavorite) or a set operation, what permissions are required, whether it's idempotent, or what the response looks like. For a mutation tool with zero annotation coverage, this leaves significant gaps in understanding behavior.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, efficient sentence that directly states the tool's function without unnecessary words. It's front-loaded with the core action and resource, making it easy to parse quickly. Every part of the sentence contributes essential information.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's mutation nature (favoriting/unfavoriting), lack of annotations, and no output schema, the description is incomplete. It doesn't cover behavioral aspects like toggle vs. set, error conditions, or response format. For a tool that modifies data, more context is needed to use it effectively.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, with the single parameter 'id' documented as 'Activity ID'. The description doesn't add any meaning beyond this, such as format examples or constraints. With high schema coverage, the baseline score of 3 is appropriate as the schema handles parameter documentation adequately.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the action ('favorite or unfavorite') and resource ('an activity item'), making the purpose immediately understandable. It distinguishes from siblings like 'buddypress_get_activity' or 'buddypress_update_activity' by focusing on favoriting rather than retrieval or modification. However, it doesn't specify if this toggles or sets a specific state, which slightly reduces specificity.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides no guidance on when to use this tool versus alternatives. It doesn't mention prerequisites (e.g., needing an existing activity item), exclusions, or related tools like 'buddypress_get_activity' for checking status. Usage is implied by the action but lacks explicit context for selection.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

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