Free, Open Source, Self-Hosted WhatsApp API Gateway
TypeScript apibotgatewayself-hostedwhatsappwhatsapp-apiwhatsapp-automationwhatsapp-botwhatsapp-gatewaywhatsapp-gateway-apiwhatsapp-webwhatsapp-web-api
fix(mcp): reject empty identifiers on the agent tools
Yudhi Armyndharisee5ce7d50861
diff --git a/src/core/agent-tools/tools/automation.tools.ts b/src/core/agent-tools/tools/automation.tools.tsindex 057249b06..8ec519f45 100644--- a/src/core/agent-tools/tools/automation.tools.ts+++ b/src/core/agent-tools/tools/automation.tools.ts@@ -28,7 +28,7 @@ export function automationTools(automation: AutomationRulesService): AnyToolDescsessionScoped: true,inputSchema: z.object({sessionId,- ruleId: z.string().describe('Rule UUID'),+ ruleId: z.string().min(1).describe('Rule UUID'),}),handler: input =>automation.findOne(input.sessionId, input.ruleId).then(rule => AutomationRuleResponseDto.fromEntity(rule)),diff --git a/src/core/agent-tools/tools/contact.tools.ts b/src/core/agent-tools/tools/contact.tools.tsindex a4ff60972..e06d64408 100644--- a/src/core/agent-tools/tools/contact.tools.ts+++ b/src/core/agent-tools/tools/contact.tools.ts@@ -26,7 +26,7 @@ export function contactTools(contact: ContactService): AnyToolDescriptor[] {sessionScoped: true,inputSchema: z.object({sessionId,- contactId: z.string().describe('Contact JID (e.g. [email protected])'),+ contactId: z.string().min(1).describe('Contact JID (e.g. [email protected])'),}),handler: input => contact.getContactById(input.sessionId, input.contactId),}),@@ -38,7 +38,7 @@ export function contactTools(contact: ContactService): AnyToolDescriptor[] {sessionScoped: true,inputSchema: z.object({sessionId,- number: z.string().describe('Phone number to check (e.g. 628123456789, digits only)'),+ number: z.string().min(1).describe('Phone number to check (e.g. 628123456789, digits only)'),}),handler: async input => {const whatsappId = await contact.getNumberId(input.sessionId, input.number);@@ -53,7 +53,7 @@ export function contactTools(contact: ContactService): AnyToolDescriptor[] {sessionScoped: true,inputSchema: z.object({sessionId,- contactId: z.string().describe('Contact JID to resolve (e.g. an @lid)'),+ contactId: z.string().min(1).describe('Contact JID to resolve (e.g. an @lid)'),}),handler: async input => {const phone = await contact.resolveContactPhone(input.sessionId, input.contactId);@@ -67,7 +67,7 @@ export function contactTools(contact: ContactService): AnyToolDescriptor[] {sessionScoped: true,inputSchema: z.object({sessionId,- contactId: z.string().describe('Contact JID (e.g. [email protected])'),+ contactId: z.string().min(1).describe('Contact JID (e.g. [email protected])'),}),handler: async input => {const url = await contact.getProfilePicture(input.sessionId, input.contactId);@@ -82,7 +82,7 @@ export function contactTools(contact: ContactService): AnyToolDescriptor[] {sessionScoped: true,inputSchema: z.object({sessionId,- contactId: z.string().describe('Contact JID (e.g. [email protected])'),+ contactId: z.string().min(1).describe('Contact JID (e.g. [email protected])'),}),handler: async input => {await contact.blockContact(input.sessionId, input.contactId);@@ -97,7 +97,7 @@ export function contactTools(contact: ContactService): AnyToolDescriptor[] {sessionScoped: true,inputSchema: z.object({sessionId,- contactId: z.string().describe('Contact JID (e.g. [email protected])'),+ contactId: z.string().min(1).describe('Contact JID (e.g. [email protected])'),}),handler: async input => {await contact.unblockContact(input.sessionId, input.contactId);diff --git a/src/core/agent-tools/tools/group.tools.ts b/src/core/agent-tools/tools/group.tools.tsindex 03815cd24..c1f9f65ab 100644--- a/src/core/agent-tools/tools/group.tools.ts+++ b/src/core/agent-tools/tools/group.tools.ts@@ -31,7 +31,7 @@ export function groupTools(group: GroupService): AnyToolDescriptor[] {sessionScoped: true,inputSchema: z.object({sessionId,- groupId: z.string().describe('Group JID (e.g. [email protected])'),+ groupId: z.string().min(1).describe('Group JID (e.g. [email protected])'),}),handler: input => group.getGroupInfo(input.sessionId, input.groupId),}),@@ -45,7 +45,7 @@ export function groupTools(group: GroupService): AnyToolDescriptor[] {sessionScoped: true,inputSchema: z.object({sessionId,- groupId: z.string().describe('Group JID (e.g. [email protected])'),+ groupId: z.string().min(1).describe('Group JID (e.g. [email protected])'),}),handler: async input => {const inviteCode = await group.getGroupInviteCode(input.sessionId, input.groupId);@@ -78,7 +78,7 @@ export function groupTools(group: GroupService): AnyToolDescriptor[] {sessionScoped: true,inputSchema: z.object({sessionId,- groupId: z.string().describe('Group JID (e.g. [email protected])'),+ groupId: z.string().min(1).describe('Group JID (e.g. [email protected])'),participants: z.array(z.string()).min(1)@@ -110,7 +110,7 @@ export function groupTools(group: GroupService): AnyToolDescriptor[] {sessionScoped: true,inputSchema: z.object({sessionId,- groupId: z.string().describe('Group JID (e.g. [email protected])'),+ groupId: z.string().min(1).describe('Group JID (e.g. [email protected])'),subject: z.string().min(1).max(GROUP_NAME_MAX_LENGTH).describe('New group subject/name'),}),handler: async input => {@@ -127,7 +127,7 @@ export function groupTools(group: GroupService): AnyToolDescriptor[] {sessionScoped: true,inputSchema: z.object({sessionId,- groupId: z.string().describe('Group JID (e.g. [email protected])'),+ groupId: z.string().min(1).describe('Group JID (e.g. [email protected])'),description: z.string().max(GROUP_DESCRIPTION_MAX_LENGTH)diff --git a/src/core/agent-tools/tools/message.tools.ts b/src/core/agent-tools/tools/message.tools.tsindex 675923023..991b2cf85 100644--- a/src/core/agent-tools/tools/message.tools.ts+++ b/src/core/agent-tools/tools/message.tools.ts@@ -111,7 +111,7 @@ export function messageTools(message: MessageService): AnyToolDescriptor[] {sessionScoped: true,inputSchema: z.object({sessionId,- chatId: z.string().describe('Chat JID (e.g. [email protected] or [email protected])'),+ chatId: z.string().min(1).describe('Chat JID (e.g. [email protected] or [email protected])'),limit: z.number().int()@@ -132,8 +132,8 @@ export function messageTools(message: MessageService): AnyToolDescriptor[] {sessionScoped: true,inputSchema: z.object({sessionId,- chatId: z.string().describe('Chat JID containing the message'),- messageId: z.string().describe('Message ID to get reactions for'),+ chatId: z.string().min(1).describe('Chat JID containing the message'),+ messageId: z.string().min(1).describe('Message ID to get reactions for'),}),handler: input => message.getMessageReactions(input.sessionId, input.chatId, input.messageId),}),@@ -145,7 +145,7 @@ export function messageTools(message: MessageService): AnyToolDescriptor[] {sessionScoped: true,inputSchema: z.object({sessionId,- chatId: z.string().describe('Chat JID (e.g. [email protected] or [email protected])'),+ chatId: z.string().min(1).describe('Chat JID (e.g. [email protected] or [email protected])'),text: z.string().min(1).max(MESSAGE_TEXT_MAX_LENGTH).describe('Text message content'),linkPreview: z.boolean()@@ -176,7 +176,7 @@ export function messageTools(message: MessageService): AnyToolDescriptor[] {sessionScoped: true,inputSchema: z.object({sessionId,- chatId: z.string().describe('Chat JID'),+ chatId: z.string().min(1).describe('Chat JID'),url: mediaUrl('Image'),base64: z.string().optional().describe('Base64-encoded image data'),mimetype: z.string().optional().describe('MIME type (required when using base64)'),@@ -205,7 +205,7 @@ export function messageTools(message: MessageService): AnyToolDescriptor[] {sessionScoped: true,inputSchema: z.object({sessionId,- chatId: z.string().describe('Chat JID'),+ chatId: z.string().min(1).describe('Chat JID'),url: mediaUrl('Video'),base64: z.string().optional().describe('Base64-encoded video data'),mimetype: z.string().optional().describe('MIME type (required when using base64)'),@@ -234,7 +234,7 @@ export function messageTools(message: MessageService): AnyToolDescriptor[] {sessionScoped: true,inputSchema: z.object({sessionId,- chatId: z.string().describe('Chat JID'),+ chatId: z.string().min(1).describe('Chat JID'),url: mediaUrl('Audio'),base64: z.string().optional().describe('Base64-encoded audio data'),mimetype: z.string().optional().describe('MIME type (required when using base64)'),@@ -265,7 +265,7 @@ export function messageTools(message: MessageService): AnyToolDescriptor[] {sessionScoped: true,inputSchema: z.object({sessionId,- chatId: z.string().describe('Chat JID'),+ chatId: z.string().min(1).describe('Chat JID'),url: mediaUrl('Document'),base64: z.string().optional().describe('Base64-encoded document data'),mimetype: z.string().optional().describe('MIME type (required when using base64)'),@@ -294,7 +294,7 @@ export function messageTools(message: MessageService): AnyToolDescriptor[] {sessionScoped: true,inputSchema: z.object({sessionId,- chatId: z.string().describe('Chat JID'),+ chatId: z.string().min(1).describe('Chat JID'),latitude: z.number().min(-90).max(90).describe('Latitude coordinate'),longitude: z.number().min(-180).max(180).describe('Longitude coordinate'),description: z.string().max(LOCATION_TEXT_MAX_LENGTH).optional().describe('Location label/description'),@@ -319,7 +319,7 @@ export function messageTools(message: MessageService): AnyToolDescriptor[] {sessionScoped: true,inputSchema: z.object({sessionId,- chatId: z.string().describe('Chat JID'),+ chatId: z.string().min(1).describe('Chat JID'),contactName: z.string().min(1).max(CONTACT_NAME_MAX_LENGTH).describe('Display name of the contact to share'),contactNumber: z.string()@@ -344,7 +344,7 @@ export function messageTools(message: MessageService): AnyToolDescriptor[] {sessionScoped: true,inputSchema: z.object({sessionId,- chatId: z.string().describe('Chat JID'),+ chatId: z.string().min(1).describe('Chat JID'),url: mediaUrl('Sticker'),base64: z.string().optional().describe('Base64-encoded sticker data'),mimetype: z.string().optional().describe('MIME type (required when using base64)'),@@ -374,7 +374,7 @@ export function messageTools(message: MessageService): AnyToolDescriptor[] {sessionScoped: true,inputSchema: z.object({sessionId,- chatId: z.string().describe('Chat JID'),+ chatId: z.string().min(1).describe('Chat JID'),templateId: z.string().optional().describe('Template UUID'),templateName: z.string().optional().describe('Template name slug'),vars: z@@ -400,8 +400,8 @@ export function messageTools(message: MessageService): AnyToolDescriptor[] {sessionScoped: true,inputSchema: z.object({sessionId,- chatId: z.string().describe('Chat JID'),- quotedMessageId: z.string().describe('ID of the message to quote/reply to'),+ chatId: z.string().min(1).describe('Chat JID'),+ quotedMessageId: z.string().min(1).describe('ID of the message to quote/reply to'),text: z.string().min(1).max(MESSAGE_TEXT_MAX_LENGTH).describe('Reply text content'),mentions: mentionsSchema,}),@@ -421,9 +421,9 @@ export function messageTools(message: MessageService): AnyToolDescriptor[] {sessionScoped: true,inputSchema: z.object({sessionId,- fromChatId: z.string().describe('Source chat JID'),- toChatId: z.string().describe('Destination chat JID'),- messageId: z.string().describe('ID of the message to forward'),+ fromChatId: z.string().min(1).describe('Source chat JID'),+ toChatId: z.string().min(1).describe('Destination chat JID'),+ messageId: z.string().min(1).describe('ID of the message to forward'),}),handler: input =>message.forward(input.sessionId, {@@ -441,8 +441,8 @@ export function messageTools(message: MessageService): AnyToolDescriptor[] {sessionScoped: true,inputSchema: z.object({sessionId,- chatId: z.string().describe('Chat JID containing the message'),- messageId: z.string().describe('ID of the message to react to'),+ chatId: z.string().min(1).describe('Chat JID containing the message'),+ messageId: z.string().min(1).describe('ID of the message to react to'),emoji: z.string().max(REACTION_EMOJI_MAX_LENGTH)diff --git a/src/core/agent-tools/tools/session.tools.ts b/src/core/agent-tools/tools/session.tools.tsindex 909203b19..31f898ea2 100644--- a/src/core/agent-tools/tools/session.tools.ts+++ b/src/core/agent-tools/tools/session.tools.ts@@ -68,7 +68,7 @@ export function sessionTools(session: SessionService): AnyToolDescriptor[] {sessionScoped: true,inputSchema: z.object({sessionId,- chatId: z.string().describe('Chat JID (e.g. [email protected])'),+ chatId: z.string().min(1).describe('Chat JID (e.g. [email protected])'),}),handler: input => session.subscribeToPresence(input.sessionId, input.chatId).then(() => ({ success: true })),}),@@ -82,7 +82,7 @@ export function sessionTools(session: SessionService): AnyToolDescriptor[] {sessionScoped: true,inputSchema: z.object({sessionId,- chatId: z.string().describe('Chat JID (e.g. [email protected])'),+ chatId: z.string().min(1).describe('Chat JID (e.g. [email protected])'),}),handler: input => session.getPresence(input.sessionId, input.chatId),}),@@ -94,7 +94,7 @@ export function sessionTools(session: SessionService): AnyToolDescriptor[] {sessionScoped: true,inputSchema: z.object({sessionId,- chatId: z.string().describe('Chat JID (e.g. [email protected])'),+ chatId: z.string().min(1).describe('Chat JID (e.g. [email protected])'),messageIds: z// The element rule comes from the DTO rather than being restated here: the REST body// rejects a whitespace-only id, and this path reaches the engine without the DTO at all.@@ -118,7 +118,7 @@ export function sessionTools(session: SessionService): AnyToolDescriptor[] {sessionScoped: true,inputSchema: z.object({sessionId,- chatId: z.string().describe('Chat JID (e.g. [email protected])'),+ chatId: z.string().min(1).describe('Chat JID (e.g. [email protected])'),}),handler: input => session.markUnread(input.sessionId, input.chatId).then(success => ({ success })),}),@@ -130,7 +130,7 @@ export function sessionTools(session: SessionService): AnyToolDescriptor[] {sessionScoped: true,inputSchema: z.object({sessionId,- chatId: z.string().describe('Chat JID (e.g. [email protected])'),+ chatId: z.string().min(1).describe('Chat JID (e.g. [email protected])'),state: z.enum(['typing', 'recording', 'paused']).describe("'typing' or 'recording' shows the indicator; 'paused' clears it"),diff --git a/src/core/agent-tools/tools/tool-input-caps.spec.ts b/src/core/agent-tools/tools/tool-input-caps.spec.tsindex 7dcddc4c5..8a82bf079 100644--- a/src/core/agent-tools/tools/tool-input-caps.spec.ts+++ b/src/core/agent-tools/tools/tool-input-caps.spec.ts@@ -26,7 +26,9 @@ import {GroupSubjectDto,ParticipantsDto,} from '../../../modules/group/dto/group.dto';+import { z } from 'zod';import type { AnyToolDescriptor } from '../tool-descriptor';+import { allAgentTools } from '.';import { messageTools } from './message.tools';import { groupTools } from './group.tools';@@ -214,3 +216,27 @@ describe('agent-tool input caps (parity with the REST DTOs)', () => {expect(await dtoFieldErrors(c, overCap)).toBe(true);});});++/**+ * Every identifier a tool requires must be non-empty, as REST requires it (IsNotEmpty on a body+ * field, or a path segment that cannot be empty). The tool path calls the service directly, so an+ * empty chatId would otherwise persist a row, reach the engine and fail there as a server error.+ * Walks the whole registry so a tool added later is covered without editing this list.+ */+describe('agent-tool identifiers reject an empty string', () => {+ const idFields = allAgentTools({} as never).flatMap(t =>+ Object.entries((t.inputSchema as unknown as z.ZodObject<Record<string, z.ZodType>>).shape)+ .filter(([key, schema]) => /Id$|^number$/.test(key) && !schema.safeParse(undefined).success)+ .map(([key, schema]) => [`${t.name}.${key}`, schema] as const),+ );++ it('finds the identifier fields to check', () => {+ expect(idFields.map(([label]) => label)).toEqual(+ expect.arrayContaining(['MessageSendText.chatId', 'MessageReply.quotedMessageId', 'MessageForward.toChatId']),+ );+ });++ it.each(idFields)('%s rejects an empty string', (_label, schema) => {+ expect(schema.safeParse('').success).toBe(false);+ });+});diff --git a/src/core/agent-tools/tools/webhook.tools.ts b/src/core/agent-tools/tools/webhook.tools.tsindex a31aa0c34..a4b7bfbd1 100644--- a/src/core/agent-tools/tools/webhook.tools.ts+++ b/src/core/agent-tools/tools/webhook.tools.ts@@ -40,7 +40,7 @@ export function webhookTools(webhook: WebhookService): AnyToolDescriptor[] {sessionScoped: true,inputSchema: z.object({sessionId,- webhookId: z.string().describe('Webhook UUID'),+ webhookId: z.string().min(1).describe('Webhook UUID'),}),handler: input => webhook.findOne(input.sessionId, input.webhookId).then(w => WebhookResponseDto.fromEntity(w)),}),