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

# MCP Tools

> Every tool the Statisfy MCP server offers: reading your data, working across Statisfy, and building your portals.

The Statisfy MCP server offers three sets of tools. Your AI assistant picks them based on what you ask, so you don't call them yourself.

A connection sees the tools its permissions allow: the tools that change data appear only on a connection allowed to make changes. See [Read and write permissions](https://help.statisfy.com/mcp/connecting.md#read-and-write-permissions).

## Read your data

These tools mirror Statisfy's data model, and only read:

| Tool | Purpose |
| - | - |
| `whoami` | Identify the connected user and workspace |
| `list_objects` | List accounts, people, opportunities, tasks, activities, projects, and more |
| `search_objects` | Keyword search across object names and key fields |
| `get_objects` | Fetch full details for one or more records, including the full content of an activity (see [Reading the full content of an activity](#reading-the-full-content-of-an-activity)) |
| `search_properties` | Discover the fields, including custom fields, for an object type |
| `list_custom_object_types` | List your custom object types |
| `get_custom_object_instances` | Fetch records of a custom object |
| `get_group_membership` | List which groups a person belongs to |
| `get_task_comments` | Read the comment thread on a task |
| `get_relationships` | Read how records are linked, such as which contacts belong to which accounts |
| `get_product_usage` | Read product-usage data for an account or user |
| `semantic_search` | Search meeting transcripts and knowledge-base documents by meaning |

## Work across Statisfy

These tools reach the rest of Statisfy: reports, campaigns, email templates, surveys, knowledge bases, skills, Agent Studio, digital workers, workspace setup, and more. Each call runs as you, within your role.

| Tool | Purpose | Changes data? |
| - | - | - |
| `list_api_operations` | Find the operations available to you | No |
| `make_get_call` | Read: list, get, and read operations | No |
| `make_query_call` | Read operations that take a request body: searches with filters, report queries, and previews | No |
| `make_post_call` | Create records and run actions | Yes |
| `make_put_call` | Create or update a record | Yes |
| `make_patch_call` | Update some of a record's fields | Yes |
| `make_delete_call` | Delete a record | Yes |

`list_api_operations` lists only the operations your role and your workspace's products allow, so Claude isn't offered one Statisfy would refuse.

## Build your portals

If your workspace has [Portals](https://help.statisfy.com/portals/overview.md), the connector has tools to work on your customer portals. Reading a portal needs Portals access; editing one needs a role that can manage portals (Admin or Builder).

| Tool | Purpose | Changes data? |
| - | - | - |
| `portal_list` | List your portals | No |
| `portal_guide` | Read the guide to how portals are built | No |
| `portal_list_files` | List a portal's files | No |
| `portal_read_file` | Read a file | No |
| `portal_validate` | Check the draft without saving it | No |
| `portal_build_status` | Check whether a build finished | No |
| `portal_preview_status` | Check a preview deploy | No |
| `portal_list_workers` | List the digital workers a portal can use | No |
| `portal_list_account_fields` | List the account and contact fields a portal can show | No |
| `portal_write_file` | Write a file to the draft | Yes |
| `portal_save` | Save the draft and start a build | Yes |
| `portal_deploy_preview` | Deploy a preview to review | Yes |
| `portal_set_field_exposure` | Choose which account and contact fields customers see and edit | Yes |

### How a portal change reaches a preview

Your assistant follows a fixed path, and each step is a separate tool, so you can stop at any point:

1. **Pick the portal.** It lists your portals and confirms which one you mean.
2. **Read.** It lists the files and reads the ones it needs.
3. **Edit the draft.** Writes go to your **draft**, not the live site.
4. **Validate.** A dry run of the save checks, committing nothing.
5. **Save.** Commits the draft and starts a build.
6. **Build.** It checks until the build finishes, or reports the error to fix.
7. **Deploy a preview.** It deploys to a preview URL and shares the link.
8. **You go live,** in Portal Studio, yourself. The assistant can't publish to your live site.

> [!NOTE]
>
> Edits are made against a specific version of the portal. If the portal changed in the meantime, for example because you edited it in Portal Studio, the write is refused rather than overwriting your work.

## Reading the full content of an activity

By default, your assistant sees an activity's overview, such as its subject, summary, and message count, but not the messages themselves. To see what was actually written, **ask for the messages explicitly**. For example:

* *"Show me every message in the email thread with Acme from last Tuesday."*
* *"Get the full Email Details for this activity, including the sender, time, and body of each message."*
* *"What did the customer say in the latest messages on this support ticket?"*

This works for emails, Slack and Teams conversations, support tickets, Salesforce Chatter, notes, and survey responses. For each message in the thread, your assistant gets:

* Subject, sender, recipients, and time sent
* The message body, and the names of any attachments
* A message ID from the source system, for example the email's Message-ID

Messages come back oldest first. For long threads, your assistant fetches them a page at a time. If you need the whole thread, ask it to keep going until it has every message.

> [!TIP]
>
> **Telling duplicates from replies:** two messages with the same message ID are copies of the same message. A reply always has its own ID. If a message has no ID (some sources don't provide one), treat it as a separate message.

> [!NOTE]
>
> What you get is the text Statisfy captured when the activity was synced:
>
> * For email, this is the plain-text version, with quoted earlier replies and signatures removed. Attachments are listed by name only; their contents aren't included.
> * **bcc** recipients are never returned.
> * You only see activities that your Statisfy user can see in the app.

## Transport

Statisfy serves MCP over the **Streamable HTTP** transport from the [MCP specification](https://modelcontextprotocol.io/specification/2025-03-26), on `POST https://api.statisfy.com/mcp`. Claude and other spec-compliant MCP clients use it automatically when you connect. The older HTTP+SSE transport isn't supported: `GET /mcp` returns `405 Method Not Allowed`.


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