groundmail-mcp 0.8.0 → 0.9.0

package/dist/index.js

@@ -150,6 +150,9 @@ var emailItem = object(
       heldBackItem(),
       "Recipients Groundmail validation held back before sending, with why; empty when none were"
     ),
+    test: boolean(
+      "True when the email never reached the mail server: sent with a test key (gm_test_\u2026) or only to simulator addresses. Its status and events are simulated"
+    ),
     tags: { description: "Tags attached to the email" },
     scheduled_at: nullableString("When the email is scheduled to send (ISO 8601)"),
     cancelled_at: nullableString("When the scheduled email was cancelled (ISO 8601)"),
@@ -267,7 +270,8 @@ var sendEmailOutput = object(
     held_back: arrayOf(
       heldBackItem(),
       "Present when Groundmail validation held some recipients back; the email went to the rest"
-    )
+    ),
+    test: boolean("Present and true on a test send (test key or simulator addresses): nothing was delivered")
   },
   ["id", "status"]
 );
@@ -500,7 +504,8 @@ async function callMcpTool(client, name, args) {
       case "list_emails": {
         const result = await client.emails.list({
           limit: optNumber(args, "limit"),
-          cursor: optString(args, "cursor")
+          cursor: optString(args, "cursor"),
+          ...typeof args.test === "boolean" ? { test: args.test } : {}
         });
         return textResult(result);
       }
@@ -743,12 +748,15 @@ var readOnly = (title) => ({
 var MCP_TOOLS = [
   {
     name: "send_email",
-    description: "Send a transactional email via Groundmail. Provide subject + html/text, or a published template_id / template_alias with optional variables.",
+    description: "Send a transactional email via Groundmail. Provide subject + html/text, or a published template_id / template_alias with optional variables. To test without delivering anything, send to a simulator address: delivered@, bounce@, block@, complaint@, suppressed@ or delayed@simulator.groundmail.dev (plus addressing like bounce+test1@ works); the result has test: true and webhooks fire as for real mail.",
     inputSchema: {
       type: "object",
       properties: {
         from: { type: "string", description: "Sender address (must match a verified domain or sandbox sender)" },
-        to: { type: "string", description: "Recipient email address" },
+        to: {
+          type: "string",
+          description: "Recipient email address. A \u2026@simulator.groundmail.dev address simulates an outcome and never delivers"
+        },
         subject: { type: "string", description: "Subject line. Optional when using a published template" },
         html: { type: "string", description: "HTML body. Do not combine with template_id or template_alias" },
         text: { type: "string", description: "Plain-text body. Do not combine with template_id or template_alias" },
@@ -774,10 +782,13 @@ var MCP_TOOLS = [
   },
   {
     name: "list_emails",
-    description: "List recent emails sent from this account.",
+    description: "List recent emails sent from this account. Test emails (test keys, simulator addresses) have test: true.",
     inputSchema: {
       type: "object",
-      properties: { ...paginationProps }
+      properties: {
+        ...paginationProps,
+        test: { type: "boolean", description: "true: only test emails; false: only live ones. Omit for both" }
+      }
     },
     outputSchema: pagedOutput("emails", emailItem, "Emails on this page, newest first"),
     annotations: readOnly("List emails")

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "groundmail-mcp",
-  "version": "0.8.0",
+  "version": "0.9.0",
   "mcpName": "io.github.Groundmail/groundmail",
   "description": "Groundmail MCP server: send transactional email, manage domains, templates, webhooks and suppressions from Claude, Cursor, ChatGPT and other MCP clients",
   "license": "MIT",
@@ -41,7 +41,7 @@
   },
   "dependencies": {
     "@modelcontextprotocol/sdk": "^1.30.0",
-    "groundmail": "0.16.0"
+    "groundmail": "0.17.0"
   },
   "devDependencies": {
     "tsup": "^8.5.0",