Skip to main content
Glama

waha_get_group_info

Retrieve detailed information about a specific WhatsApp group using its group ID to access member lists, settings, and metadata for chat management.

Instructions

Get detailed information about a specific group.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
groupIdYesGroup ID (format: number@g.us)

Implementation Reference

  • The primary handler for the 'waha_get_group_info' MCP tool. Extracts 'groupId' from input arguments, validates it, calls the WAHAClient's getGroupInfo method, and returns the group information formatted as a JSON string in a text content block.
     * Handle waha_get_group_info tool
     */
    private async handleGetGroupInfo(args: any) {
      const groupId = args.groupId;
    
      if (!groupId) {
        throw new Error("groupId is required");
      }
    
      const groupInfo = await this.wahaClient.getGroupInfo(groupId);
    
      return {
        content: [
          {
            type: "text",
            text: `Group information for ${groupId}:\n${JSON.stringify(groupInfo, null, 2)}`,
          },
        ],
  • The input schema and metadata definition for the 'waha_get_group_info' tool, registered in the ListTools response. Specifies that 'groupId' is a required string parameter.
      name: "waha_get_group_info",
      description: "Get detailed information about a specific group.",
      inputSchema: {
        type: "object",
        properties: {
          groupId: {
            type: "string",
            description: "Group ID (format: number@g.us)",
          },
        },
        required: ["groupId"],
      },
    },
  • src/index.ts:1093-1094 (registration)
    Registration of the tool handler in the CallToolRequestSchema switch statement, dispatching calls to 'waha_get_group_info' to the handleGetGroupInfo method.
    case "waha_get_group_info":
      return await this.handleGetGroupInfo(args);
  • Underlying helper method in WAHAClient class that makes the HTTP GET request to retrieve group information from the WAHA API endpoint `/api/{session}/groups/{groupId}`.
    async getGroupInfo(groupId: string): Promise<any> {
      if (!groupId) {
        throw new WAHAError("groupId is required");
      }
    
      const endpoint = `/api/${this.session}/groups/${encodeURIComponent(groupId)}`;
    
      return this.request<any>(endpoint, {
        method: "GET",
      });
    }
Behavior2/5

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

With no annotations provided, the description carries full burden but only states it 'gets' information without disclosing behavioral traits like read-only nature, potential rate limits, authentication needs, or what 'detailed information' entails. It's minimal and leaves critical aspects unspecified.

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 front-loads the core action ('Get detailed information'). There's no wasted verbiage, making it appropriately sized for its purpose.

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 no annotations, no output schema, and a simple parameter, the description is incomplete. It doesn't explain what 'detailed information' includes, potential errors, or behavioral constraints, leaving gaps for a tool that likely returns structured data about groups.

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 documents the 'groupId' parameter with its format. The description adds no additional meaning beyond implying it's for a 'specific group', which aligns with the schema but doesn't provide extra context like examples or usage notes.

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 verb ('Get') and resource ('detailed information about a specific group'), making the purpose understandable. It distinguishes from siblings like 'waha_get_groups' (which lists groups) by focusing on a single group, though it doesn't explicitly name this distinction.

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?

No guidance is provided on when to use this tool versus alternatives like 'waha_get_groups' or 'waha_get_group_participants'. The description implies usage for a specific group but lacks explicit context, prerequisites, or exclusions.

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