Skip to main content
This page lists the tools that an AI app gets when you connect it to Squad. To connect an app, see Use Squad from Claude, ChatGPT, or Cursor.

​
The server

For how long a sign-in request waits, and the caps on the tools, see Limits and defaults.

​
Choose the squad

Every tool except list_squads, find_dashboard_action, and the two run tools takes an optional squad: a squad’s id or its name from list_squads. When you leave it out, the tool uses the squad that you opened last in Squad, on the web or on Squad for Mac. With none, it uses your first squad. A teammate is named by its id, its full name, or its first name. Upper and lower case do not matter, and a leading @ is dropped. Only teammates that you can use count. People are not teammates.

​
Tools

The Changes something column says whether the tool changes anything in Squad. Some AI apps let tools that only look something up run without asking, and ask you before the others.

​
Messages and replies

message_teammate returns the conversation’s id. Without wait_seconds, it returns at once and says to read the reply with read_conversation. With wait_seconds, it returns the replies to this message when the teammate replies in time. Otherwise it says that the teammate “hasn’t replied yet”, and you read the reply later with read_conversation. Each message that read_conversation returns has who it is from, its text, and its time. It also has, when the message has them:
  • The files that it carries, each by name with its link. A deleted file is marked as deleted.
  • What its card opens or offers, as Squad shows it: a document, list, email, or task (by id and title), the choices that it offers, or the draft that it proposes.
  • A mark that your message still waits for its reply.

​
How answers are read

answer_question turns the answer into the same answer that a button in Squad sends. Your teammate reads it the same way. A question that was already answered is not in whats_waiting, and an answer to it is refused.

​
Anything else in the dashboard

find_dashboard_action returns the best matches for your words. Each match has the action’s name, what it does, the arguments that it takes, and which tool runs it:
  • run_dashboard_read for an action that only looks something up.
  • run_dashboard_change for an action that changes something. Some actions that may only read, for example on your cloud computer, also go here, because Squad cannot tell in advance that they only read.
An action sent to the wrong run tool does not run. The tool says which one to use. The actions are the ones that the dashboard itself uses. They run as you, with the same checks as in the dashboard. Ids that an action takes, for example a squad’s workspaceId or a teammate’s agentId, come from the other tools. For example, an app can read and change the deals in Contacts: the board, a deal with its steps, and its playbooks, and it can open, change, close, or delete a deal. A deal’s money shows only to the owner and Administrators, as in the dashboard. An app can also prepare a backup of your squad and get its download link when it is ready. See Back up your squad.

​
What an app cannot do

These actions are not on the list, so an app cannot run them:
  • Changes to what you pay: seats, credit packs, auto-recharge, a task budget, your subscription and its billing portal, and payment cards and who can use them.
  • Signing in to Squad, and the apps signed in as you. An app cannot connect or disconnect apps.
A teammate’s inbox can be added or removed through an app only when it does not need a paid seat. When it needs one, the app gets “Changes to what you pay are made in Squad itself. Open Squad to make this one.”

​
Messages from the tools

A tool that cannot do what was asked returns a message instead of a result. Messages from Squad’s own checks are passed on as Squad wrote them. The sign-in has its own messages. See Troubleshooting.