Skip to main content
Glama
ExoCubeYT

OpenWA MCP Server

by ExoCubeYT

get_messages

Retrieve message history from a WhatsApp chat by providing session ID and chat ID.

Instructions

Retrieve message history from a specific WhatsApp chat

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
sessionIdYesSession ID
chatIdYesChat ID to fetch messages from

Implementation Reference

  • Handler function for get_messages tool. Sends a GET request to the OpenWA API to retrieve message history from a specific WhatsApp chat.
      async ({ sessionId, chatId }) => {
        const data = await openwaClient({
          method: "GET",
          path: `/sessions/${sessionId}/chats/${chatId}/messages`,
        });
        return { content: [{ type: "text" as const, text: JSON.stringify(data, null, 2) }] };
      }
    );
  • Schema definition for get_messages tool: expects sessionId (string) and chatId (string).
    {
      description: "Retrieve message history from a specific WhatsApp chat",
      inputSchema: {
        sessionId: z.string().describe("Session ID"),
        chatId: z.string().describe("Chat ID to fetch messages from"),
      },
  • Registration of the get_messages tool via server.registerTool() inside registerMessageTools().
    server.registerTool(
      "get_messages",
      {
        description: "Retrieve message history from a specific WhatsApp chat",
        inputSchema: {
          sessionId: z.string().describe("Session ID"),
          chatId: z.string().describe("Chat ID to fetch messages from"),
        },
      },
      async ({ sessionId, chatId }) => {
        const data = await openwaClient({
          method: "GET",
          path: `/sessions/${sessionId}/chats/${chatId}/messages`,
        });
        return { content: [{ type: "text" as const, text: JSON.stringify(data, null, 2) }] };
      }
    );
  • Helper function openwaClient used by get_messages handler to make HTTP requests to the OpenWA backend API.
    export async function openwaClient<T = unknown>(opts: RequestOptions): Promise<T> {
      const url = `${BASE_URL}${opts.path}`;
    
      const headers: Record<string, string> = {
        "Content-Type": "application/json",
        "X-API-Key": API_KEY,
      };
    
      const res = await fetch(url, {
        method: opts.method,
        headers,
        body: opts.body ? JSON.stringify(opts.body) : undefined,
      });
    
      const text = await res.text();
    
      if (!res.ok) {
        throw new Error(`OpenWA API ${res.status}: ${text}`);
      }
    
      try {
        return JSON.parse(text) as T;
      } catch {
        return text as T;
      }
    }
Behavior2/5

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

No annotations are present, and the description only states 'retrieve message history' without disclosing behavioral traits such as pagination, authentication requirements, rate limits, or data format (e.g., whether images are included).

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 concise sentence that immediately conveys the tool's purpose without extraneous information. Every word earns its place.

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

Completeness3/5

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

Given the simplicity of the tool (two required string params, no output schema), the description is minimally adequate but could benefit from specifying the format of returned messages or that it retrieves all messages in order.

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 coverage is 100%, so the schema already documents both parameters. The description adds no extra meaning beyond what is in the schema, which is acceptable but does not compensate for any gaps.

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 action 'retrieve', the resource 'message history', and the context 'WhatsApp chat', distinguishing it from sibling tools like send_text or delete_message.

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 (e.g., search_messages or get_media). The description does not mention prerequisites or limitations.

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/ExoCubeYT/openwa-mcp'

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