instance_status
Check the connection status of a WhatsApp Business instance to monitor its availability and ensure reliable messaging operations.
Instructions
Get connection status of an instance
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| instanceName | Yes | Instance name |
Implementation Reference
- src/index.ts:608-618 (handler)MCP tool handler for 'instance_status' that fetches the instance connection status from EvolutionAPI and returns it as JSON text content.
private async handleInstanceStatus(args: any) { const status = await evolutionAPI.getConnectionStatus(args.instanceName); return { content: [ { type: 'text', text: JSON.stringify(status, null, 2) } ] }; } - src/index.ts:492-493 (registration)Switch case that registers and dispatches calls to the 'instance_status' tool handler.
case 'instance_status': return await this.handleInstanceStatus(args); - src/index.ts:76-85 (schema)Registration in tools list with input schema requiring 'instanceName' string.
name: 'instance_status', description: 'Get connection status of an instance', inputSchema: { type: 'object', properties: { instanceName: { type: 'string', description: 'Instance name' } }, required: ['instanceName'] } }, - src/services/evolution-api.ts:64-70 (helper)Core helper function that makes HTTP GET request to Evolution API endpoint /instance/connectionState/{instanceName} to retrieve status.
async getConnectionStatus(instanceName: string): Promise<{ instance: string; state: string; }> { const response = await this.client.get(`/instance/connectionState/${instanceName}`); return response.data; }