Update Group Setting
update_group_settingUpdate WhatsApp group announcement and lock settings. Choose announcement mode for admin-only messaging or lock group info editing.
Instructions
Update group settings (announcement mode, locked) via the pinned instance.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| groupJid | Yes | Group JID (e.g. 120363000000000000@g.us) | |
| action | Yes | announcement: only admins can send; not_announcement: all can send; locked/unlocked: group info edit |
Implementation Reference
- src/tools/update-group-setting.ts:12-33 (handler)The handler function that registers and implements the 'update_group_setting' tool. It makes a POST request to /group/updateSetting/{instanceName} with groupJid and action parameters.
export function registerUpdateGroupSetting(server: McpServer, client: EvolutionClient): void { server.registerTool( "update_group_setting", { title: "Update Group Setting", description: "Update group settings (announcement mode, locked) via the pinned instance.", inputSchema: schema, }, async (args) => { try { const data = await client.post( `/group/updateSetting/${client.instanceName}?groupJid=${encodeURIComponent(args.groupJid)}`, { action: args.action } ); 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; } } ); } - Input schema for the tool: requires groupJid (string) and action (enum: announcement, not_announcement, locked, unlocked).
const schema = { groupJid: z.string().min(1).describe("Group JID (e.g. 120363000000000000@g.us)"), action: z.enum(["announcement", "not_announcement", "locked", "unlocked"]) .describe("announcement: only admins can send; not_announcement: all can send; locked/unlocked: group info edit"), }; - src/tools/index.ts:53-53 (registration)Import of the registerUpdateGroupSetting function from the update-group-setting module.
import { registerUpdateGroupSetting } from "./update-group-setting.js"; - src/tools/index.ts:126-126 (registration)Registration call that registers the tool with the MCP server and Evolution client.
registerUpdateGroupSetting(server, client);