simplelogin-mcp

simplelogin-mcp

An independent, self-hostable Model Context Protocol server for existing SimpleLogin users. It lets compatible MCP clients create and manage aliases, inspect alias activity metadata, work with reverse aliases, manage routing, and review account settings through a server you run.

Independent project: simplelogin-mcp is an independent, open-source project. It is not an official SimpleLogin or Proton AG product, service, or MCP implementation, and it is not affiliated with, endorsed by, or sponsored by SimpleLogin or Proton AG.

At a glance

• Local stdio is the simplest starting point for one local MCP client. The client launches the server without opening a network listener.
• Direct Node.js — Streamable HTTP runs a persistent service for HTTP-capable MCP clients, listening on loopback by default.
• Docker Compose — Streamable HTTP runs the published container when you prefer to manage the service with Docker, with loopback-only host publishing by default.
• SL_API_KEY grants full control of your SimpleLogin account. Keep it out of prompts, logs, shell history, and version control.
• Tool names, inputs, safety annotations, bounds, and output descriptions come from the same catalog and schemas used by the server.

Documentation

The website is the canonical user documentation:

• Get started
• Create a SimpleLogin API key
• Set up your MCP client
• Browse the tool catalog
• Review API coverage and non-goals
• Understand Security & Data
• Operate a running deployment
• Troubleshoot an installation
• View the published container package

Repository-maintainer documentation remains alongside the code:

• Live smoke-test runbook
• Registry readiness
• Release process
• Contributing guide
• Support policy
• Vulnerability reporting

Tools

The catalog covers aliases, contacts and reverse aliases, mailboxes, custom domains, notifications, and account settings. Read operations with potentially large results are bounded, and permanent deletions require explicit confirmation.

Use the searchable website tool catalog for the current public surface, or read the generated TOOL_CATALOG.md beside the source. Endpoint-level support and deliberate non-goals are documented in API coverage.

Common workflows

The workflow guide provides complete, reviewable sequences. These summaries preserve the most common entry points.

Create and organize aliases

Use alias_list to find existing aliases before creating one with alias_create_random. For a custom address, inspect alias_options_get before calling alias_create_custom. Use alias_update to keep notes, names, and pinned state organized, and alias_set_enabled to enable or disable an alias explicitly.

For a personal example of how I organize my SimpleLogin aliases, read How I organize my email.

Audit recent alias activity

Find the alias with alias_list or alias_get, then inspect bounded activity-metadata pages with alias_activity_list. Results describe forwards, replies, blocks, and bounces; the server does not read email message bodies.

Create a reverse alias for sending

Use contact_list to check existing recipients for an alias, then contact_create to create or reuse a reverse alias when needed. Send the actual message from a real mailbox that owns the alias to the returned reverse-alias address. The MCP server creates the routing address; it does not compose or send the email.

Manage mailboxes

Use mailbox_list before creating, updating, or deleting a mailbox. New addresses require verification in SimpleLogin, and permanent deletion requires both confirm: true and an explicit transfer-or-delete decision for owned aliases.

Maintain a custom domain

The server can inspect and update supported settings for an existing custom domain. Domain creation, deletion, DNS, and MX verification remain in SimpleLogin's official interface.

Check on the account

Use account_get_stats for aggregate account counts, notification_list for bounded account notifications, and settings_get before making supported changes with settings_update.

Install and run

Prerequisites

• A SimpleLogin account with a dedicated API key.
• Git.
• For source installs: Node.js 24.x with Corepack and pnpm 11.5.1.
• For container installs: Docker with Docker Compose.
• An MCP client that supports your chosen transport: local stdio or Streamable HTTP.

Local stdio

Local stdio is the recommended starting point when the client and server run on the same machine:

git clone https://github.com/enthouan/simplelogin-mcp.git
cd simplelogin-mcp
corepack enable
pnpm install --filter simplelogin-mcp --frozen-lockfile
pnpm build

Next, follow the recipe for your MCP client, point it at the absolute path to dist/index.js, set TRANSPORT=stdio and SL_API_KEY in its private configuration, restart the client, and verify discovery with the documented read-only call.

Docker Compose

Use the bundled Compose file for an operator-managed persistent service:

git clone https://github.com/enthouan/simplelogin-mcp.git
cd simplelogin-mcp
cp .env.example .env
# Set SL_API_KEY and MCP_AUTH_TOKEN in .env
docker compose up -d
docker compose ps
curl http://localhost:3000/health

