AI assistant
Assistant tools reference
Every tool a connected assistant gets from ChecklistSquad: what it takes, what it returns, and the words it understands for people, sections and steps.
On this page
Claude, ChatGPT and Claude Code connect in about two minutes. Free on every plan.
A connected assistant gets fourteen tools from api.checklistsquad.com/mcp. Each is shaped like something a person says, not like a database row, so one sentence is usually one call. All of them run as you, with your permissions checked on every checklist, section and step they touch.
Reading needs the connection's checklistsquad.read scope. Anything that changes something needs checklistsquad.write too. A read-only connection gets "This connection is read-only" from every tool in the second group.
Looking things up
get_meWho the connection acts as, their organization, what they may do, and whether the connection may write. The assistant calls this first.
- Takes
- nothing
- Returns
- your name, organization, canStartChecklists, canInvite, writeEnabled
list_templatesThe organization's library, then the public templates, with each template's sections and step counts.
- Takes
- query
- Returns
- template rows with a ref to start from
get_templateOne template's sections, steps and the fields each step records.
- Takes
- template
- Returns
- the template's definition
find_peopleWho can be assigned: everyone, or a lookup by name, email or squad. Says when a name is ambiguous.
- Takes
- query
- Returns
- people and squads, and whether the name was ambiguous
get_checklistOne checklist as a digest: sections, who holds each, open and done counts, owners, what you may do. Steps when asked.
- Takes
- checklist, includeSteps
- Returns
- the digest
find_checklistsChecklists you can see, newest first, by words in the title, status, holder or dates.
- Takes
- query, status, assignee, since, until, limit
- Returns
- compact rows
get_my_workThe steps you may complete, grouped by checklist.
- Takes
- includeBlocked
- Returns
- steps by checklist
get_activityA checklist's history, newest first, with who did it and through which assistant. Called only when you ask about progress, proof or history.
- Takes
- checklist, since, limit
- Returns
- activity rows
Changing things
Every tool here takes preview: true and returns the resolved plan without saving. Nothing is created while a name is still ambiguous.
start_checklistStart from a template and hand out parts in one call. Emails invite. Nothing is created if any line is ambiguous or unknown.
- Takes
- template, title, assignments, preview, clientRequestId
- Returns
- the plan, and the new checklist's digest once applied
assignGive the checklist, a section or a step to someone, a squad, everyone, or nobody. Several lines are saved together.
- Takes
- checklist, assignments, preview
- Returns
- one result per line
reassignMove everything one person or squad holds to someone else, on one checklist or every open one you can assign on.
- Takes
- from, to, checklist, preview
- Returns
- what moved, what was skipped
complete_stepMark a step done with the answers its fields need, or open, blocked or skipped with a reason. A missing required answer comes back as a message, not an error.
- Takes
- checklist, step, status, answers, reason
- Returns
- the step as it now stands
finish_checklistFinish a checklist at any point. Its owners, or whoever is assigned the whole checklist, decide when the work is over; steps still open or blocked stay as they are.
- Takes
- checklist
- Returns
- the finished checklist, and the steps that were still open
draft_templateSave a template the assistant composed from your description. ChecklistSquad checks it with the rules the app uses. Admins only.
- Takes
- title, sections, summary, category, preview
- Returns
- the saved template's ref, or the rule messages
The words it understands
Names resolve by rule, never by guess. A wrong assignment is a grant, so two matches come back as a choice.
- A checklist
Its id, or words from its title among the checklists you can see. Several matches come back as a message naming them. None comes back as "isn't something you can see".
- A section or step
Its key or its title: exact first, then a title that starts with the words, within the named section when both are given.
- An assignee
- Priya
A person: exact name first, then a first or last name that starts with it. "Priya" finds Priya Shah, not Supriya Rao. Two matches are returned as a choice.
sam@venue.comAn email: the member with that address, or an invitation to it. A new address is invited and the part waits for them.
squad:stage crewA squad by name, with the prefix when a person shares the name.
everyoneThe whole organization. "the team" and "all" mean the same.
nobodyClear the assignment. "unassigned" means the same.
- A template
library:followed by its id,catalog:followed by its key, or its title.- A status
For a step:
done,open,blockedorskipped. For a checklist:openorfinished.
Preview and retries
Every tool that changes something takes preview: true and returns the resolved plan without saving: which section goes to whom, who would be invited, and which lines could not be resolved. Ask the assistant to show you the plan and it calls the tool twice, once to show and once to apply.
would_assignwould_assignwould_inviteneeds_choicestart_checklist takes an optional clientRequestId. A call retried with the same id finds the checklist it already made and returns it, so a dropped connection never starts the same checklist twice.
What each line reports
assignedThe person or squad now holds that part.
invitedAn invitation went to the email; the part waits for them to join.
waitingAn invitation to that email was already pending; the part waits for it.
clearedNobody holds the part now.
needs_choiceMore than one person matched; the candidates are listed.
not_foundNo person, squad, section or step matched.
invalidThe line could not be applied; the message says why.
failedThe checklist stands, but the invitation could not be sent.
In a preview the same results read would_assign, would_invite and would_clear.
Not available through an assistant
Deleting a checklist, template, squad, member or invitation. Inviting someone without giving them work. Forming squads or changing members. Editing an existing template. Photos and signatures, which stay on the phone.