Use maxclicks in Windsurf

Use the agent onboarding brief to connect your workspace, then add MCP tools or agent skills using the setup below. For direct HTTP requests, follow the HTTP quickstart.

Give Windsurf's agent the workspace context it needs to build a maxclicks integration, then verify the connected space with a read request.

Create a key at https://app.maxclicks.ai/space/-/settings/developers. A key is scoped to one space. Set it as MAXCLICKS_API_KEY or send it as a bearer token.

Option A: MCP server

The maxclicks MCP server exposes API operations as tools. Connect over remote HTTP or run the npm package locally.

Hosted

Connect to https://mcp.maxclicks.ai/mcp. A client that supports MCP sign-in opens maxclicks so you can choose the workspace and approve what it may do; otherwise configure it to send your API key in its Authorization: Bearer header. Verify whoami before any write.

Local (stdio)

Requires Node.js 18 or newer. Configure the client to run the npm package with your API key:

{
  "mcpServers": {
    "maxclicks": {
      "command": "npx",
      "args": ["-y", "maxclicks-mcp"],
      "env": { "MAXCLICKS_API_KEY": "YOUR_API_KEY" }
    }
  }
}

Keep this configuration out of version control. Confirm the host can start the local process and successfully call whoami.

Tools

The MCP server exposes schema and attribute reads, so use list_schemas and list_attributes to inspect the model before writing records. Create and configure those definitions in the app. Use the API reference for request fields, response states, and permissions.

Group	Tools
Meta	`whoami`
Schemas, attributes (read)	`list_schemas`, `get_schema`, `list_attributes`
Records	`list_records`, `get_record`, `create_record`, `upsert_record`, `update_record`, `delete_record`, `get_contact_audit_trail`
Events	`list_events`, `fire_event`, `fire_events_batch`
Email	`list_templates`, `get_template`, `send_template`
Suppressions	`list_suppressions`, `create_suppression`, `delete_suppression`, `batch_create_suppressions`, `batch_delete_suppressions`
Webhooks	`list_webhooks`, `get_webhook`, `create_webhook`, `update_webhook`, `delete_webhook`, `rotate_webhook_secret`
Workflows	`list_workflows`, `get_workflow`, `trigger_workflow`, `pause_workflow`, `unpause_workflow`, `list_workflow_runs`, `get_workflow_run`

Segments, broadcasts, domains, senders, and topics add their own tools: mostly reads, plus creating a segment, updating a broadcast's name, audience or schedule, and sending it. Events are immutable once fired. The MCP reference lists them all.

create_suppression and delete_suppression require an admin-scoped key.

Option B: maxclicks skills

Skills teach the data model, client interfaces, and common integration tasks. Install them with:

npx skills add https://maxclicks.ai

See Agent Skills for setup and the full catalog.

The skill catalog covers these areas:

Skill	Loads for
`maxclicks`	Auth, the data model, the CLI/SDK/API map, and top gotchas. Entry point for any task.
`maxclicks-contacts`	Creating, updating, and deleting records.
`maxclicks-events`	Firing and listing events.
`maxclicks-email`	Sending templates and managing suppressions.
`maxclicks-templates`	What a template expects, who receives it, and which sender it uses.
`maxclicks-adaptyle`	Writing template content in Adaptyle over Liquid, MJML, and HTML.
`maxclicks-segments`	Building contact filters from a plain description.
`maxclicks-broadcasts`	Scheduling and sending broadcasts, and reading their results.
`maxclicks-deliverability`	Sending domains and senders, verified in the app and read over the API.
`maxclicks-topics`	Consent topics and how sends respect them.
`maxclicks-imports`	The app's bulk CSV import of records.
`maxclicks-workflows`	Triggering workflows and observing runs.
`maxclicks-webhooks`	Managing outgoing webhooks and verifying signatures.

For terminal operations, install the CLI and configure your API key. Skills provide instructions; the CLI or MCP connection gives the agent workspace access.

Which to use

Use MCP for callable tools and skills for integration guidance. Add the CLI for terminal commands, or choose an SDK for application code. The agent onboarding brief helps you verify your workspace before making a write.