The v1.0.4 response is {"status":"ok","version":"1.0.4"}.

The default file pulls the published GHCR image, publishes the host port only on 127.0.0.1, and requires MCP_AUTH_TOKEN because the application binds 0.0.0.0 inside the container. Pin SIMPLELOGIN_MCP_IMAGE_TAG to a release for repeatable deployments. See the Docker Compose guide before widening the host bind.

Local Docker build

For source changes, build the container from the checkout instead of pulling GHCR:

docker compose -f docker-compose.local.yml up --build

Direct Node.js — Streamable HTTP

For Direct Node.js — Streamable HTTP development, copy .env.example, set SL_API_KEY, and load the ignored file only into a subshell:

corepack enable
pnpm install --filter simplelogin-mcp --frozen-lockfile
cp .env.example .env
pnpm build
(
  set -a
  . ./.env
  set +a
  TRANSPORT=http HOST=127.0.0.1 PORT=3000 pnpm start
)

The MCP endpoint is POST http://127.0.0.1:3000/mcp; GET /health verifies only process health. See the Streamable HTTP guide for client authentication and wider-network requirements.

Configuration

Configuration is provided through environment variables and validated at startup. The primary settings are:

Variable	Purpose
SL_API_KEY	Required SimpleLogin credential; grants full account control.
TRANSPORT	Literal stdio or http; defaults to http.
SL_API_URL	Hosted or self-hosted SimpleLogin web-app origin.
HOST / PORT	Direct Streamable HTTP listener; defaults to 127.0.0.1:3000.
MCP_AUTH_TOKEN	Separate bearer token protecting POST /mcp; required for normal non-loopback startup.

See the complete configuration reference for Compose publishing, allowed browser origins, timeouts, private CAs, and proxy variables.

Getting a SimpleLogin API key

Create a dedicated key in the SimpleLogin dashboard and keep it private. Follow the API-key guide for hosted and self-hosted instances.

Connecting a client

Use the maintained client setup recipes for Codex, Claude Code, Claude Desktop, VS Code, and OpenCode. The compatibility page records the scope and limitations of current evidence.

After the client discovers the server, ask: “Can you show me my SimpleLogin account usage?” The expected tool is account_get_stats, a read-only call that takes no arguments and returns aggregate account counts. A successful call verifies the client connection and access to SimpleLogin; GET /health checks only that the HTTP server is running.

Self-hosted SimpleLogin

Set SL_API_URL to the self-hosted web-app origin without an /api suffix, and create SL_API_KEY on that same instance. Private-CA and proxy configuration is documented in the configuration reference. Compatibility depends on the instance exposing upstream-compatible API paths and response shapes.

Troubleshooting

Start with the troubleshooting guide. Do not include API keys, bearer tokens, authorization headers, proxy credentials, alias addresses, or mailbox addresses in logs or issues. For support boundaries, see SUPPORT.md.

Development

Requires Node.js 24.x and pnpm.

pnpm install --frozen-lockfile
pnpm build
pnpm typecheck
pnpm lint
pnpm test
pnpm format:check

For a watch server, run pnpm dev after loading your configuration into the environment. Local pnpm commands do not automatically load .env; the Direct Node.js example shows how to load it in a subshell.

See CONTRIBUTING.md for endpoint patterns, catalog generation, testing, and pull request expectations. Live SimpleLogin smoke tests are manual and opt-in because they create a temporary alias; use docs/live-smoke-test.md and verify cleanup.

Architecture

Endpoint support is split across constants, response schemas, the SimpleLogin client, and the tool catalog and registrations. The shared request layer handles authentication, timeouts, error normalization, and response validation. See CONTRIBUTING.md for the exact change pattern and How it works for the runtime request flow.

Security

Treat SL_API_KEY like a password. Local stdio opens no listener. Streamable HTTP binds to loopback by default and refuses normal unauthenticated non-loopback startup. Any LAN or public deployment should keep MCP_AUTH_TOKEN enabled and terminate TLS at a reverse proxy.

Read SECURITY.md before reporting a vulnerability. Use SUPPORT.md for questions and non-security bugs.

Contributing

Contributions are welcome. Read CONTRIBUTING.md before opening a pull request.

License

MIT — see LICENSE.