Get Settings
get_settingsRetrieve the current settings for your pinned WhatsApp instance.
Instructions
Get the current settings of the pinned WhatsApp instance.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Implementation Reference
- src/tools/get-settings.ts:5-23 (handler)The registerGetSettings function registers the 'get_settings' tool on the MCP server. It calls the Evolution API GET /settings/find/:instanceName and returns the response as JSON.
export function registerGetSettings(server: McpServer, client: EvolutionClient): void { server.registerTool( "get_settings", { title: "Get Settings", description: "Get the current settings of the pinned WhatsApp instance.", inputSchema: {}, }, async () => { try { const data = await client.get(`/settings/find/${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/get-settings.ts:8-11 (schema)Input schema for the 'get_settings' tool: an empty object (no parameters), with title 'Get Settings' and description 'Get the current settings of the pinned WhatsApp instance.'
{ title: "Get Settings", description: "Get the current settings of the pinned WhatsApp instance.", inputSchema: {}, - src/tools/index.ts:134-134 (registration)Registration call: registerGetSettings(server, client) invoked in the tools index.
registerGetSettings(server, client); - src/tools/index.ts:61-61 (registration)Import statement for registerGetSettings from './get-settings.js'.
import { registerGetSettings } from "./get-settings.js";