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.

All tools listed here are also available in the SuprSend AI Copilot on the dashboard.

Documentation

ToolDescription
documentation.searchSearch SuprSend docs for a topic or example
documentation.fetchFetch the full content of a documentation page by URI

Users

ToolDescriptionAPI
users.getGet a user’s profile, channel addresses, and propertiesFetch User
users.upsertCreate or update a userCreate / Update User
users.get_preferencesGet a user’s preferences across categories and channelsFull Preference
users.update_preferencesUpdate a user’s preference for a specific categoryUpdate Category
users.update_channel_preferenceUpdate global channel-level restrictions for a userUpdate Channel
users.get_list_subscriptionsGet all lists a user belongs toFetch Subscriptions
users.get_objects_subscriptionsGet all objects a user is subscribed toFetch Object Subscriptions

Tenants

ToolDescriptionAPI
tenants.getGet a tenant’s configuration, branding, and propertiesGet Tenant
tenants.get_allList all tenants in the workspaceList Tenants
tenants.upsertCreate or update a tenantCreate / Update Tenant
tenants.get_preferencesGet a tenant’s default preferences across all categoriesGet Tenant Preferences
tenants.update_preferencesUpdate a tenant’s preference overrides for a categoryUpdate Tenant Preference

Objects

ToolDescriptionAPI
objects.getGet an object’s profile, channels, and subscriber countFetch Object
objects.upsertCreate or update an objectCreate / Update Object
objects.get_preferencesGet an object’s preferences across categories and channelsFull Preference
objects.update_preferencesUpdate an object’s preference for a specific categoryUpdate Category
objects.update_channel_preferenceUpdate global channel-level restrictions for an objectUpdate Channel

Workflows

ToolDescriptionAPI
workflows.listList all workflows in the workspaceList Workflows

Scoping tool access

By default, the MCP server exposes all tools. Use --tools to restrict access — useful for production workspaces where you want read-only or limited scope. The flag accepts a comma-separated list of tool identifiers. Use * as a wildcard for all tools in a category.
{
  "mcpServers": {
    "suprsend": {
      "command": "suprsend",
      "args": [
        "start-mcp-server",
        "--tools", "users.get,users.upsert,tenants.*"
      ],
      "env": {
        "SUPRSEND_SERVICE_TOKEN": "your_service_token_here"
      }
    }
  }
}
PatternWhat it allows
users.*All user tools
users.getOnly the get user tool
tenants.*,workflows.*All tenant and workflow tools

MCP Overview

How the MCP server works and what you can do with it.

Prompt Cheatsheet

Copy-paste prompts for common tasks.