Integrate template tools

README.md

@@ -50,7 +50,8 @@ If you are using `asdf` for managing Node.js you must use absolute path to execu
         "ASDF_DATA_DIR": "/Users/<username>/.asdf",
         "ASDF_NODEJS_VERSION": "20.6.1",
         "MAILTRAP_API_TOKEN": "your_mailtrap_api_token",
-        "DEFAULT_FROM_EMAIL": "your_sender@example.com"
+        "DEFAULT_FROM_EMAIL": "your_sender@example.com",
+        "MAILTRAP_ACCOUNT_ID": "your_account_id"
       }
     }
   }
@@ -102,11 +103,20 @@ Then, in the settings file, add the following configuration:
 
 ## Usage
 
-Once configured, you can ask agent to send emails, for example:
+Once configured, you can ask agent to send emails and manage templates, for example:
+
+**Email Operations:**
 
 - "Send an email to john.doe@example.com with the subject 'Meeting Tomorrow' and a friendly reminder about our upcoming meeting."
 - "Email sarah@example.com about the project update, and CC the team at team@example.com"
 
+**Template Operations:**
+
+- "List all email templates in my Mailtrap account"
+- "Create a new email template called 'Welcome Email' with subject 'Welcome to our platform!'"
+- "Update the template with ID 12345 to change the subject to 'Updated Welcome Message'"
+- "Delete the template with ID 67890"
+
 ## Available Tools
 
 ### send-email
@@ -118,12 +128,56 @@ Sends a transactional email through Mailtrap.
 - `to` (required): Email address of the recipient
 - `subject` (required): Email subject line
 - `from` (optional): Email address of the sender, if not provided "DEFAULT_FROM_EMAIL" will be used
-- `text` (optional): Email body text, require if "html" is empty
+- `text` (optional): Email body text, required if "html" is empty
 - `html` (optional): HTML version of the email body, required if "text" is empty
 - `cc` (optional): Array of CC recipient email addresses
 - `bcc` (optional): Array of BCC recipient email addresses
 - `category` (optional): Email category for tracking
 
+### create-template
+
+Creates a new email template in your Mailtrap account.
+
+**Parameters:**
+
+- `name` (required): Name of the template
+- `subject` (required): Email subject line
+- `html` (required): HTML content of the template
+- `text` (optional): Plain text version of the template
+- `category` (optional): Template category (defaults to "General")
+
+### list-templates
+
+Lists all email templates in your Mailtrap account.
+
+**Parameters:**
+
+- No parameters required
+
+### update-template
+
+Updates an existing email template.
+
+**Parameters:**
+
+- `template_id` (required): ID of the template to update
+- `name` (optional): New name for the template
+- `subject` (optional): New email subject line
+- `html` (optional): New HTML content of the template
+- `text` (optional): New plain text version of the template
+- `category` (optional): New category for the template
+
+> [!NOTE]
+> At least one updatable field (name, subject, html, text, or category) must be provided when calling update-template to perform an update.
+
+### delete-template
+
+Deletes an existing email template.
+
+**Parameters:**
+
+- `template_id` (required): ID of the template to delete
+
 ## Development
 
 1. Clone the repository:
@@ -154,7 +208,8 @@ Add the following configuration:
       "args": ["/path/to/mailtrap-mcp/dist/index.js"],
       "env": {
         "MAILTRAP_API_TOKEN": "your_mailtrap_api_token",
-        "DEFAULT_FROM_EMAIL": "your_sender@example.com"
+        "DEFAULT_FROM_EMAIL": "your_sender@example.com",
+        "MAILTRAP_ACCOUNT_ID": "your_account_id"
       }
     }
   }
@@ -177,7 +232,8 @@ If you are using `asdf` for managing Node.js you should use absolute path to exe
         "ASDF_DATA_DIR": "/Users/<username>/.asdf",
         "ASDF_NODEJS_VERSION": "20.6.1",
         "MAILTRAP_API_TOKEN": "your_mailtrap_api_token",
