whatsapp_get_instance_settings
Retrieve current WhatsApp instance configuration and settings to manage account parameters and operational preferences.
Instructions
Get current instance settings.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Input Schema (JSON Schema)
{
"properties": {},
"type": "object"
}
Implementation Reference
- src/tools/instance.ts:8-17 (handler)The handler function that implements the core logic of the whatsapp_get_instance_settings tool by calling the WSAPI endpoint to retrieve instance settings.export const getInstanceSettings: ToolHandler = { name: 'whatsapp_get_instance_settings', description: 'Get current instance settings.', inputSchema: { type: 'object', properties: {} }, handler: async () => { logger.info('Getting instance settings'); const result = await wsapiClient.get('/instance/settings'); return { success: true, settings: result, message: 'Instance settings retrieved successfully' }; }, };
- src/server.ts:57-76 (registration)Code that registers all tools from instanceTools (among others) into the server's tool map by name, making whatsapp_get_instance_settings available for execution.const toolCategories = [ messagingTools, contactTools, groupTools, chatTools, sessionTools, instanceTools, accountTools, ]; toolCategories.forEach(category => { Object.values(category).forEach(tool => { if (this.tools.has(tool.name)) { logger.warn(`Tool ${tool.name} already registered, skipping`); return; } this.tools.set(tool.name, tool); logger.debug(`Registered tool: ${tool.name}`); }); });
- src/server.ts:20-20 (registration)Import of instanceTools which provides the whatsapp_get_instance_settings handler.import { instanceTools } from './tools/instance.js';
- src/tools/instance.ts:11-11 (schema)Input schema definition for the tool (no input parameters required).inputSchema: { type: 'object', properties: {} },