> ## Documentation Index
> Fetch the complete documentation index at: https://docs.swashmo.com/llms.txt
> Use this file to discover all available pages before exploring further.

# AI assistants

> Connect an AI assistant to your Swashmo workspace over MCP, and search these docs from it.

Swashmo has a remote MCP (Model Context Protocol) server. An AI assistant that supports MCP
(Claude, ChatGPT, Cursor and others) can read your workspace and make a few changes, as you.

## Connect your workspace

**1. Add the server**

In your assistant's MCP or connector settings, add `https://api.swashmo.com/mcp`.

**2. Sign in**

The assistant opens Swashmo. Sign in, check the app's name and what it asks for, and approve.

**3. Ask**

For example: "Which designs does my workspace have?" or "How many link clicks did we get in
the last 30 days?"

### Read and write

The sign-in screen lists what the assistant asks for:

* **Read** lets it see your workspace.
* **Write** lets it change it.

The assistant can only do what your role allows: changing people needs an admin or owner. Tell it
to ask first if you want to confirm changes. There are no tools to delete anything.

## What it can do

| Tool | Access | What it does |
| - | - | - |
| `list_workspaces` | Read | Your workspaces and your role in each |
| `get_overview` | Read | Plan and limits, people with a signature, designs and clicks |
| `list_people` | Read | Find people by name, department or active status |
| `get_person` | Read | A person and their signatures |
| `list_departments` | Read | Departments with their number of people |
| `list_designs` | Read | Your designs, the default first |
| `get_design` | Read | One design: theme, blocks and warnings |
| `list_themes` | Read | Swashmo's themes and your own |
| `get_signature_html` | Read | A person's signature as HTML and text |
| `get_click_stats` | Read | Clicks per day and the most clicked links |
| `create_person` | Write | Add a person (uses a seat) |
| `update_person` | Write | Change a person's details |
| `assign_design` | Write | Give a person a design, or the default |

## Search these docs from your assistant

The documentation has its own MCP server, with no sign-in. Add `https://docs.swashmo.com/mcp` to
your assistant to let it search these pages when it answers questions about Swashmo.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.