Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.suprsend.com/llms.txt

Use this file to discover all available pages before exploring further.

The plugin runs the SuprSend CLI via npx suprsend, so the only hard prerequisites are Node.js (v20+) and Claude Code.

Prerequisites

RequirementMinimum VersionCheck
Claude Code CLIlatestclaude --version
Node.js + npxv20+node --version / npx --version
SuprSend CLIoptionalsuprsend --version or npx suprsend --version
A global suprsend install isn’t required — npx suprsend fetches it on first use and caches it. Installing globally (brew/Go) is supported and takes precedence over the npx fallback.

Setup

1

Authenticate

Get a service token from Account Settings → Service Tokens.
npx suprsend profile add --name default --service-token <YOUR_SERVICE_TOKEN>
Or set it as an environment variable for the current session:
export SUPRSEND_SERVICE_TOKEN="your_service_token_here"
2

Install the plugin in your AI tool

The plugin format is shared between Claude Code, VS Code Copilot, and GitHub Copilot CLI — pick the install path that matches your editor. The bundled .mcp.json invokes npx -y suprsend start-mcp-server, so the MCP server starts on demand regardless of host.
/plugin marketplace add suprsend/claude-code-plugin
/plugin install suprsend@suprsend-marketplace

Optional: global install

If you’d rather have suprsend on your PATH (faster cold starts, scripting outside the plugin):
brew tap suprsend/tap
brew install --cask suprsend

CI/CD environments

For automated environments where Claude Code isn’t available interactively, use the SuprSend CLI directly:
# 1. Either: install CLI globally
go install github.com/suprsend/cli/cmd/suprsend@latest
# Or: invoke via npx (Node.js is usually available on CI runners)
npx -y suprsend --version

# 2. Set SUPRSEND_SERVICE_TOKEN as an encrypted secret in your CI provider

# 3. Use the CLI directly (no plugin needed)
npx suprsend workflow list
npx suprsend sync --from staging --to production
The MCP server and plugin are for interactive Claude Code / VS Code Copilot sessions. In CI, call the SuprSend CLI commands directly.

Uninstall

Uninstall the plugin and remove the marketplace:
/plugin uninstall suprsend@suprsend-marketplace
/plugin marketplace remove suprsend-marketplace

Usage examples

Make sure the plugin is installed before trying these examples:
/plugin marketplace add suprsend/claude-code-plugin
Examples marked with (skill) are answered by bundled skills (no API call needed). All others use MCP tools and require authentication.

Workflow management

List and inspect workflows
> List all my workflows

> Pull the "order-confirmed" workflow and explain each node

> Which workflows are currently disabled?
Create and modify workflows
> Create a workflow called "welcome-series" that:
  1. Sends a welcome email immediately
  2. Waits 24 hours
  3. Sends a follow-up SMS if the email wasn't opened
  4. Falls back to push notification after 2 more hours

> Add a delay of 30 minutes before the SMS step in "payment-reminder"

> Push my local changes to the staging workspace
Compare environments
> Pull "order-confirmed" from both staging and production and show me the differences

Schema operations

> List all schemas in my workspace

> Show me the schema for the "invoice" event

> Validate this workflow payload against the schema:
  { "workflow": "purchase-made", "recipients": [...] }

> Commit the updated schema for "user-signup"

Template management

> What email templates do I have?

> Show me the variables used in the "welcome-email" template

> Which templates reference the "first_name" variable?

CLI reference queries (skill)

These are answered by bundled skills (no API call needed):
> What's the CLI command to sync all assets?

> How do I switch between workspace profiles?

> Show me the full list of CLI commands for workflow management

> What flags does the "workflows push" command accept?

Workflow schema reference (skill)

Also powered by bundled skills:
> What node types are available in SuprSend workflows?

> Show me the JSON schema for a "wait-for-event" node

> What are the configuration options for an email channel node?

> Give me an example of a conditional branching node

Debugging & troubleshooting

> Why might my "payment-reminder" workflow not be triggering?

> Check if the "welcome-series" workflow is enabled

> What events are configured in my workspace? I think I might be
  missing the "user-signup" event.

Bulk operations

> Disable all workflows that contain "test" in their name

> Pull all workflows locally so I can review them

> List all categories and their translation status

Troubleshooting

CLI issues

The plugin uses npx suprsend by default, so a global SuprSend CLI install isn’t required — just Node.js v20+ on the system.Fix (npx, recommended):
node --version   # should print v20.x or newer
npx --version
npx suprsend --version   # fetches + caches the CLI on first run
If you’d rather install globally:Fix (macOS):
brew tap suprsend/tap && brew install --cask suprsend
Fix (Go):
go install github.com/suprsend/cli/cmd/suprsend@latest
# Ensure $GOPATH/bin is in your PATH
MCP tools return 401 or “unauthorized” errors.The CLI resolves authentication in this priority order: (1) SUPRSEND_SERVICE_TOKEN env var, (2) --service-token flag, (3) active profile.
# Option 1: Set environment variable
export SUPRSEND_SERVICE_TOKEN="your_service_token_here"

# Option 2: Add or re-add a profile (drop the 'npx' prefix if you have a global install)
npx suprsend profile add --name default --service-token <YOUR_SERVICE_TOKEN>
Get a new service token from Account Settings → Service Tokens if needed.

Plugin issues

Try removing and reinstalling the plugin:
  • Claude Code:
    /plugin marketplace remove suprsend-marketplace
    /plugin marketplace add suprsend/claude-code-plugin
    /plugin install suprsend@suprsend-marketplace
    
  • VS Code Copilot: right-click the suprsend plugin in Agent Plugins → InstalledUninstall, then run Chat: Install Plugin From Source from the command palette and enter suprsend/claude-code-plugin.
  1. Test the server standalone:
    npx suprsend start-mcp-server --transport stdio
    
    You should see no errors. Press Ctrl+C to stop. (Use suprsend directly if you have a global install.)
  2. Verify the plugin’s .mcp.json exists and contains the suprsend server config.
  3. Check host-specific logs:
    • Claude Code: the MCP server output appears in the conversation when tool calls fail.
    • VS Code Copilot: open the Output panel and select MCP — suprsend from the dropdown.
  4. Reinstall the plugin (see steps above).
If Claude doesn’t seem to have access to SuprSend tools:
  1. Make sure the plugin is loaded: verify with Claude that the suprsend plugin is active
  2. Try explicitly asking: “Use the suprsend MCP tools to list my workflows”
  3. Check that your CLI profile has the correct permissions

Skills issues

Skills load on demand — they activate when Claude detects you’re working on SuprSend-related tasks. If skills seem missing, try reinstalling the plugin:
/plugin marketplace remove suprsend-marketplace
/plugin marketplace add suprsend/claude-code-plugin
/plugin install suprsend@suprsend-marketplace
Skills are bundled in the plugin repo. To get the latest version, reinstall the plugin — it will pull the latest from the GitHub repo.

Environment-specific

For non-interactive environments, set the SUPRSEND_SERVICE_TOKEN environment variable. The MCP server reads from the same authentication configuration as the CLI.

Getting help