Skip to main content

MCP Server Integration

Enterprise Feature

This feature is only available for Enterprise Plan users. If you're interested in using the MCP Server, please contact ryan@beacas.com to upgrade your plan.

Easy Email Pro provides an MCP (Model Context Protocol) server that enables AI assistants like Cursor to help developers integrate Easy Email Pro and answer questions about the framework. The MCP server provides comprehensive documentation, integration guides, and Q&A capabilities.

What is MCP?​

MCP (Model Context Protocol) is a protocol that allows AI assistants to access external tools and knowledge bases. By integrating the Easy Email Pro MCP server, your AI assistant can:

  • Provide accurate integration guides for React, Next.js, and Vue
  • Answer questions about Easy Email Pro APIs and features
  • Access comprehensive documentation and examples
  • Help with troubleshooting and best practices

Features​

The Easy Email Pro MCP server includes:

  • Quick Start Guide: Get started with Easy Email Pro quickly
  • Framework Integration Guides: Step-by-step guides for React, Next.js, and Vue
  • API Reference: Detailed documentation for all APIs and components
  • Advanced Features Guide: Documentation for custom blocks, themes, and more
  • Q&A Knowledge Base: Answers to common questions and troubleshooting

How to Use in Cursor​

The Easy Email Pro MCP server is already deployed and ready to use. You just need to configure Cursor to connect to it.

Step 1: Get Your Client ID​

You need an Enterprise Plan client_id to use the MCP server. Contact ryan@beacas.com to upgrade to Enterprise Plan and obtain your client_id.

Step 2: Configure Cursor​

macOS​

  1. Open Terminal and run:
nano ~/Library/Application\ Support/Cursor/User/globalStorage/mcp.json
  1. Paste the following configuration (replace YOUR_CLIENT_ID with your Enterprise Plan client_id):
{
  "mcpServers": {
    "easy-email-pro": {
      "url": "https://develop-mcp.easyemail.pro/api/mcp",
      "transport": "streamableHttp",
      "headers": {
        "x-client-id": "YOUR_CLIENT_ID"
      }
    }
  }
}

  1. Save the file:

    • Press Ctrl+X
    • Press Y to confirm
    • Press Enter to save

  2. Completely quit and restart Cursor (not just reload the window)

Windows​

  1. Open PowerShell and run:
notepad "$env:APPDATA\Cursor\User\globalStorage\mcp.json"

  1. Paste the same configuration (replace YOUR_CLIENT_ID with your Enterprise Plan client_id) and save

  2. Completely quit and restart Cursor

Linux​

  1. Open Terminal and run:
nano ~/.config/Cursor/User/globalStorage/mcp.json

  1. Paste the same configuration (replace YOUR_CLIENT_ID with your Enterprise Plan client_id) and save

  2. Completely quit and restart Cursor

Step 3: Verify It's Working​

After restarting Cursor, try asking:

How do I get started with Easy Email Pro?

If the AI can call tools and return guides, the configuration is successful!

Available Tools​

The MCP server provides the following tools:

1. get_quick_start​

Get a comprehensive quick start guide for Easy Email Pro.

Usage:

get_quick_start({})

2. get_integration_guide​

Get framework-specific integration guides.

Parameters:

  • framework (optional): "react", "nextjs", or "vue" (default: "react")

Usage:

get_integration_guide({ framework: "nextjs" })

3. get_api_reference​

Get detailed API reference documentation.

Parameters:

  • topic (optional): API topic name, such as:
    • EmailEditorProvider
    • useEditorProps
    • useSelectedNode
    • EditorCore
    • BlockManager
    • ElementType
    • ConfigPanelsMap
    • ElementMap
    • PluginManager
    • And more...

Usage:

get_api_reference({ topic: "EmailEditorProvider" })

4. get_advanced_guide​

Get guides for advanced features.

Parameters:

  • topic (optional): Advanced feature topic, such as:
    • custom-blocks
    • mergetags
    • localization
    • global-variables
    • readonly
    • frozen-blocks
    • custom-element-components
    • responsive-view
    • theme-customization
    • prebuilt-blocks
    • element-styles
    • studio-mode
    • modern-theme
    • plugins
    • universal-elements
    • override-config-panel
    • ai-assistant
    • hotkeys
    • asset-manager
    • And more...

Usage:

get_advanced_guide({ topic: "custom-blocks" })

