Tools Reference
This reference documents the tools that agents can use, organised by category. Tools are the actions agents take during conversations — searching knowledge, sending messages, reading files, running code, and working with integrations. You will see these tool names in the activity log when an agent works on your request.
Knowledge and memory
Section titled “Knowledge and memory”sprigr_search
Section titled “sprigr_search”Search your organisation’s knowledge bases using keyword and semantic search. Returns matching entries ranked by relevance.
Key parameters: query (search text), index (optional — target a specific knowledge base), limit (max results)
sprigr_write
Section titled “sprigr_write”Write a new entry to a knowledge base or update an existing one. Use this to store information the agent discovers during conversations.
Key parameters: index (target knowledge base), title, content, keywords (list of related terms for discoverability)
collection
Section titled “collection”Work with Collections — typed, faceted datasets your organisation defines (for example, a customer register or an asset list). Supports defining, querying, and ingesting records.
pin_to_context
Section titled “pin_to_context”Pin durable facts and open tasks to the agent’s working memory so they persist across turns without re-searching.
curate_context
Section titled “curate_context”Let the agent manage its own working memory — keeping load-bearing content, dropping stale facts, and clearing its working set when the topic changes.
analyze_communication_style
Section titled “analyze_communication_style”Analyse and store communication style preferences so the agent can match how you like to be spoken to.
Messaging and collaboration
Section titled “Messaging and collaboration”send_message
Section titled “send_message”Send a message to another agent. This is how agents collaborate — delegating tasks, asking questions, and sharing information.
Key parameters: agent (recipient agent name or ID), message (the content to send)
delegate_task
Section titled “delegate_task”Ask another agent to perform a task and receive the result inline. Available to every agent, not just companions — any agent can consult a specialist mid-conversation. Self-delegation is blocked.
Key parameters: agent (target agent), task (description of what needs to be done)
find_teammates
Section titled “find_teammates”Discover which agents in the organisation can help with a given topic. Agents use this before delegating so requests land with the right specialist.
notify_chat
Section titled “notify_chat”Proactively send a direct message to a person, or post into a group or channel the agent belongs to.
create_team_room
Section titled “create_team_room”Create a new group or channel in team chat, ready for the agent to post into.
search_team_chat
Section titled “search_team_chat”Search your organisation’s team chat history. Companion agents search on their user’s behalf; shared agents have a narrower scope.
Interacting with the user
Section titled “Interacting with the user”ask_user_decision
Section titled “ask_user_decision”Pause and ask the user to make a decision — yes/no or a multiple-choice pick — before continuing.
show_panel
Section titled “show_panel”Show the user an interactive panel (a form, preview, or editable surface). The user’s edits come back to the agent as a submission.
suggest_actions
Section titled “suggest_actions”Offer the user clickable follow-up actions at the end of a reply.
request_outbound_access
Section titled “request_outbound_access”Ask the user to approve access to an external web domain the agent is not yet allowed to call, instead of silently failing.
Companion-only tools
Section titled “Companion-only tools”create_specialist
Section titled “create_specialist”Create a new specialist agent on the fly. Only companion agents have this tool, since creating agents is a privileged action performed on a user’s behalf. The companion sets up the agent with an appropriate persona and settings based on your description.
Key parameters: description (what the new agent should do), name (optional agent name)
Schedules and reminders
Section titled “Schedules and reminders”See Schedules & Tasks for how scheduled tasks work end to end.
create_schedule
Section titled “create_schedule”Create a deferred task — a recurring schedule (cron-based) or a one-off task that fires once at a specific time. Supports verbatim reminders, natural-language instructions the agent carries out, data pipelines, and sandboxed scripts.
Key parameters: name, action (what to do), cron_expression (recurring) or fire_at (one-off), task_type (reminder, message, script, or pipe), notify_channel (where to deliver output)
update_schedule
Section titled “update_schedule”Modify an existing scheduled task — reschedule it, rename it, pause or resume it, or edit its instructions.
list_schedules
Section titled “list_schedules”List all scheduled tasks for the current agent, including timing and next fire time.
delete_schedule
Section titled “delete_schedule”Remove a scheduled task so it no longer runs.
Key parameters: schedule_id (the schedule to remove)
schedule_wakeup
Section titled “schedule_wakeup”Have the agent check back in after a set number of minutes — a lightweight “poke me later” for follow-ups within a conversation.
Waiting and polling
Section titled “Waiting and polling”These tools let an agent wait for something to happen without holding a conversation open.
poll_until
Section titled “poll_until”Poll an HTTP endpoint on an interval until a condition is met, then resume.
run_async
Section titled “run_async”Kick off a long-running tool operation in the background and pick up the result when it finishes.
wait_for_event
Section titled “wait_for_event”Subscribe to a platform event and resume when it fires.
list_continuations / cancel_continuation
Section titled “list_continuations / cancel_continuation”List or cancel the agent’s active polls and event waits.
Workflows and team management
Section titled “Workflows and team management”complete_workflow_step
Section titled “complete_workflow_step”Mark a step in a multi-step workflow as complete, optionally providing output data for the next step.
Key parameters: step_id, output (result data)
fail_workflow_step
Section titled “fail_workflow_step”Mark a workflow step as failed with a reason, so the workflow can handle the failure.
review_workflow_step
Section titled “review_workflow_step”Approve or reject a workflow step that is waiting on review. Available to the agent assigned as the step’s reviewer.
run_task
Section titled “run_task”Run a background task with its own retries and checkpointing, separate from the current conversation.
manage_team
Section titled “manage_team”A powerful tool with 40+ actions for managing your organisation. Actions include managing users, agents, teams, knowledge bases, integrations, and settings. This is also where agents call create_workflow, update_workflow, and validate_workflow when authoring workflows in chat.
Key parameters: action (the specific management action), plus action-specific parameters
Files and documents
Section titled “Files and documents”workspace
Section titled “workspace”The agent’s persistent file workspace — read, write, and organise working files that survive across conversations.
read_file
Section titled “read_file”Read the contents of an uploaded file. Supports documents, spreadsheets, and text files.
Key parameters: file_id
Manage files — list, retrieve, and share files associated with conversations or the organisation.
document
Section titled “document”Create and edit office documents — Word, Excel, PowerPoint, and PDF generation and assembly.
generate_pdf
Section titled “generate_pdf”Render content (Markdown or SVG) into a PDF file.
render_image
Section titled “render_image”Render an SVG into an image file.
split_pdf / assemble_pdf
Section titled “split_pdf / assemble_pdf”Split a large PDF into parts the agent can read, or merge an ordered list of workspace PDFs into a single file.
Code and development
Section titled “Code and development”Every agent can write and run code — these tools are always available.
code_execute
Section titled “code_execute”Run code in a persistent Python or JavaScript interpreter to perform calculations, data transformations, or custom logic during a conversation.
Key parameters: language (python or javascript), code (the code to run)
code_mode
Section titled “code_mode”Write a script that orchestrates many tool calls in one pass — useful for bulk operations that would otherwise take many conversational turns. Integration tools are callable from inside the script.
dev_tools
Section titled “dev_tools”Run shell commands and work with files in the agent’s sandbox environment.
sandbox_git / sprigr_git_push
Section titled “sandbox_git / sprigr_git_push”Work with git repositories in the sandbox and push changes to Sprigr-hosted repositories.
deep_task
Section titled “deep_task”Delegate a whole multi-step assignment (code, documents, data pipelines) to an autonomous coding agent that runs headless in the sandbox with shell and workspace access. See Deep Tasks for how these runs work, their budgets, and the write-access approval flow.
wordpress_edit
Section titled “wordpress_edit”Edit your organisation’s Sprigr-hosted WordPress site — the agent resolves the site automatically, so a request like “change my store’s homepage” just works.
Web and HTTP
Section titled “Web and HTTP”Browse websites and extract content. Supports navigating pages, clicking, filling forms, searching, and pulling information from public web pages.
Key parameters: action (for example navigate, find, click, fill, search, parse), url
http_request
Section titled “http_request”Make a direct HTTP request to an external API. Useful for services that do not have a dedicated integration. Outbound domains are restricted; the agent can ask you to approve new ones via request_outbound_access.
Key parameters: method (GET, POST, PUT, DELETE), url, headers, body
Email helpers
Section titled “Email helpers”list_email_templates / apply_email_template
Section titled “list_email_templates / apply_email_template”List your organisation’s saved email templates and apply one (including the configured signature) when composing.
enrich_contact
Section titled “enrich_contact”Look up a contact in your connected helpdesk or CRM to add context about who the agent is talking to. Returns a “no match” message when nothing is connected.
Reporting and support
Section titled “Reporting and support”create_report
Section titled “create_report”File a report with the Sprigr platform team — bug reports, feedback, or issues the agent hits while working. Available to every agent.
Key parameters: title, content
sprigr_inbox
Section titled “sprigr_inbox”Manage conversation threads — list, read, and organise the agent’s inbox.
sprigr_admin
Section titled “sprigr_admin”Perform administrative platform operations. Only useful to agents with elevated access.
Integration tools
Section titled “Integration tools”When integrations are connected to your organisation or a specific agent, additional tools become available. Below is a summary of tools provided by each built-in integration.
| Tool | Description |
|---|---|
gmail_search | Search emails by query, sender, date, or label |
gmail_read | Read the full content of a specific email |
gmail_send | Compose and send a new email |
gmail_delete | Delete an email |
gmail_download_attachment | Download an attachment from an email |
gmail_contacts_search | Search your Google contacts |
Google Calendar
Section titled “Google Calendar”| Tool | Description |
|---|---|
calendar_list_events | List calendar events for a date range |
calendar_create_event | Create a new calendar event |
calendar_update_event | Update an existing event |
calendar_cancel_event | Cancel an event |
calendar_check_availability | Check free/busy availability |
Google Drive
Section titled “Google Drive”| Tool | Description |
|---|---|
drive_list_files | List files in a folder |
drive_search_files | Search for files and folders |
drive_read_file | Read the content of a document or file |
drive_upload_file | Upload a file to Drive |
drive_create_folder | Create a folder |
drive_move_file | Move a file between folders |
drive_delete_file | Delete a file |
Google Sheets
Section titled “Google Sheets”| Tool | Description |
|---|---|
sheets_list_spreadsheets | List available spreadsheets |
sheets_read_range | Read a cell range |
sheets_append_row | Append a row to a sheet |
sheets_update_range | Update a cell range |
sheets_create_spreadsheet | Create a new spreadsheet |
sheets_search | Search within spreadsheets |
Google Docs
Section titled “Google Docs”| Tool | Description |
|---|---|
docs_read | Read a document |
docs_create_from_template | Create a document from a template |
docs_export_pdf | Export a document as PDF |
Outlook Mail
Section titled “Outlook Mail”| Tool | Description |
|---|---|
outlook_mail_search | Search Outlook emails |
outlook_mail_list | List emails in a folder |
outlook_mail_read | Read a specific email |
outlook_mail_send | Send a new email |
outlook_mail_reply | Reply to an email thread |
outlook_mail_forward | Forward an email |
outlook_mail_move | Move an email between folders |
outlook_mail_delete | Delete an email |
outlook_mail_download_attachment | Download an attachment |
outlook_contacts_search | Search your Outlook contacts |
Outlook Calendar
Section titled “Outlook Calendar”| Tool | Description |
|---|---|
outlook_calendar_list_events | List calendar events for a date range |
outlook_calendar_create_event | Create a new calendar event |
outlook_calendar_update_event | Update an existing event |
outlook_calendar_cancel_event | Cancel an event |
outlook_calendar_check_availability | Check free/busy availability |
outlook_calendar_find_meeting_times | Suggest meeting times that work for attendees |
OneDrive
Section titled “OneDrive”| Tool | Description |
|---|---|
onedrive_list_files | List files and folders |
onedrive_read_file | Read a file |
onedrive_upload_file | Upload a file |
onedrive_create_folder | Create a folder |
onedrive_copy_item | Copy a file or folder |
onedrive_delete_item | Delete a file or folder |
onedrive_list_shared_with_me | List items shared with you |
onedrive_read_shared_file | Read a shared file |
onedrive_excel_read_range | Read a range from an Excel workbook |
onedrive_excel_update_range | Update a range in an Excel workbook |
onedrive_excel_add_worksheet | Add a worksheet to a workbook |
onedrive_excel_search | Search within Excel workbooks |
Microsoft Teams
Section titled “Microsoft Teams”| Tool | Description |
|---|---|
teams_send_channel_message | Post a message to a Teams channel |
teams_send_chat_message | Send a message in a Teams chat |
GitHub
Section titled “GitHub”GitHub is a single github tool that takes an action parameter:
| Category | Actions |
|---|---|
| Repositories | list_repos, get_repo, read_file, create_or_update_file, search_code |
| Branches and commits | create_branch, list_branches, list_commits |
| Issues | list_issues, create_issue, update_issue, add_issue_comment |
| Pull requests | list_pull_requests, get_pull_request, create_pull_request, add_pull_request_comment |
Gorgias
Section titled “Gorgias”Gorgias is a single gorgias tool that takes an action parameter:
| Category | Actions |
|---|---|
| Tickets | list_tickets, get_ticket, create_ticket, update_ticket, reply_to_ticket |
| Customers | search_customers, get_customer |
| Tags | list_tags |
Replies default to internal notes for safety; the agent must explicitly choose a customer-facing reply.
Amazon Web Services is a single aws tool with around 30 actions covering common services:
| Category | Actions |
|---|---|
| EC2 | List, describe, start, stop, and reboot instances; read console output |
| Lambda | List and inspect functions, invoke, read logs and metrics, update config |
| S3 | List buckets, list objects, get and put objects |
| CloudWatch | List alarms, get metrics, query logs, create alarms |
| Cost Explorer | Get costs, forecasts, and savings recommendations |
| SSM | Run commands on managed instances and read output |
| IAM / STS | List users and roles, account summary, verify identity |
Destructive actions (stop, reboot, invoke, put, run command) require user confirmation, and the integration can be restricted to read-only access, specific regions, and specific services.
Google Cloud Platform is a single gcp tool with around 40 actions covering common services:
| Category | Actions |
|---|---|
| Compute Engine | List, describe, start, stop, and reset instances |
| Cloud Functions | List, describe, invoke, read logs, update config |
| Cloud Storage | List buckets, list objects, get, upload, and delete objects |
| Cloud Run | List and describe services, list revisions, read logs |
| BigQuery | List datasets and tables, run queries, get job results |
| Monitoring and Logging | Get metrics, list alert policies and uptime checks, query logs |
| Billing | Get billing info, budgets, and costs |
| IAM / GKE | List service accounts and roles, get policy, list clusters and workloads |
Like AWS, the GCP integration can be restricted to read-only access.
Marketplace apps and MCP servers
Section titled “Marketplace apps and MCP servers”Beyond the built-in integrations, agents gain tools from two other sources:
- Marketplace apps — Apps installed from the Sprigr marketplace add their own tools. For example, the Atlassian app adds
jira_search,jira_create_issue,jira_update_issue,jira_add_comment,jira_transition_issue,confluence_search,confluence_get_page,confluence_create_page, and more. Slack and Shopify are also delivered as marketplace apps. - MCP servers — Connecting a Model Context Protocol server registers every tool the server exposes, so any MCP-compatible service becomes available to your agents.
Next steps
Section titled “Next steps”- Creating Agents — Create an agent and assign it the tools it needs.
- Agent Settings — Configure integrations and tool access for each agent.
- Companion Agents — Learn about the companion-only
create_specialisttool. - Knowledge Bases — Understand how
sprigr_searchandsprigr_writeinteract with your knowledge bases.