Skip to main content
Glama
ExoCubeYT

OpenWA MCP Server

by ExoCubeYT

start_session

Reactivate a stopped WhatsApp session to restore its active status and enable messaging operations.

Instructions

Start a stopped WhatsApp session to make it active

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
sessionIdYesID of the session to start

Implementation Reference

  • Registration and handler for the 'start_session' tool. Calls POST /sessions/{sessionId}/start via openwaClient to start a stopped WhatsApp session.
    server.registerTool(
      "start_session",
      {
        description: "Start a stopped WhatsApp session to make it active",
        inputSchema: {
          sessionId: z.string().describe("ID of the session to start"),
        },
      },
      async ({ sessionId }) => {
        const data = await openwaClient({ method: "POST", path: `/sessions/${sessionId}/start` });
        return { content: [{ type: "text" as const, text: JSON.stringify(data, null, 2) }] };
      }
    );
  • Input schema for start_session: requires a 'sessionId' string describing the ID of the session to start.
    {
      description: "Start a stopped WhatsApp session to make it active",
      inputSchema: {
        sessionId: z.string().describe("ID of the session to start"),
      },
  • src/index.ts:15-15 (registration)
    Registration call: registerSessionTools(server) registers all session tools including 'start_session' on the MCP server.
    registerSessionTools(server);
  • Helper function openwaClient used by the handler to make HTTP requests to the OpenWA 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 {
Behavior2/5

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

No annotations are present, so the description carries full burden. It states the core action but omits details like what happens if the session is already active, if it doesn't exist, or any preconditions (e.g., QR scan required).

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?

Single sentence, no wasted words, appropriately sized for a simple tool.

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 (1 param, no output schema), the description is minimally adequate but lacks context about session state management and potential failures.

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 covers 100% of parameters with a description for sessionId; the tool description adds no extra meaning, but schema already provides adequate information.

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?

Description clearly specifies the action ('Start') and the resource ('stopped WhatsApp session'), distinguishing it from sibling tools like create_session or stop_session.

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

Usage Guidelines3/5

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

The description implies usage for stopped sessions, but no explicit guidance on when to use this vs. other session-related tools (e.g., create_session, get_session_status) is provided.

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