5. answer_question​

Answer questions about Easy Email Pro using the knowledge base.

Parameters:

  • question (required): Your question about Easy Email Pro

Usage:

answer_question({ question: "How do I upload images?" })

How to Ask Questions​

Once configured, you can ask the AI assistant questions about Easy Email Pro. The AI will automatically use the appropriate MCP tools to provide accurate answers. Here are some example questions you can ask:

Getting Started Questions​

  • "How do I get started with Easy Email Pro?"
  • "Show me a quick start guide for Easy Email Pro"
  • "What do I need to install to use Easy Email Pro?"

Framework Integration Questions​

  • "How do I integrate Easy Email Pro with React?"
  • "Show me how to set up Easy Email Pro in Next.js"
  • "How do I use Easy Email Pro with Vue?"
  • "I'm using Next.js, how do I configure the editor?"

API and Component Questions​

  • "What props does EmailEditorProvider accept?"
  • "How do I use useEditorProps hook?"
  • "Show me the API reference for EditorCore"
  • "What is BlockManager and how do I use it?"
  • "How do I customize the config panel?"

Advanced Features Questions​

  • "How do I create custom blocks?"
  • "Show me how to use merge tags"
  • "How do I implement localization?"
  • "How do I customize the theme?"
  • "How do I use global variables?"
  • "How do I make blocks readonly?"
  • "Show me how to use the AI assistant feature"

Common Usage Questions​

  • "How do I handle image uploads?"
  • "How do I export templates to HTML?"
  • "How do I save and load templates?"
  • "How do I add custom fonts?"
  • "How do I implement responsive design?"
  • "How do I use dynamic data in templates?"
  • "How do I translate emails?"

Troubleshooting Questions​

  • "Why is my editor not rendering?"
  • "How do I fix image upload issues?"
  • "My custom block is not showing up, what's wrong?"
  • "How do I debug template rendering issues?"

Example Conversations​

Here are some example conversations showing how the AI responds:

Example 1: Getting Started​

You: How do I get started with Easy Email Pro?

AI: I'll help you get started with Easy Email Pro. Let me fetch the quick start guide for you.
[AI automatically calls get_quick_start tool]
[AI provides comprehensive installation and setup instructions]

Example 2: Framework Integration​

You: I'm building a Next.js app, how do I integrate Easy Email Pro?

AI: Let me get the Next.js integration guide for you.
[AI automatically calls get_integration_guide({ framework: "nextjs" })]
[AI provides step-by-step Next.js integration instructions]

Example 3: API Reference​

You: What props can I pass to EmailEditorProvider?

AI: Let me get the API reference for EmailEditorProvider.
[AI automatically calls get_api_reference({ topic: "EmailEditorProvider" })]
[AI provides detailed prop documentation with examples]

Example 4: Custom Blocks​

You: How do I create a custom block?

AI: Let me get the guide for creating custom blocks.
[AI automatically calls get_advanced_guide({ topic: "custom-blocks" })]
[AI provides detailed instructions on creating custom blocks]

Example 5: Specific Question​

You: How do I handle image uploads in Easy Email Pro?

AI: Let me answer that for you.
[AI automatically calls answer_question({ question: "How do I handle image uploads?" })]
[AI provides specific answer about image upload configuration]

Knowledge Base​

The MCP server includes a comprehensive knowledge base covering:

  • Installation and Setup: Step-by-step installation guides
  • Framework Integration: Detailed guides for React, Next.js, and Vue
  • API Documentation: Complete API reference for all components and utilities
  • Advanced Features: Guides for custom blocks, themes, localization, and more
  • Core Concepts: Understanding node types, interfaces, and template structure
  • Common Q&A: Answers to frequently asked questions:
    • Image upload configuration
    • Exporting templates (MJML/HTML)
    • Theme customization
    • Troubleshooting
    • Saving and loading templates
    • Custom block creation
    • Dynamic data injection
    • And much more

Troubleshooting​

Configuration Not Working​

  • Ensure the file path is correct
  • Verify JSON format is valid (use a JSON validator)
  • Completely quit and restart Cursor (not just reload the window)

Connection Failed​

  • Check URL is correct: https://develop-mcp.easyemail.pro/api/mcp
  • Verify your client_id is valid (Enterprise Plan required)
  • Check your network connection

Still Having Issues?​

Contact ryan@beacas.com for support.