Logout Instance
logout_instanceDisconnects the pinned WhatsApp instance and clears its session, requiring a QR scan to reconnect.
Instructions
Logout the pinned WhatsApp instance (disconnects and clears session — requires QR scan to reconnect).
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Implementation Reference
- src/tools/logout-instance.ts:5-23 (handler)Registration function for the logout_instance tool. Makes a DELETE request to /instance/logout/{instanceName} to disconnect and clear the WhatsApp session.
export function registerLogoutInstance(server: McpServer, client: EvolutionClient): void { server.registerTool( "logout_instance", { title: "Logout Instance", description: "Logout the pinned WhatsApp instance (disconnects and clears session — requires QR scan to reconnect).", inputSchema: {}, }, async () => { try { const data = await client.delete(`/instance/logout/${client.instanceName}`); return { content: [{ type: "text" as const, text: JSON.stringify(data, null, 2) }] }; } catch (e) { if (e instanceof McpError) return { isError: true, content: [{ type: "text" as const, text: e.message }] }; throw e; } } ); } - src/tools/logout-instance.ts:11-11 (schema)The input schema for logout_instance is an empty object (no parameters needed).
inputSchema: {}, - src/tools/index.ts:133-133 (registration)Registration call for logout_instance within the tool registration chain.
registerLogoutInstance(server, client); - src/tools/index.ts:60-60 (registration)Import of the registerLogoutInstance function from the logout-instance module.
import { registerLogoutInstance } from "./logout-instance.js";