neuron-mcp-server 1.0.0 → 1.1.0

package/src/tools/whatsapp-actions.ts

@@ -0,0 +1,203 @@
+import { z } from "zod";
+import type { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
+import { api, jsonResult, errorResult } from "../client.js";
+
+export function registerWhatsAppActionTools(server: McpServer): void {
+  // 1. Send Reaction
+  server.registerTool(
+    "neuron_send_reaction",
+    {
+      title: "Send Reaction",
+      description: "Send or remove an emoji reaction on a WhatsApp message. Pass an empty emoji string to remove a reaction.",
+      inputSchema: z.object({
+        channelId: z.string().describe("WhatsApp channel identifier (UUID)"),
+        to: z.string().describe("Chat JID (e.g. '2348012345678@s.whatsapp.net' or group JID)"),
+        messageId: z.string().describe("WhatsApp message ID to react to"),
+        emoji: z.string().describe("Emoji character (e.g. '👍', '❤️'), or empty string to remove reaction"),
+      }),
+      annotations: { readOnlyHint: false, destructiveHint: false, idempotentHint: true, openWorldHint: false },
+    },
+    async (args) => {
+      try {
+        const res = await api("POST", `/whatsapp-actions/${args.channelId}/react`, {
+          to: args.to, messageId: args.messageId, emoji: args.emoji,
+        });
+        return jsonResult(res);
+      } catch (error) { return errorResult(error); }
+    },
+  );
+
+  // 2. Send Sticker
+  server.registerTool(
+    "neuron_send_sticker",
+    {
+      title: "Send Sticker",
+      description:
+        "Send a sticker via WhatsApp. The easy way: pass `sticker` as a mood or label (e.g. 'laughing', 'thumbs up', 'fire', 'celebrate') and a matching sticker is found automatically from the platform-wide community sticker library (falling back to this org's own stickers). Advanced: pass `stickerUrl` with a direct public WebP image URL instead. Provide one of the two. Only supported on Baileys channels.",
+      inputSchema: z.object({
+        channelId: z.string().describe("WhatsApp channel identifier (UUID)"),
+        to: z.string().describe("Recipient JID or phone number"),
+        sticker: z
+          .string()
+          .optional()
+          .describe("Mood or label to auto-match a sticker (e.g. 'laughing', 'fire', 'celebrate'). Preferred over stickerUrl."),
+        stickerUrl: z
+          .string()
+          .optional()
+          .describe("Advanced: direct URL to a public WebP sticker image. Use only if no mood/label fits."),
+      }),
+      annotations: { readOnlyHint: false, destructiveHint: false, idempotentHint: false, openWorldHint: false },
+    },
+    async (args) => {
+      try {
+        const res = await api("POST", `/whatsapp-actions/${args.channelId}/send-sticker`, {
+          to: args.to, sticker: args.sticker, stickerUrl: args.stickerUrl,
+        });
+        return jsonResult(res);
+      } catch (error) { return errorResult(error); }
+    },
+  );
+
+  // 3. Send Location
+  server.registerTool(
+    "neuron_send_location",
+    {
+      title: "Send Location",
+      description: "Send a location pin via WhatsApp with coordinates and optional name/address.",
+      inputSchema: z.object({
+        channelId: z.string().describe("WhatsApp channel identifier (UUID)"),
+        to: z.string().describe("Recipient JID or phone number"),
+        latitude: z.number().describe("Latitude in decimal degrees"),
+        longitude: z.number().describe("Longitude in decimal degrees"),
+        name: z.string().optional().describe("Location name (e.g. 'Eko Hotel')"),
+        address: z.string().optional().describe("Street address"),
+      }),
+      annotations: { readOnlyHint: false, destructiveHint: false, idempotentHint: false, openWorldHint: false },
+    },
+    async (args) => {
+      try {
+        const res = await api("POST", `/whatsapp-actions/${args.channelId}/send-location`, {
+          to: args.to, latitude: args.latitude, longitude: args.longitude,
+          name: args.name, address: args.address,
+        });
+        return jsonResult(res);
+      } catch (error) { return errorResult(error); }
+    },
+  );
+
+  // 4. Send Contact Card
+  server.registerTool(
+    "neuron_send_contact_card",
+    {
+      title: "Send Contact Card",
+      description: "Send a vCard contact card via WhatsApp with name, phone, and optional organization.",
+      inputSchema: z.object({
+        channelId: z.string().describe("WhatsApp channel identifier (UUID)"),
+        to: z.string().describe("Recipient JID or phone number"),
+        contactName: z.string().describe("Full name of the contact to share"),
+        contactPhone: z.string().describe("Phone number in international format (e.g. '+2348012345678')"),
+        contactOrg: z.string().optional().describe("Organization or company name"),
+      }),
+      annotations: { readOnlyHint: false, destructiveHint: false, idempotentHint: false, openWorldHint: false },
+    },
+    async (args) => {
+      try {
+        const res = await api("POST", `/whatsapp-actions/${args.channelId}/send-contact`, {
+          to: args.to, contactName: args.contactName,
+          contactPhone: args.contactPhone, contactOrg: args.contactOrg,
+        });
+        return jsonResult(res);
+      } catch (error) { return errorResult(error); }
+    },
+  );
+
+  // 5. Forward Message
+  server.registerTool(
+    "neuron_forward_message",
+    {
+      title: "Forward Message",
+      description: "Forward a WhatsApp message from one chat to another. Uses copy-send approach — the message content is re-sent to the destination.",
+      inputSchema: z.object({
+        channelId: z.string().describe("WhatsApp channel identifier (UUID)"),
+        messageId: z.string().describe("WhatsApp message ID to forward"),
+        from: z.string().describe("Source chat JID"),
+        to: z.string().describe("Destination chat JID"),
+      }),
+      annotations: { readOnlyHint: false, destructiveHint: false, idempotentHint: false, openWorldHint: false },
+    },
+    async (args) => {
+      try {
+        const res = await api("POST", `/whatsapp-actions/${args.channelId}/forward`, {
+          messageId: args.messageId, from: args.from, to: args.to,
+        });
+        return jsonResult(res);
+      } catch (error) { return errorResult(error); }
+    },
+  );
+
+  // 6. Mark as Read
+  server.registerTool(
+    "neuron_mark_as_read",
+    {
+      title: "Mark as Read",
+      description: "Mark a WhatsApp message as read, sending read receipts to the sender.",
+      inputSchema: z.object({
+        channelId: z.string().describe("WhatsApp channel identifier (UUID)"),
+        chatJid: z.string().describe("Chat JID the message belongs to"),
+        messageId: z.string().describe("WhatsApp message ID to mark as read"),
+      }),
+      annotations: { readOnlyHint: false, destructiveHint: false, idempotentHint: true, openWorldHint: false },
+    },
+    async (args) => {
+      try {
+        const res = await api("POST", `/whatsapp-actions/${args.channelId}/mark-read`, {
+          messageId: args.messageId, chatJid: args.chatJid,
+        });
+        return jsonResult(res);
+      } catch (error) { return errorResult(error); }
+    },
+  );
+
+  // 7. Set Presence
+  server.registerTool(
+    "neuron_set_presence",
+    {
+      title: "Set Presence",
+      description: "Set typing indicator or online/offline presence on a WhatsApp chat. Only supported on Baileys channels.",
+      inputSchema: z.object({
+        channelId: z.string().describe("WhatsApp channel identifier (UUID)"),
+        to: z.string().describe("Chat JID to set presence for"),
+        type: z.enum(["composing", "paused", "available", "unavailable"]).describe("Presence type"),
+      }),
+      annotations: { readOnlyHint: false, destructiveHint: false, idempotentHint: true, openWorldHint: false },
+    },
+    async (args) => {
+      try {
+        const res = await api("POST", `/whatsapp-actions/${args.channelId}/presence`, {
+          to: args.to, type: args.type,
+        });
+        return jsonResult(res);
+      } catch (error) { return errorResult(error); }
+    },
+  );
+
+  // 8. Get Group Invite Link
+  server.registerTool(
+    "neuron_get_group_invite_link",
+    {
+      title: "Get Group Invite Link",
+      description: "Get the invite link for a WhatsApp group. Only supported on Baileys channels where the bot is a group admin.",
+      inputSchema: z.object({
+        channelId: z.string().describe("WhatsApp channel identifier (UUID)"),
+        groupJid: z.string().describe("Group JID (ending in @g.us)"),
+      }),
+      annotations: { readOnlyHint: true, destructiveHint: false, idempotentHint: true, openWorldHint: false },
+    },
+    async (args) => {
+      try {
+        const res = await api("GET", `/whatsapp-actions/${args.channelId}/groups/${args.groupJid}/invite-link`);
+        return jsonResult(res);
+      } catch (error) { return errorResult(error); }
+    },
+  );
+}

package/tsconfig.json

@@ -0,0 +1,20 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "Node16",
+    "moduleResolution": "Node16",
+    "lib": ["ES2022"],
+    "types": ["node"],
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "declaration": true,
+    "sourceMap": true,
+    "allowSyntheticDefaultImports": true
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist"]
+}

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2026 Neuron (https://neuron.ng)
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.