Skip to main content
Glama

waha_get_group_join_info

Retrieve WhatsApp group details from invite links to preview information before joining.

Instructions

Get group information from invite link without joining.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
codeYesInvite code or full URL

Implementation Reference

  • MCP tool handler that extracts the invite code from arguments, validates it, calls the WAHA client getGroupJoinInfo method, and formats the response as MCP content.
    private async handleGetGroupJoinInfo(args: any) {
      const code = args.code;
    
      if (!code) {
        throw new Error("code is required");
      }
    
      const result = await this.wahaClient.getGroupJoinInfo(code);
    
      return {
        content: [
          {
            type: "text",
            text: `Group information:\n${JSON.stringify(result, null, 2)}`,
          },
        ],
      };
    }
  • Input schema definition for the waha_get_group_join_info tool, specifying the required 'code' parameter.
      name: "waha_get_group_join_info",
      description: "Get group information from invite link without joining.",
      inputSchema: {
        type: "object",
        properties: {
          code: {
            type: "string",
            description: "Invite code or full URL",
          },
        },
        required: ["code"],
      },
    },
  • src/index.ts:1127-1128 (registration)
    Tool registration in the CallToolRequestSchema switch statement, dispatching to the specific handler.
    case "waha_set_group_messages_admin_only":
      return await this.handleSetGroupMessagesAdminOnly(args);
  • WAHA client method that makes the actual API request to retrieve group join information using the provided invite code.
    async getGroupJoinInfo(code: string): Promise<any> {
      if (!code) {
        throw new WAHAError("code is required");
      }
    
      const queryParams = { code };
      const queryString = this.buildQueryString(queryParams);
      const endpoint = `/api/${this.session}/groups/join-info${queryString}`;
    
      return this.request<any>(endpoint, {
        method: "GET",
      });
    }
Behavior3/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. It discloses the key behavioral trait of being a read-only operation that doesn't join the group, which is essential context. However, it doesn't mention potential limitations like rate limits, authentication requirements, or what specific information is returned, leaving some behavioral aspects unclear.

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, perfectly front-loaded sentence that conveys all essential information with zero waste. Every word earns its place, making it highly efficient and immediately understandable.

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

Completeness4/5

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

For a simple read operation with one parameter and no output schema, the description provides adequate context about purpose and usage. However, without annotations or output schema, it lacks details on return values and potential behavioral constraints, which could be helpful for a complete understanding.

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%, so the schema already fully documents the single parameter 'code'. The description adds no additional parameter semantics beyond what the schema provides (e.g., format examples, edge cases). With high schema coverage, the baseline score of 3 is appropriate.

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

Purpose5/5

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

The description clearly states the specific action ('Get group information') and resource ('from invite link'), and distinguishes it from siblings like 'waha_join_group' by explicitly noting 'without joining'. This provides precise differentiation from related tools.

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

Usage Guidelines5/5

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

The description explicitly states when to use this tool ('from invite link without joining'), which clearly differentiates it from alternatives like 'waha_join_group' for actually joining or 'waha_get_group_info' for getting info from already-joined groups. This provides perfect contextual guidance.

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/seejux/waha-whatsapp-mcp'

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