Amami MCP docs

Installation options

Amami has two separate installation ideas:

  • Product access: use Amami Cloud at https://dashboard.amami.dev or operate an Amami-compatible instance yourself.
  • Agent access: install the local MCP server so Codex, Claude, Cursor, or another assistant can work with your analytics.

Most users should start with Amami Cloud plus MCP browser setup. Self-hosting is for teams that need infrastructure control, custom retention, private network access, or internal compliance requirements.

Cloud

Cloud is the recommended path when you want analytics running quickly.

  • Hosted dashboard and API.
  • Browser login and registration.
  • Tracking script served from https://dashboard.amami.dev/script.js.
  • MCP authorization flow for AI assistants.
  • No server, database, upgrade, or backup work.

Start here:

Install the Amami MCP server, then guide me through browser login and authorization.
https://dashboard.amami.dev/install/mcp-install.md

MCP server

The MCP server is a local stdio process. It lets an AI client call tools for setup, website management, analytics queries, events, and growth analysis.

Recommended setup:

npx -y amami-analytics-mcp setup --write

Use read-only setup when the assistant should inspect analytics but not create websites or send events:

npx -y amami-analytics-mcp setup

After setup, most MCP clients use this server entry:

{
  "mcpServers": {
    "amami": {
      "command": "npx",
      "args": ["-y", "amami-analytics-mcp@latest"]
    }
  }
}

Self-hosted compatible instance

Use self-hosting only if you are ready to operate the service stack yourself. A production deployment typically needs:

  • Node.js 20 or a container image compatible with your deployment.
  • PostgreSQL for analytics data.
  • A public HTTPS domain.
  • Backups and restore testing.
  • Upgrade and migration procedures.
  • Optional AI provider keys if you want AI features on the self-hosted instance.

MCP can target a custom instance with:

{
  "mcpServers": {
    "amami": {
      "command": "npx",
      "args": ["-y", "amami-analytics-mcp@latest"],
      "env": {
        "AMAMI_API_URL": "https://analytics.example.com",
        "AMAMI_API_KEY": "your_api_key_here"
      }
    }
  }
}

Decision guide

  • Use Cloud when speed matters more than infrastructure control.
  • Use MCP setup when you want AI-assisted analytics, setup, and growth recommendations.
  • Use manual API keys when browser setup is not practical.
  • Use self-hosting when your team accepts operational responsibility.
  • Do not paste API keys or passwords into agent chat. Use browser authorization, environment variables, local env files, or client secret stores.