Skip to main content

Tools Reference

These are the tools the SmartSuite MCP Server offers at https://app.smartsuite.com/v1/mcp. You don't call them yourself: your AI tool chooses them from what you ask. Knowing what's here helps you ask for things the server can do.

Each tool is labeled by what it can do:

  • Read-only reads and never changes anything.
  • Write creates or changes data or structure.
  • Destructive can delete or overwrite something, publish it, or start an Automation.

A connection the Member made read-only doesn't offer the Write or Destructive tools at all. If the Workspace's MCP Access is Read-Only, they're offered but refused. See Controls.

Workspaces and directory​

Find workspaces

find-workspacesRead-only

Lists the Workspaces this connection can use, who you are in each, and whether the connection can write there. Every other tool needs a Workspace Id, so assistants usually call this first.

Example prompt
  • “Which SmartSuite Workspaces can you reach?”

Search the directory

search-directoryRead-only

Finds Members and Teams by name or email address, for assigning Records, filtering by person, or mentioning someone in a comment.

Example prompt
  • “Who on the Finance team can I assign this to?”

Solutions, Tables and Fields​

Find solutions

find-solutionsRead-only

Lists Solutions with their Tables, the links between those Tables, and each Solution's Guide. This is the usual starting point for any question about how a Workspace is organized.

Example prompt
  • “What Solutions do we have, and how are the Tables in Project Management linked?”

Find tables

find-tablesRead-only

Describes the Fields of one or more Tables: their types, options, help text and how each one is written.

Example prompt
  • “What Fields does the Vendors Table have?”

Find tags

find-tagsRead-only

Lists the tags that Tags Fields offer in the Solutions you name, including tags shared across the Workspace.

Check schema

check-schemaRead-only

Reviews a Solution against SmartSuite's design standards, such as Record titles, Record IDs, Field help text, the Record layout and links between Tables, and suggests fixes. It doesn't change anything.

Example prompt
  • “Review the Incident Management Solution against SmartSuite's design standards.”

Update schema

update-schemaDestructive

Creates, changes, moves, deletes and restores Solutions, Tables and Fields. It also edits select and status options and arranges the Record layout with tabs, sections and display logic. Supports a dry run that reports what would change without changing it.

Example prompt
  • “Add a Software Licenses Table to IT Asset Management with Vendor, Seat Count, Renewal Date and Annual Cost Fields.”

Records​

Find records

find-recordsRead-only

Lists, searches, filters and sorts Records, or fetches specific Records by id, returning only the Fields asked for.

Example prompts
  • “Which Critical incidents are still New?”
  • “Show me the overdue tasks assigned to me.”

Get one field's full value

get-record-valueRead-only

Reads one Field of one Record in full, a page at a time if needed. Assistants use it for values too long to return in a list, such as a long rich text document.

Create records

create-recordsWrite

Creates one or more Records in a Table.

Example prompt
  • “Add a task called Review Q3 budget to the Tasks Table, due Friday.”

Update record fields

update-recordsWrite

Updates Fields on one or more Records. A value can be replaced, added to, cleared or edited in place, and the previous value stays in the Record's activity history.

Example prompt
  • “Move the Data Leakage incident to In Progress and make me the Incident Manager.”

Delete records

delete-recordsDestructive

Deletes Records by id. Deleted Records go to the Workspace's recycle bin, where they can be restored.

Example prompt
  • “Delete the duplicate Acme Corp record.”

Find deleted items

find-deletedRead-only

Lists what is in the recycle bin, including deleted Solutions, Tables, Fields and Records, with who deleted each item, when, and until when it can be restored.

Example prompt
  • “What was deleted from the CRM Solution this week?”

Restore records

restore-recordsWrite

Restores deleted Records from the recycle bin. Records can usually be restored for about 30 days after they are deleted, and longer on some plans.

Example prompt
  • “Restore the records I deleted from Vendors yesterday.”

Find record history

find-record-historyRead-only

Reads a Record's activity history: Field changes with their before and after values, comments, emails, deletes and restores, and whether a person, an assistant or an Automation made each change.

Example prompt
  • “Who changed the status of this contract, and when?”

Follow records

update-followingWrite

Follows or unfollows Records for you, so you are notified when they change, are commented on or are assigned.

Example prompt
  • “Follow every open incident assigned to my team.”

Comments and files​

Find record comments

find-record-commentsRead-only

Lists a Record's comments and replies.

Example prompt
  • “Summarize the comments on the Website Redesign project.”

Create record comment

create-record-commentWrite

Adds a comment or a reply to a Record, with mentions of Members, Teams or other Records and optional attachments.

Example prompt
  • “Comment on the Data Leakage incident that the leaked files have been taken offline.”

Create files

create-filesWrite

Uploads files from a public URL or from file content, ready to attach to a file Field or a comment. Uploading doesn't attach a file to anything by itself.

Views, dashboards and sharing​

Find views

find-viewsRead-only

Lists a Table's Views, such as grids, cards, kanban boards, calendars, timelines, maps and charts, with the Fields, filters, sorts and grouping of each.

Example prompt
  • “What Views does the Tasks Table have, and how is each one filtered?”

Update views

update-viewsDestructive

Creates, changes, duplicates, reorders and deletes Views. Deleting a View is permanent.

Example prompt
  • “Add a calendar View of upcoming renewals to the Software Licenses Table.”

Find dashboards

find-dashboardsRead-only

Lists a Table's dashboards with their tabs and widgets.

