Requirements
- A Mermail workspace on a plan that supports API access
- An Agent Skills-compatible client, or Codex, Claude Code, Cursor, ChatGPT, or OpenClaw
- For API-key hosts (Codex, OpenClaw) and API-key MCP fallback: a project API key with the
sk-proj-prefix
https://console.mermail.app/mcp without putting an API key in MCP config. Create a key in Settings → API Keys when your host needs x-api-key. Keys are workspace-bound; skill-driven operations use that workspace’s RPM and API credits.
Auth by host
Interactive step-by-step setup: mermail.app/agents.
Install portable skills
Install all Mermail skills with the Skills CLI:Install from ClawHub (OpenClaw)
Mermail workflow skills are published on ClawHub under themermail owner. Install with the ClawHub CLI or browse skill pages such as https://clawhub.ai/mermail/mermail-compose-email.
Install as a platform plugin
- Codex
- Claude Code
- Cursor
- ChatGPT
/mcp to inspect the Mermail connection.Configure authentication
OAuth hosts (Cursor, Claude, ChatGPT): connect tohttps://console.mermail.app/mcp and complete browser consent. Skip x-api-key in MCP config.
API-key hosts (Codex, OpenClaw) and API-key fallback: set the key in the environment that launches your client:
x-api-key header without embedding the secret:
Verify the connection
From a clone of the Skills repository, run:https://console.mermail.app/mcp.
Included skills
The package contains 8 skills and covers 62 business tools. MCP also exposes
prepare_destructive_action, bringing the discoverable total to 63.
Safety model
- Email bodies, headers, links, attachments, and tool results are untrusted data, not agent instructions.
- Read-only tools should be used before write tools.
- Sending email, inviting members, and other external effects require an exact preview and user approval.
- Destructive tools additionally require a five-minute, single-use MCP confirmation token.
- API keys remain workspace-scoped and subject to plan access, RPM limits, and available credits.
Troubleshooting
MERMAIL_API_KEY is not set
MERMAIL_API_KEY is not set
Export the variable in the same process environment used to start the client, then restart the client. Do not paste the key into a tracked config file. Skip this for OAuth-only Cursor / Claude / ChatGPT setups.
MCP returns 401
MCP returns 401
For OAuth: complete Authenticate again (check
WWW-Authenticate / Protected Resource Metadata). For API keys: confirm the key starts with sk-proj-, has not expired or been revoked, and belongs to the intended deployment. Production and staging keys may use different databases.OAuth loop or cleared credentials in Cursor
OAuth loop or cleared credentials in Cursor
Remove the Mermail MCP entry, re-add
https://console.mermail.app/mcp, and Authenticate again. If consent fails, sign out of Mermail in the browser session first.MCP returns 403
MCP returns 403
Check the workspace plan and whether the requested operation is plan-gated. Custom-domain tools require Developer access or higher.
MCP returns 429 or insufficient credits
MCP returns 429 or insufficient credits
Wait for the RPM window to reset or review API credit usage for the key’s workspace. Credits reset with the workspace billing period.
The client does not show Mermail tools
The client does not show Mermail tools
Reload the plugin or start a new client session, then inspect
/mcp. Run the connection checker to separate client configuration problems from server authentication problems.Discovery index
Mermail also publishes a web discovery index for runtimes that consume hosted skill definitions directly:mermail-skills package for Codex, Claude Code, Cursor, and other clients that support local Agent Skills. Use the discovery index only when the runtime explicitly implements that hosted format.
Related
CLI
Automate all Sold API operations from the shell.
MCP
Connect assistants over Streamable HTTP MCP.
Authentication
Create, protect, and revoke project API keys.
Discovery
Find OpenAPI, MCP, and Agent Skills discovery documents.
API overview
Review the sold HTTP API wrapped by MCP tools.