-        "DEFAULT_FROM_EMAIL": "your_sender@example.com"
+        "DEFAULT_FROM_EMAIL": "your_sender@example.com",
+        "MAILTRAP_ACCOUNT_ID": "your_account_id"
       }
     }
   }
@@ -198,7 +254,8 @@ If you are using `asdf` for managing Node.js you should use absolute path to exe
         "args": ["/path/to/mailtrap-mcp/dist/index.js"],
         "env": {
           "MAILTRAP_API_TOKEN": "your_mailtrap_api_token",
-          "DEFAULT_FROM_EMAIL": "your_sender@example.com"
+          "DEFAULT_FROM_EMAIL": "your_sender@example.com",
+          "MAILTRAP_ACCOUNT_ID": "your_account_id"
         }
       }
     }

src/client.ts

@@ -9,6 +9,10 @@ if (!MAILTRAP_API_TOKEN) {
 
 const client = new MailtrapClient({
   token: MAILTRAP_API_TOKEN,
+  // conditionally set accountId if it's a valid number
+  ...(process.env.MAILTRAP_ACCOUNT_ID && !isNaN(Number(process.env.MAILTRAP_ACCOUNT_ID))
+    ? { accountId: Number(process.env.MAILTRAP_ACCOUNT_ID) }
+    : {}),
 });
 
 // eslint-disable-next-line import/prefer-default-export

src/index.ts

@@ -6,6 +6,16 @@ import dotenv from "dotenv";
 import CONFIG from "./config";
 
 import { sendEmailSchema, sendEmail } from "./tools/sendEmail";
+import {
+  createTemplate,
+  createTemplateSchema,
+  deleteTemplate,
+  deleteTemplateSchema,
+  listTemplates,
+  listTemplatesSchema,
+  updateTemplate,
+  updateTemplateSchema,
+} from "./tools/templates";
 
 dotenv.config();
 
@@ -14,13 +24,44 @@ const server = new McpServer({
   version: CONFIG.MCP_SERVER_VERSION,
 });
 
+/**
+ * Sending operations.
+ */
 server.tool(
   "send-email",
   "Send transactional email using Mailtrap",
   sendEmailSchema,
   sendEmail
 );
 
+/**
+ * Templates operations.
+ */
+server.tool(
+  "create-template",
+  "Create a new email template",
+  createTemplateSchema,
+  createTemplate
+);
+server.tool(
+  "list-templates",
+  "List all email templates",
+  listTemplatesSchema,
+  listTemplates
+);
+server.tool(
+  "update-template",
+  "Update an existing email template",
+  updateTemplateSchema,
+  updateTemplate
+);
+server.tool(
+  "delete-template",
+  "Delete an existing email template",
+  deleteTemplateSchema,
+  deleteTemplate
+);
+
 async function main() {
   const transport = new StdioServerTransport();
 

src/tools/templates/__tests__/createTemplate.test.ts

@@ -0,0 +1,173 @@
+import createTemplate from "../createTemplate";
+import { client } from "../../../client";
+
+jest.mock("../../../client", () => ({
+  client: {
+    templates: {
+      create: jest.fn(),
+    },
+  },
+}));
+
+describe("createTemplate", () => {
+  const mockTemplateData = {
+    name: "Test Template",
+    subject: "Test Email Subject",
+    html: "<h1>Test Template</h1><p>This is a test template.</p>",
+    text: "Test Template\n\nThis is a test template.",
+    category: "Test",
+  };
+
+  const mockResponse = {
+    id: 12345,
+    uuid: "abc-def-ghi",
+    name: mockTemplateData.name,
+    subject: mockTemplateData.subject,
+    category: mockTemplateData.category,
+  };
+
+  beforeEach(() => {
+    jest.clearAllMocks();
+    (client.templates.create as jest.Mock).mockResolvedValue(mockResponse);
+  });
+
+  it("should create template successfully with all required fields", async () => {
+    const result = await createTemplate(mockTemplateData);
+
+    expect(client.templates.create).toHaveBeenCalledWith({
+      name: mockTemplateData.name,
+      subject: mockTemplateData.subject,
+      category: mockTemplateData.category,
+      body_html: mockTemplateData.html,
+      body_text: mockTemplateData.text,
+    });
+
+    expect(result).toEqual({
+      content: [
+        {
+          type: "text",
+          text: `Template "${mockTemplateData.name}" created successfully!\nTemplate ID: ${mockResponse.id}\nTemplate UUID: ${mockResponse.uuid}`,
+        },
+      ],
+    });
+  });
+
+  it("should create template successfully with default category", async () => {
+    const templateDataWithoutCategory = {
+      name: mockTemplateData.name,
+      subject: mockTemplateData.subject,
+      html: mockTemplateData.html,
+      text: mockTemplateData.text,
+    };
+
+    const result = await createTemplate(templateDataWithoutCategory);
+
+    expect(client.templates.create).toHaveBeenCalledWith({
+      name: mockTemplateData.name,
+      subject: mockTemplateData.subject,
+      category: "General",
+      body_html: mockTemplateData.html,
+      body_text: mockTemplateData.text,
+    });
+
+    expect(result).toEqual({
+      content: [
+        {
+          type: "text",
+          text: `Template "${mockTemplateData.name}" created successfully!\nTemplate ID: ${mockResponse.id}\nTemplate UUID: ${mockResponse.uuid}`,
+        },
+      ],
+    });
+  });
+
+  it("should create template successfully without text content", async () => {
+    const templateDataWithoutText = {
+      name: mockTemplateData.name,
+      subject: mockTemplateData.subject,
+      html: mockTemplateData.html,
+      category: mockTemplateData.category,
+    };
+
+    const result = await createTemplate(templateDataWithoutText);
+
+    expect(client.templates.create).toHaveBeenCalledWith({
+      name: mockTemplateData.name,
+      subject: mockTemplateData.subject,
+      category: mockTemplateData.category,
+      body_html: mockTemplateData.html,
+      body_text: undefined,
+    });
+
+    expect(result).toEqual({
+      content: [
+        {
+          type: "text",
+          text: `Template "${mockTemplateData.name}" created successfully!\nTemplate ID: ${mockResponse.id}\nTemplate UUID: ${mockResponse.uuid}`,
+        },
+      ],
+    });
+  });
+
+  it("should create template successfully with custom category", async () => {
+    const customCategory = "Marketing";
+    const templateDataWithCustomCategory = {
+      ...mockTemplateData,
+      category: customCategory,
+    };
+
+    const result = await createTemplate(templateDataWithCustomCategory);
+
+    expect(client.templates.create).toHaveBeenCalledWith({
+      name: mockTemplateData.name,
+      subject: mockTemplateData.subject,
+      category: customCategory,
+      body_html: mockTemplateData.html,
+      body_text: mockTemplateData.text,
+    });
+
+    expect(result).toEqual({
+      content: [
+        {
+          type: "text",
+          text: `Template "${mockTemplateData.name}" created successfully!\nTemplate ID: ${mockResponse.id}\nTemplate UUID: ${mockResponse.uuid}`,
+        },
+      ],
+    });
+  });
+
+  describe("error handling", () => {
+    it("should handle client.templates.create failure", async () => {
+      const mockError = new Error("Failed to create template");
+      (client.templates.create as jest.Mock).mockRejectedValue(mockError);
+
+      const result = await createTemplate(mockTemplateData);
+
+      expect(result).toEqual({
+        content: [
+          {
+            type: "text",
+            text: "Failed to create template: Failed to create template",
+          },
+        ],
+        isError: true,
+      });
+    });
+
+    it("should handle non-Error exceptions", async () => {
+      const mockError = "String error";
+      (client.templates.create as jest.Mock).mockRejectedValue(mockError);
+
+      const result = await createTemplate(mockTemplateData);
+
+      expect(result).toEqual({
+        content: [
+          {
+            type: "text",
+            text: "Failed to create template: String error",
+          },
+        ],
+        isError: true,
+      });
+    });
+  });
+});