Aurora SendCloud MCP Local Deployment Guide

Run the Aurora SendCloud MCP server locally over stdio and connect it to Cursor, Windsurf, or Claude Desktop with npx.

The server package is @aurorasendcloud/mcp-server.

• npm package: @aurorasendcloud/mcp-server
• npm page: https://www.npmjs.com/package/@aurorasendcloud/mcp-server

What can it do?

This MCP server keeps the tool list small, but each tool supports richer operation modes and analysis output.

Use the MCP server to complete these tasks from your MCP client:

• Send email with send_email
• Check delivery status with get_email_status
• Review sending statistics with get_send_statistics
• Build chart-ready stats payloads with get_send_statistics (include_chart=true)
• Query account quota and basic account info with get_account_quota

1. Set up your environment

1. Install Node.js 18.17 or later.
2. Get valid api_user and api_key credentials.
3. Confirm your machine can reach the Aurora SendCloud API.
4. Export the environment variables your MCP client should use:

export SENDCLOUD_API_USER="your_api_user"
export SENDCLOUD_API_KEY="your_api_key"
# Optional: region selector (default: sg)
# Supported: sg | us | hk
export SENDCLOUD_REGION="sg"
# Optional: custom base URL (highest priority, overrides SENDCLOUD_REGION)
export SENDCLOUD_BASE_URL="https://api.aurorasendcloud.com"

Region mapping:

• sg => https://api.aurorasendcloud.com
• us => https://api-us.aurorasendcloud.com
• hk => https://api-hk.aurorasendcloud.com

2. Configure your MCP client

This server runs as a local stdio process. Configure a local command and args, and do not configure a remote url.

{
  "mcpServers": {
    "aurorasendcloud": {
      "command": "npx",
      "args": ["-y", "@aurorasendcloud/mcp-server"],
      "env": {
        "SENDCLOUD_API_USER": "your_api_user",
        "SENDCLOUD_API_KEY": "your_api_key",
        "SENDCLOUD_REGION": "sg"
      }
    }
  }
}

3. Understand configuration priority

If you pass the same setting in more than one place, the higher item in each list takes precedence.

Auth parameter priority

1. Tool call arguments (api_user / api_key)
2. Environment variables (SENDCLOUD_API_USER / SENDCLOUD_API_KEY)

Region and base URL priority

1. Tool argument base_url
2. Environment variable SENDCLOUD_BASE_URL
3. Tool argument region (sg/us/hk)
4. Environment variable SENDCLOUD_REGION
5. Default region sg

4. Validate the installation

1. Restart your MCP client.
2. Open a new chat.
3. Run one of these test prompts:

• "Query weekly sending statistics (this_week)"
• "Check delivery status for a specific email_id"
• "Send a test email"
• "Query remaining account quota"

If the setup is correct, your client should expose the Aurora SendCloud tools and return a result instead of a configuration error.

You can also override the region per tool call by passing region: "us" (or sg / hk).

What does it look like in action?

Typical workflow:

1. Send or schedule mail with send_email (basic/template/calendar/task_status modes).
2. Check delivery and engagement status with get_email_status (include_tracking=true).
3. Query trend data with get_send_statistics (granularity=day|hour|invalid).
4. Generate chart-ready output with get_send_statistics (include_chart=true).
5. Evaluate quota risk with get_account_quota (include_health=true).

Use prompts like these when you test the server or show teammates what it can do:

• "Query weekly sending statistics (this_week)"
• "Use get_send_statistics for last_7_days with include_chart=true, metrics deliveredNum,bounceNum and chart_type=line"
• "Check delivery status for a specific email_id"
• "Send a test email"
• "Query remaining account quota"

Optional: Build locally for development

Run these commands only if you are contributing to the local MCP project in this repository:

cd /Users/sendcloud/Desktop/temp/mcpmd/aurorasendcloud-mcp
npm install
npm run build

Troubleshooting

The tools do not appear in your client

• Check your JSON syntax.
• Verify that npx is available and that the package name is @aurorasendcloud/mcp-server.
• Restart the MCP client after you update the configuration file.

Authentication failed

• Verify SENDCLOUD_API_USER and SENDCLOUD_API_KEY.
• If you pass api_user or api_key in a tool call, remember that those values override the environment variables.

API request failed

• Check network connectivity to the Aurora SendCloud API.
• Verify SENDCLOUD_REGION and SENDCLOUD_BASE_URL.
• If you set SENDCLOUD_BASE_URL, remember that it overrides SENDCLOUD_REGION.