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

# Tool reference

> What the Whirl MCP connection can do.

## Workspaces

| Tool | Name | What it does |
| - | - | - |
| List workspaces | `list_workspaces` | The workspaces this connection can open. |
| List workspace members | `list_workspace_members` | The people in a workspace. |
| List task statuses | `list_workspace_statuses` | The columns on a workspace's task board. |
| Create workspace | `create_workspace` | Create a workspace, with its own agent. |
| Rename workspace | `rename_workspace` | Change a workspace's name. |
| Archive workspace | `archive_workspace` | Hide a workspace and pause its agents and automations. |

## Tasks

| Tool | Name | What it does |
| - | - | - |
| List tasks | `list_tasks` | Tasks in one column of a workspace. |
| Search tasks | `search_tasks` | Find tasks by words in the title or description. |
| Get task | `get_task` | A task's status, people, tags, due date and notes. |
| List task activity | `list_task_events` | What has happened on a task. |
| List task chat | `list_task_messages` | The chat with the agent on a task. |
| List source conversation | `list_task_conversation_messages` | The email or chat thread a task came from. |
| Update task | `update_task` | Change a task's title, status or due date. |
| Mark task done | `complete_task` | Mark a task done. |
| Assign task | `assign_task` | Choose who a task is assigned to. |
| Set task tags | `set_task_tags` | Set the tags on a task. |
| Add note | `add_task_note` | Add a note the team and the agent can see. |
| Delete task | `delete_task` | Delete a task that is already done. |

## Agents

| Tool | Name | What it does |
| - | - | - |
| List agents | `list_agents` | The agents in your workspaces. |
| Give an agent a task | `submit_task` | Create a task and have an agent start on it. |
| Message the agent on a task | `send_task_message` | Send the agent a follow-up on a task. |
| List agent runs on a task | `list_task_runs` | Each time an agent worked on a task. |
| Get agent run | `get_run` | What an agent run produced, and the actions it proposed. |

## Approvals

| Tool | Name | What it does |
| - | - | - |
| List pending actions | `list_pending_actions` | Actions an agent is waiting for someone to decide on. |
| Get pending action | `get_pending_action` | The full draft of one proposed action. |
| Approve pending action | `approve_pending_action` | Let Whirl carry out a proposed action, such as sending a message. |
| Reject pending action | `reject_pending_action` | Stop a proposed action, a task for a person, or a question. |
| Edit pending action | `update_pending_action` | Change a draft before it is approved. |
| Complete human task | `complete_human_task` | Mark done something an agent asked a person to do. |
| Answer agent question | `answer_agent_question` | Reply to a question an agent asked. |

## Reminders

| Tool | Name | What it does |
| - | - | - |
| List reminders | `list_reminders` | Reminders set on a task. |
| Set reminder | `create_reminder` | Wake the agent on a task at a set time. |
| Change reminder | `update_reminder` | Change a reminder's message or time. |
| Cancel reminder | `cancel_reminder` | Cancel a reminder. |

## Handbook

| Tool | Name | What it does |
| - | - | - |
| List an agent's handbook | `list_agent_instructions` | The entries in an agent's handbook. |
| Read a handbook entry | `read_agent_instruction_section` | The full text of one handbook entry. |
| Edit a handbook entry | `update_agent_instruction_section` | Edit an entry in an agent's handbook. |
| Reorder an agent's handbook | `reorder_agent_instruction_sections` | Change the order of an agent's handbook. |
| List the company handbook | `list_company_handbook_sections` | The handbook every agent in the organization follows. |
| Read a company handbook entry | `read_company_handbook_section` | The full text of one company handbook entry. |
| Edit a company handbook entry | `update_company_handbook_section` | Edit an entry that applies to every agent. |
| Reorder the company handbook | `reorder_company_handbook_sections` | Change the order of the company handbook. |

## Knowledge

| Tool | Name | What it does |
| - | - | - |
| List knowledge sources | `list_knowledge_sources` | Links and files an agent can consult. |
| Read a knowledge source | `read_knowledge_source` | Details of one knowledge source. |
| Add a knowledge link | `add_knowledge_link` | Add a web page an agent can read. |
| Update a knowledge source | `update_knowledge_source` | Change a knowledge source's name, note or address. |
| Remove a knowledge source | `remove_knowledge_source` | Remove a link or file from an agent's knowledge. |

## Scheduled tasks

| Tool | Name | What it does |
| - | - | - |
| List scheduled tasks | `list_scheduled_tasks` | Prompts an agent runs on a schedule. |
| Get scheduled task | `get_scheduled_task` | A scheduled task's prompt, schedule and next run. |
| List scheduled task runs | `list_scheduled_task_runs` | Past runs of a scheduled task. |
| Create scheduled task | `create_scheduled_task` | Have an agent run a prompt on a repeating schedule. |
| Update scheduled task | `update_scheduled_task` | Change a scheduled task's prompt, schedule or agent. |
| Pause scheduled task | `pause_scheduled_task` | Stop a scheduled task until it is resumed. |
| Resume scheduled task | `resume_scheduled_task` | Start a paused scheduled task again. |
| Delete scheduled task | `delete_scheduled_task` | Delete a scheduled task. Earlier runs stay. |
| Run scheduled task now | `run_scheduled_task_now` | Run a scheduled task once, outside its schedule. |


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