> ## 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.

# Tool List

> All available tools in the SuprSend MCP server, organized by category.

<Note>
  All tools listed here are also available in the SuprSend AI Copilot on the dashboard.
</Note>

## Documentation

| Tool                   | Description                                           |
| ---------------------- | ----------------------------------------------------- |
| `documentation.search` | Search SuprSend docs for a topic or example           |
| `documentation.fetch`  | Fetch the full content of a documentation page by URI |

## Users

| Tool                              | Description                                             | API                                                                                                  |
| --------------------------------- | ------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
| `users.get`                       | Get a user's profile, channel addresses, and properties | [Fetch User](https://docs.suprsend.com/reference/get-user-profile.md)                                |
| `users.upsert`                    | Create or update a user                                 | [Create / Update User](https://docs.suprsend.com/reference/create-update-users.md)                   |
| `users.get_preferences`           | Get a user's preferences across categories and channels | [Full Preference](https://docs.suprsend.com/reference/get-user-full-preference.md)                   |
| `users.update_preferences`        | Update a user's preference for a specific category      | [Update Category](https://docs.suprsend.com/reference/update-user-category-preference.md)            |
| `users.update_channel_preference` | Update global channel-level restrictions for a user     | [Update Channel](https://docs.suprsend.com/reference/update-user-channel-preference.md)              |
| `users.get_list_subscriptions`    | Get all lists a user belongs to                         | [Fetch Subscriptions](https://docs.suprsend.com/reference/fetch-user-list-subscriptions.md)          |
| `users.get_objects_subscriptions` | Get all objects a user is subscribed to                 | [Fetch Object Subscriptions](https://docs.suprsend.com/reference/fetch-user-object-subscriptions.md) |

## Tenants

| Tool                         | Description                                              | API                                                                                                 |
| ---------------------------- | -------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
| `tenants.get`                | Get a tenant's configuration, branding, and properties   | [Get Tenant](https://docs.suprsend.com/reference/get-tenant-data.md)                                |
| `tenants.get_all`            | List all tenants in the workspace                        | [List Tenants](https://docs.suprsend.com/reference/get-tenant-list.md)                              |
| `tenants.upsert`             | Create or update a tenant                                | [Create / Update Tenant](https://docs.suprsend.com/reference/create-update-tenants.md)              |
| `tenants.get_preferences`    | Get a tenant's default preferences across all categories | [Get Tenant Preferences](https://docs.suprsend.com/reference/get-tenant-category-preferences.md)    |
| `tenants.update_preferences` | Update a tenant's preference overrides for a category    | [Update Tenant Preference](https://docs.suprsend.com/reference/update-tenant-default-preference.md) |

## Objects

| Tool                                | Description                                                | API                                                                                       |
| ----------------------------------- | ---------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
| `objects.get`                       | Get an object's profile, channels, and subscriber count    | [Fetch Object](https://docs.suprsend.com/reference/get-object-by-id.md)                   |
| `objects.upsert`                    | Create or update an object                                 | [Create / Update Object](https://docs.suprsend.com/reference/create-update-objects.md)    |
| `objects.get_preferences`           | Get an object's preferences across categories and channels | [Full Preference](https://docs.suprsend.com/reference/get-object-full-preference.md)      |
| `objects.update_preferences`        | Update an object's preference for a specific category      | [Update Category](https://docs.suprsend.com/reference/object-preference-category.md)      |
| `objects.update_channel_preference` | Update global channel-level restrictions for an object     | [Update Channel](https://docs.suprsend.com/reference/update-object-channel-preference.md) |

## Workflows

| Tool             | Description                         | API                                                                     |
| ---------------- | ----------------------------------- | ----------------------------------------------------------------------- |
| `workflows.list` | List all workflows in the workspace | [List Workflows](https://docs.suprsend.com/reference/list-workflows.md) |

***

## Scoping tool access

By default, the MCP server exposes all tools. Use `--tools` to restrict access — useful for production environments 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.

```json theme={"system"}
{
  "mcpServers": {
    "suprsend": {
      "command": "suprsend",
      "args": [
        "start-mcp-server",
        "--tools", "users.get,users.upsert,tenants.*"
      ],
      "env": {
        "SUPRSEND_SERVICE_TOKEN": "your_service_token_here"
      }
    }
  }
}
```

| Pattern                 | What it allows                |
| ----------------------- | ----------------------------- |
| `users.*`               | All user tools                |
| `users.get`             | Only the get user tool        |
| `tenants.*,workflows.*` | All tenant and workflow tools |

***

<CardGroup cols={2}>
  <Card title="MCP Overview" icon="server" href="/reference/mcp-overview">
    How the MCP server works and what you can do with it.
  </Card>

  <Card title="Prompt Cheatsheet" icon="clipboard-list" href="/reference/mcp-prompts">
    Copy-paste prompts for common tasks.
  </Card>
</CardGroup>