Example prompt
  • “Summarize what the Incident Dashboard shows on each tab.”

Update dashboards

update-dashboardDestructive

Builds and changes dashboards: their tabs, layout and widgets, such as metrics, charts, text and embedded Views.

Example prompt
  • “Build a dashboard of open incidents by severity, with the average time to resolve.”

Share at a public link

update-sharingDestructive

Publishes Views, dashboards and Forms at a public link that anyone can open without signing in, changes how the link behaves, or takes it down. The tool tells assistants to ask you before publishing anything.

Example prompt
  • “Share the Product Roadmap View at a password-protected public link.”

Forms​

Find forms

find-formsRead-only

Lists the Forms of a Table or Solution, or describes a Form in full: its pages, Fields, settings and what happens after it is submitted.

Example prompt
  • “What does the Service Request Form ask people to fill in?”

Update forms

update-formsDestructive

Creates, changes and deletes Forms, including their pages, sections, Fields, display logic, review page and thank-you page.

Example prompt
  • “Create an intake Form for new vendor requests, with a second page for compliance questions.”

Submit form

submit-formWrite

Submits a Form as you, creating a Record the way a person sending the Form would, with the Form's own required checks and defaults.

Example prompt
  • “Submit the new-hire intake Form for Jordan Lee, starting next Monday.”

Document templates​

Find document templates

find-document-templatesRead-only

Lists a Table's document templates, the Document Designer's invoices, quotes, contracts and reports, or describes a template in full.

Example prompt
  • “What document templates does the Invoices Table have?”

Update document templates

update-document-templatesDestructive

Creates, changes and deletes document templates: their page size and orientation, text, shapes, images and Fields.

Example prompt
  • “Design an A4 invoice template for the Invoices Table with a table of line items.”

Generate a document PDF

generate-document-pdfWrite

Draws a Record onto a document template and stores the result as a PDF, ready to attach to a file Field.

Example prompt
  • “Generate the invoice PDF for INV-1042 and attach it to the record.”

Automations​

Find integrations

find-integrationsRead-only

Lists the triggers and actions that Automations can be built from, both SmartSuite's own and those of connected services.

Example prompt
  • “What can start an Automation in SmartSuite?”

Find automations

find-automationsRead-only

Lists a Solution's Automations, whether each one is on and able to run, or describes Automations in full: the trigger and every step, loop and branch.

Example prompt
  • “What Automations run in the HR Solution?”

Describe automation step

describe-automation-stepRead-only

Describes the inputs and outputs of a trigger or action while an Automation is being built. Nothing runs and nothing is saved.

Update automations

update-automationsDestructive

Creates, changes, turns on or off, and deletes Automations. Deleting an Automation is permanent.

Example prompt
  • “When an incident is marked Critical, notify the Incident Manager and set the due date to tomorrow.”

Find automation runs

find-automation-runsRead-only

Shows an Automation's run history and, for any run, what happened step by step: the trigger's values, each step's inputs and outputs, and why a run failed.

Example prompt
  • “Why did the onboarding Automation fail last night?”

Retry automation run

retry-automation-runDestructive

Runs a failed Automation run again. Every step runs again, including any that succeeded the first time.

Example prompt
  • “Retry last night's failed run of the onboarding Automation.”

Press a button

click-buttonDestructive

Presses a button Field on a Record. A button that runs an Automation starts it. For other buttons the assistant tells you what the button would open or create.

Example prompt
  • “Press Send Welcome Pack on Jordan Lee's record.”

AI Fields​

Find AI connections

find-ai-connectionsRead-only

Lists the AI connections a Solution's AI Field Agents can use, and what the Workspace's AI Fields settings allow.

Example prompt
  • “Which AI connections can an AI Field in the CRM Solution use?”

My Work and starred items​

Find my work

find-my-workRead-only

Lists your My Work items, such as assigned Records, mentions and checklist items, with totals and how many are overdue.

Example prompt
  • “What's assigned to me, and what's overdue?”

Update my work item

update-my-workWrite

Resolves or reopens one of your My Work items, or changes its due date or priority.

Example prompt
  • “Move my design review item to next Wednesday.”

Find starred items

find-starredRead-only

Lists the Solutions, Tables, Views and Records you have starred.

Example prompt
  • “What have I starred?”

Update starred items

update-starredWrite

Stars or unstars Solutions, Tables, Views and Records for you. Starred items are yours alone.

Example prompt
  • “Star the Q4 Roadmap View.”

Guides​

Read guides

read-guidesRead-only

Returns the server's reference guides. Assistants read the relevant guide before writing formulas, designing a Solution, or building dashboards, document templates or Automations.

Some work needs more than a tool's description can say, such as the formula language or what makes a good dashboard. The server has guides for this, and assistants read the relevant one before that kind of work. Clients that support MCP resources can also read them directly as skill:// resources.

GuideWhat it covers
automationsHow an automation is built: its shape, how a step reveals what it takes, what the SmartSuite triggers and actions need, and how a condition is written.
dashboardsEvery widget a dashboard can hold, what each one needs, how widgets drive one another, and what a dashboard worth handing to someone else looks like.
document-templatesThe page a record is drawn onto and exported as a PDF: its paper size and pixels, the elements that go on it, how a field's type decides the way it is drawn, and how to place what sits under something that grows.
formulasThe SmartSuite formula language: every function and operator, and how a formula field is written through `update-schema`.
solution-designWhat a well-built solution looks like: record titles and IDs, field naming and types, help text, the record form, links between tables, and the Guide that explains it.