Build with AI
Connect your coding agent to the customer data and prepared experiences in maxclicks. Use the Public API, MCP tools, or a client library to keep records current, respond to events, and read campaign results. Start with a key for the workspace you intend to use; authentication explains its permissions.
The split is the same one the API draws: you build things in the app, and the agent triggers, reads, and measures them. Schemas, attributes, templates, sending domains, senders, topics, and API keys are created and edited in the app, and so is CSV import. A broadcast is drafted and its email written there too, though an agent can still rename it, change its audience or its schedule, and send it. An agent works with everything you built there.
| Surface | For | Install |
|---|---|---|
| MCP server | MCP hosts (Claude, Cursor) that call tools | https://mcp.maxclicks.ai/mcp (hosted; the npm package is not published yet) |
| CLI | Terminals, scripts, and agents that shell out | npm install -g maxclicks-cli (not published yet) |
| Agent skills | Skills-compatible coding agents | npx skills add https://maxclicks.ai |
| SDKs | Application code in a specific language | per language |
MCP server
The maxclicks-mcp server turns the Public API into MCP tools. It covers records, events, suppressions, segments, webhooks, workflow triggers and runs, template sends, and broadcast sends and metrics. It can also read (but not change) your schemas, attributes, sending domains, senders, and topics. Start an agent on list_schemas and list_attributes so it learns the shape of your space before it writes anything.
Connect a hosted MCP client to the streamable HTTP endpoint and send your key as a bearer token:
https://mcp.maxclicks.ai/mcp
Authorization: Bearer max_...
To run it on your own machine instead, point a stdio client at npx -y maxclicks-mcp with your key in MAXCLICKS_API_KEY. The MCP server page has the Claude Desktop config to paste in, the full tool list, and the order in which the server looks for your key.
maxclicks-mcp is not published to npm, so npx -y maxclicks-mcp does not
resolve and a registry-based stdio configuration cannot start this package.
Use the hosted endpoint at mcp.maxclicks.ai instead.
CLI
maxclicks-cli drives the Public API v1 from a terminal or an agent. Every command prints JSON to stdout and a structured error to stderr, so it composes with jq. Requires Node.js 18+.
The CLI is not published to npm yet, so npm install -g maxclicks-cli does
not resolve. The commands below document the client interface; use the HTTP
quickstart for a request you can run without installing it.
Until it ships, drive maxclicks from the Public API directly or from
the hosted MCP server, which needs no install.
npm install -g maxclicks-cli
maxclicks config set-key max_... # or export MAXCLICKS_API_KEY=max_...
maxclicks whoami # confirm the key and its space
maxclicks schemas list --type contact
maxclicks records upsert students --data '{"email":"[email protected]","firstName":"Ada"}'
maxclicks events fire orders --data '{"eventId":"ord_1","amount":42}'
maxclicks templates send <templateId> --data '{"contact":{"email":"[email protected]"}}'
List commands paginate with --limit and --offset; pass --all to fetch every page as a flat array. maxclicks api GET /schemas is a raw escape hatch for any endpoint the CLI does not wrap. Use --base-url (or MAXCLICKS_BASE_URL) for staging and --profile <name> for multiple spaces.
Agent skills
maxclicks-ai ships 13 agent skills that teach a coding agent to work the maxclicks API, SDKs, CLI, and docs, plus one agent for building a whole integration end to end. An entry-point skill loads on any maxclicks task, and the other twelve each cover one area of the product. Agent Skills names every one, says what it is for, and covers the other ways to install them.
Install them into any skills-compatible agent (Claude Code, Cursor, Codex, Gemini CLI):
npx skills add https://maxclicks.ai
npx skills update -y # update later
The skills have not been regenerated since the API surface narrowed, so several still describe endpoints that now return 404. Where a skill and this documentation disagree, this documentation is current: Agent Skills spells out which areas are affected.
SDKs
Use an SDK for application code instead of shelling out. There are SDKs for 8 languages: Node, Python, Go, PHP, Ruby, Java, Rust, and Elixir.
Registry releases are still pending, so an SDK may not install with its documented command yet. Check SDKs for where each one stands before you plan around it.
Prefer upsert over create. Upsert matches on a record's identity, so
sending the same person twice updates one contact instead of
creating a second.