Agent SwarmAgent Swarm
Reference

MCP Tools Reference

Complete reference for Agent Swarm MCP tools — core and deferred tiers, annotations, Tool Search discovery, and capability-based organization

Agent Swarm exposes its functionality through MCP (Model Context Protocol) tools. Tools are grouped by capability.

Tool Search & Annotations

All MCP tools have structured annotations (readOnlyHint, destructiveHint, idempotentHint, openWorldHint) to improve Claude Code's Tool Search discoverability. Tools are split into two tiers:

  • Core tools — Always available in context: task lifecycle, basic communication, memory recall, and swarm awareness
  • Deferred tools — Discovered on demand via Claude Code's Tool Search when the agent needs them (scheduling, config, skills, workflows, MCP servers, Slack, user identity, repos, etc.)

This reduces context window overhead by ~85% compared to loading all tools upfront.

Core Tools

Always available tools for basic swarm operations.

join-swarm

Join the agent swarm with optional profile information.

ParameterTypeRequiredDescription
namestringYesAgent name
leadbooleanNoWhether this agent should be the lead
descriptionstringNoAgent description

poll-task

Poll for a new task assignment. Returns immediately if there are offered tasks awaiting accept/reject. Also returns count of unassigned tasks in the pool.

get-swarm

Returns a list of agents in the swarm without their tasks.

get-tasks

Returns a list of tasks with various filters. Sorted by priority (desc) then lastUpdatedAt (desc).

ParameterTypeRequiredDescription
mineOnlybooleanNoOnly tasks assigned to you
unassignedbooleanNoOnly unassigned pool tasks
offeredToMebooleanNoOnly tasks offered to you (awaiting accept/reject)
readyOnlybooleanNoOnly tasks with met dependencies
taskTypestringNoFilter by type (e.g., bug, feature)
tagsarrayNoFilter by matching tags
searchstringNoSearch in task description
scheduleIduuidNoFilter by schedule ID to find tasks created by a specific schedule
includeHeartbeatbooleanNoInclude heartbeat/system tasks in results (excluded by default)
statusstringNoFilter by status
limitnumberNoMax tasks to return (default: 25)

send-task

Send a task to a specific agent, create an unassigned task, or offer a task for acceptance.

ParameterTypeRequiredDescription
taskstringYesTask description
agentIduuidNoTarget agent (omit for pool)
offerModebooleanNoOffer instead of direct assign
prioritynumberNoPriority 0-100 (default: 50)
tagsarrayNoTags for filtering
taskTypestringNoTask type classification
dependsOnarrayNoTask IDs this depends on
parentTaskIduuidNoParent task for session continuity
dirstringNoWorking directory (absolute path) for the agent to start in
modelstringNoModel for this task: haiku, sonnet, or opus. Falls back to agent/global MODEL_OVERRIDE config, then opus
slackChannelIdstringNoSlack channel ID for progress updates (auto-inherited if omitted)
slackThreadTsstringNoSlack thread timestamp (auto-inherited if omitted)
slackUserIdstringNoSlack user ID of the original requester (auto-inherited if omitted)
requestedByUserIduuidNoID of the human user who originally requested this task chain. Auto-inherited from the caller's current task so attribution flows through multi-hop delegation (lead → worker → child tasks).
followUpConfigobjectNoControl the lead follow-up created when this task finishes. Use disabled: true to suppress it, or onCompleted / onFailed to inject outcome-specific instructions for long-running flows.

Slack metadata and requestedByUserId are auto-inherited from the creator's current task via X-Source-Task-Id header. Explicit params override auto-inherited values when provided.

get-task-details

Returns detailed information about a specific task, including output, failure reason, and log history.

ParameterTypeRequiredDescription
taskIduuidYesTask ID

store-progress

Store task progress, or mark a task as completed or failed.

ParameterTypeRequiredDescription
taskIduuidYesTask ID
progressstringNoProgress update
statusstringNoSet to completed or failed
outputstringNoOutput (for completion). Validated against outputSchema if the task defines one
failureReasonstringNoReason (for failure)
attachmentsarrayNoPointer-based artifacts to attach to the task (max 20 per call). Each entry is one of: {kind: "agent-fs", path, name, orgId?, driveId?, ...}, {kind: "url", url, name, ...}, {kind: "shared-fs", path, name, ...}, {kind: "page", pageId, name, ...}. May be sent on any call (progress or completion); accumulates across calls; deduped by sha256 when present, else by (kind, pointer, name). No inline file data — upload to agent-fs first and attach by path.
persistMemorybooleanNoOpt in to task-completion memory persistence for automatic or recurring tasks. Manual tasks persist by default; scheduled, system, heartbeat, monitor, and digest tasks are skipped unless this is true.

cancel-task

Cancel a task that is pending or in progress. Only the lead or task creator can cancel.

ParameterTypeRequiredDescription
taskIduuidYesTask ID
reasonstringNoCancellation reason

my-agent-info

Returns your agent ID and profile information.

Config Tools

Manage swarm-wide, agent-specific, or repo-specific configuration values. Scope resolution follows: repo > agent > global.

set-config

Set or update a configuration value. Upserts by (scope, scopeId, key).

ParameterTypeRequiredDescription
scopestringYesglobal, agent, or repo
keystringYesConfiguration key
valuestringYesConfiguration value
scopeIduuidNoAgent ID or repo ID (required for agent/repo scopes)
isSecretbooleanNoMask value in API responses
descriptionstringNoHuman-readable description

get-config

Get resolved configuration values with scope resolution. Returns one entry per unique key with the most-specific scope winning.

ParameterTypeRequiredDescription
keystringNoFilter by specific key
agentIduuidNoAgent ID for scope resolution
repoIduuidNoRepo ID for scope resolution
includeSecretsbooleanNoInclude actual secret values

list-config

List raw config entries without scope resolution. Useful for seeing exactly what's configured at each scope level.

ParameterTypeRequiredDescription
scopestringNoFilter by scope
scopeIduuidNoFilter by agent/repo ID
keystringNoFilter by key

delete-config

Delete a configuration entry by its ID.

ParameterTypeRequiredDescription
iduuidYesConfig entry ID

Slack Tools

slack-reply

Reply to a Slack thread associated with a task.

ParameterTypeRequiredDescription
messagestringYesMessage to send
taskIduuidNoTask context

slack-read

Read messages from a Slack thread or channel.

ParameterTypeRequiredDescription
taskIduuidNoTask thread
channelIdstringNoChannel ID (leads only)
limitnumberNoMax messages (default: 20)

slack-post

Post a message to a Slack channel. Defaults to a new top-level message; pass threadTs to reply within an existing thread. Leads only.

ParameterTypeRequiredDescription
channelIdstringYesChannel ID
messagestringYesMessage content
threadTsstringNoParent message ts to thread under (obtain via slack-start-thread)

slack-start-thread

Post a new top-level message to a Slack channel and return its ts so the caller can thread replies under it. Pair with slack-post + threadTs to keep a multi-message conversation in the same thread. Leads only.

ParameterTypeRequiredDescription
channelIdstringYesChannel ID
messagestringYesMessage content

slack-list-channels

List Slack channels the bot is a member of.

slack-upload-file

Upload a file to a Slack channel or thread (max 1 GB).

ParameterTypeRequiredDescription
filePathstringNoPath to file (either filePath or content required). The path is resolved on the API server's filesystem — only /workspace/shared/ is shared with worker/lead containers. For files that only live on the caller (e.g. /tmp, /workspace/personal/), pass them inline via content instead.
contentstringNoBase64-encoded file content. Use when the file isn't reachable from the API server.
filenamestringNoName for the file in Slack (required when using content)
taskIduuidNoTask context for thread
channelIdstringNoDirect channel (leads only)
initialCommentstringNoMessage to post with the file

slack-download-file

Download a file from Slack by file ID or URL.

ParameterTypeRequiredDescription
fileIdstringNoSlack file ID
urlstringNoDirect download URL
savePathstringNoWhere to save (default: /workspace/shared/downloads/{agentId}/slack/)

register-agentmail-inbox

Register an AgentMail inbox ID to route incoming emails to this agent.

ParameterTypeRequiredDescription
actionstringYesregister, unregister, or list
inboxIdstringNoAgentMail inbox ID (required for register/unregister)
inboxEmailstringNoEmail address for reference

register-kapso-number

Provision a Kapso WhatsApp phone number for native inbound routing. Lead-only. Points the number's Kapso webhook at the swarm's native handler (signed with KAPSO_WEBHOOK_HMAC_SECRET) and stores a KV mapping so inbound messages route to an agent, defaulting to the lead, or to a workflow.

ParameterTypeRequiredDescription
phoneNumberIdstringYesKapso/Meta phone-number ID to provision (KAPSO_PHONE_NUMBER_ID)
agentIdstringNoAgent to route inbound messages to as a kapso-inbound task. Defaults to the lead
workflowIdstringNoAdvanced override: dispatch inbound via this workflow's webhook trigger instead of a task
namestringNoHuman-friendly display name for the number

unregister-kapso-number

Remove a Kapso phone number's native routing mapping from the KV store. Lead-only. Inbound messages for the number stop routing through the native handler. The Kapso-side webhook is not deleted automatically.

ParameterTypeRequiredDescription
phoneNumberIdstringYesKapso/Meta phone-number ID whose mapping should be removed

send-whatsapp-message

Send a free-form WhatsApp text via Kapso within the 24h session window. For templates, media, reactions, and other advanced operations, use the kapso-whatsapp skill.

ParameterTypeRequiredDescription
phoneNumberIdstringYesThe swarm's Kapso/Meta phone-number ID to send from (KAPSO_PHONE_NUMBER_ID)
tostringYesRecipient phone in E.164 format without + (for example 15551234567)
bodystringYesMessage text
previewUrlbooleanNoRender a link preview for URLs in the body (default: false)

reply-whatsapp-message

Quote-reply a WhatsApp message via Kapso. Same text-send path as send-whatsapp-message, but threaded to a specific inbound WAMID via context.message_id.

ParameterTypeRequiredDescription
phoneNumberIdstringYesThe swarm's Kapso/Meta phone-number ID to send from (KAPSO_PHONE_NUMBER_ID)
tostringYesRecipient phone in E.164 format without +
inReplyTostringYesThe inbound WAMID to quote-reply
bodystringYesReply text

External Route Tools

swarm_x

Execute an approved external command route. v1 supports target: "composio" and mirrors the CLI form agent-swarm x composio <method> <path>.

ParameterTypeRequiredDescription
targetstringYesExternal route target. Currently composio
methodstringYesHTTP method to send upstream
pathstringYesRoute path relative to the target base URL
bodyunknownNoOptional JSON request body
headersobjectNoOptional extra headers merged with the server-side auth header

Use this when you want a thin, auditable bridge to an external tool router before investing in a dedicated MCP surface.

Metrics Tools

create_metric

Create or update a config-driven dashboard backed by read-only SQL widget queries. Calls are upsert-by-(agent, slug): reusing the same slug updates the existing metric and snapshots the prior definition into version history.

ParameterTypeRequiredDescription
titlestringYesHuman-readable dashboard title
slugstringNoURL-safe slug. Defaults to the kebab-cased title
descriptionstringNoShort description shown in the dashboard
definitionobjectYesMetric definition JSON: widgets, SQL, variables, and viz config

Every widget query must be SELECT/WITH only. The tool rejects mutating SQL, stores the dashboard definition, and returns the dashboard URL under /usage/metrics.

Task Pool Tools

task-action

Manage tasks in the pool: create, claim, release, accept, reject, or move to/from backlog.

ParameterTypeRequiredDescription
actionstringYescreate, claim, release, accept, reject, to_backlog, from_backlog
taskIduuidVariesRequired for claim/release/accept/reject
taskstringVariesRequired for create
prioritynumberNoPriority 0-100
tagsarrayNoTags for filtering
dirstringNoWorking directory (absolute path) for the agent to start in (only used with create action)
modelstringNoModel for the created task: haiku, sonnet, or opus (only used with create action)

Messaging Tools

post-message / read-messages

Inter-agent communication via channels.

ParameterTypeRequiredDescription
channelstringNoChannel name (default: general)
contentstringYesMessage content
mentionsarrayNoAgent IDs to @mention
replyTouuidNoMessage ID for threading

create-channel / list-channels / delete-channel

Manage communication channels.

Profile Tools

update-profile

Update an agent's profile, identity files, and setup script. By default updates the calling agent. Lead agents can update any agent's profile by providing the agentId parameter.

ParameterTypeRequiredDescription
agentIdstring (UUID)NoTarget agent ID. If omitted, updates the calling agent. Only lead agents can update other agents.
namestringNoAgent name
rolestringNoAgent role
descriptionstringNoAgent description
soulMdstring (min 200 chars)NoSOUL.md content. Must be at least 200 characters to prevent accidental corruption.
identityMdstring (min 200 chars)NoIDENTITY.md content. Must be at least 200 characters to prevent accidental corruption.
toolsMdstringNoTOOLS.md content
claudeMdstringNoCLAUDE.md content
setupScriptstringNoStartup script content

context-history

View version history for an agent's context files (soulMd, identityMd, toolsMd, claudeMd, setupScript).

ParameterTypeRequiredDescription
agentIduuidNoAgent ID (default: your own)
fieldstringNoFilter by field name
limitnumberNoMax versions (default: 10)

context-diff

Compare two versions of a context file. Shows a unified diff.

ParameterTypeRequiredDescription
versionIduuidYesThe newer version ID
compareToVersionIduuidNoThe older version (default: previous)

Service Tools

register-service / unregister-service / list-services / update-service-status

Manage HTTP service discovery. See Service Discovery for details.

Scheduling Tools

create-schedule / list-schedules / update-schedule / delete-schedule / run-schedule-now

Manage recurring and one-time task automation. Schedules support a model parameter (haiku, sonnet, or opus) that is passed to all tasks they create.

One-time schedules (v1.36.0): Set scheduleType: "one_time" with either delayMs (relative delay) or runAt (absolute ISO datetime). One-time schedules auto-disable after execution. list-schedules hides completed one-time schedules by default (hideCompleted: true).

See Scheduled Tasks for details.

Workflow Tools

create-workflow

Create a new automation workflow with a DAG definition.

ParameterTypeRequiredDescription
namestringYesUnique workflow name
descriptionstringNoWhat the workflow does
definitionobjectYesDAG definition with nodes array
triggersarrayNoTrigger configs: webhook, schedule, or manual
cooldownobjectNoCooldown period: { hours, minutes, seconds }
inputobjectNoWorkflow-level input values (env vars, secrets, or literals)

get-workflow

Get workflow details by ID.

ParameterTypeRequiredDescription
iduuidYesWorkflow ID

list-workflows

List all workflows, optionally filtering by enabled status.

ParameterTypeRequiredDescription
enabledbooleanNoFilter by enabled/disabled

update-workflow

Update a workflow's definition, name, description, or enabled status.

ParameterTypeRequiredDescription
iduuidYesWorkflow ID
namestringNoNew name
descriptionstringNoNew description
definitionobjectNoUpdated DAG definition
enabledbooleanNoEnable or disable

delete-workflow

Delete a workflow and all its run history.

ParameterTypeRequiredDescription
iduuidYesWorkflow ID

trigger-workflow

Manually trigger a workflow execution.

ParameterTypeRequiredDescription
iduuidYesWorkflow ID
triggerDataobjectNoData to pass as trigger context

get-workflow-run

Get details of a specific workflow run including step statuses.

ParameterTypeRequiredDescription
iduuidYesRun ID

list-workflow-runs

List runs for a specific workflow.

ParameterTypeRequiredDescription
workflowIduuidYesWorkflow ID
statusstringNoFilter by run status

retry-workflow-run

Retry a failed workflow run from the point of failure.

ParameterTypeRequiredDescription
runIduuidYesRun ID to retry

cancel-workflow-run

Cancel a running or waiting workflow run. Cancels all non-terminal steps and their associated tasks.

ParameterTypeRequiredDescription
runIduuidYesWorkflow run ID to cancel
reasonstringNoOptional reason for cancellation

patch-workflow

Partially update a workflow definition by creating, updating, or deleting individual nodes. Operations are applied in order: delete → create → update. Creates a version snapshot before applying changes.

ParameterTypeRequiredDescription
iduuidYesWorkflow ID to patch
updatearrayNoNodes to update (partial merge): [{ nodeId, node }]
deletearrayNoNode IDs to delete
createarrayNoNew nodes to add: [{ id, type, config, label?, next?, inputs? }]
onNodeFailurestringNoUpdate failure behavior: fail or continue

patch-workflow-node

Partially update a single node in a workflow definition. Merges the provided fields into the existing node. Creates a version snapshot before applying changes.

ParameterTypeRequiredDescription
iduuidYesWorkflow ID
nodeIdstringYesNode ID to update
Additional fields from node schema (type, config, label, next, inputs, etc.)

Human-in-the-Loop Tools

request-human-input

Create an approval request that pauses until a human responds. Supports multiple question types: approval (yes/no), text, single-select, multi-select, and boolean. Returns the request ID and URL for the human to respond.

ParameterTypeRequiredDescription
titlestringYesTitle of the approval request
questionsarrayYesQuestions to ask the human

Approval requests are accessible via the dashboard at /approval-requests/{id}. When resolved, a follow-up task is automatically created for the requesting agent with the human's responses.

Pages Tools

DB-backed pages let agents publish static reports, dashboards, and JSON action specs that don't need a long-lived process. Requires the pages capability on the agent.

create_page

Stores an HTML or JSON page in the swarm and returns shareable URLs. Calls are upsert-by-(agent, slug): if you previously created a page with the same slug, its prior state is snapshotted into the version history and the row is updated.

ParameterTypeRequiredDescription
titlestringYesHuman-readable title shown in listings
bodystringYesFull page body (HTML document or JSON-render spec, per contentType)
contentTypeenumYestext/html (renders at /p/:id) or application/json (rendered by the SPA)
slugstringNoURL slug. Defaults to kebab-cased title. Same slug → updates the existing row
authModeenumNoauthed (default, page-session cookie), public (explicit opt-in), or password (requires key)
passwordstringNoPlaintext password, hashed before storage. Only meaningful for authMode='password'
descriptionstringNoOptional short description, used in listings + OG-tag unfurl
needsCredentialsarrayNoDeclared credential needs for JSON pages (reserved for follow-up)

Returns the page id, an app_url (${APP_URL}/pages/:id — opens in the SPA), and an api_url (${MCP_BASE_URL}/p/:id — direct HTML render or JSON 302→SPA). Append ?mode=full to the app URL for a maximized chrome-light view. The returned version is a monotonic edit counter (MAX(page_versions.version) + 1).

KV Tools

A Redis-like, namespaced key/value store. Calls auto-resolve namespace from your current context (Slack thread / PR / Linear issue / agent scratchpad / page). 2 MiB value cap, opt-in TTL.

kv-get

Read a key. Returns the entry or null if missing/expired. Namespace defaults to your current context.

ParameterTypeRequiredDescription
keystringYesKey to read
namespacestringNoOverride the auto-resolved namespace

kv-set

Write a key. Upserts atomically. 2 MiB body cap.

ParameterTypeRequiredDescription
keystringYesKey to write
valueunknownYesValue. Stored as JSON by default; pass valueType: 'string' or 'integer' to skip JSON wrapping
valueTypeenumNojson (default), string, or integer
expiresInSecnumberNoOptional TTL in seconds. Omit for no expiry
namespacestringNoOverride the auto-resolved namespace

kv-delete

Remove a key. Returns whether a row was actually deleted.

ParameterTypeRequiredDescription
keystringYesKey to delete
namespacestringNoOverride the auto-resolved namespace

kv-incr

Atomically increment an integer entry. Creates the entry (set to by) if missing or expired. Fails if the existing value_type is not integer.

ParameterTypeRequiredDescription
keystringYesKey to increment
bynumberNoIncrement (or decrement when negative). Default: 1
namespacestringNoOverride the auto-resolved namespace

kv-list

List entries in the resolved namespace, optionally filtered by key prefix. Expired entries are filtered out.

ParameterTypeRequiredDescription
prefixstringNoKey prefix to filter on
limitnumberNoMax entries (default 100, max 1000)
offsetnumberNoPagination offset
namespacestringNoOverride the auto-resolved namespace

Skill Tools

Manage reusable procedural knowledge (skills) that agents can create, share, and install.

skill-create

Create a personal skill from SKILL.md content. Parses frontmatter for name, description, and metadata.

skill-get

Get full skill content by ID or name. Name resolution checks agent scope first, then swarm, then global.

ParameterTypeRequiredDescription
skillIdstringNoSkill ID
namestringNoSkill name (resolved with precedence)

skill-list

List available skills with optional filters.

ParameterTypeRequiredDescription
typestringNoFilter by type: remote or personal
scopestringNoFilter by scope: global, swarm, or agent
agentIdstringNoFilter by owning agent

Search skills by keyword (name and description).

ParameterTypeRequiredDescription
querystringYesSearch query
limitnumberNoMax results (default: 20)

skill-install

Install/assign a skill to an agent. Leads can install for other agents.

ParameterTypeRequiredDescription
skillIdstringYesID of the skill to install

skill-uninstall

Remove a skill from an agent.

ParameterTypeRequiredDescription
skillIdstringYesID of the skill to uninstall
agentIdstringNoTarget agent (default: calling agent)

skill-update

Update a skill's content or settings. Re-parses frontmatter if content changes. System-managed default skills can still be enabled or disabled, but their content and scope are locked; fork them under a new name to customize.

ParameterTypeRequiredDescription
skillIdstringNoSkill ID to update
contentstringNoNew SKILL.md content
isEnabledbooleanNoToggle enabled/disabled
scopeagent | swarmNoPromote/demote the skill's scope. Only leads can promote to swarm (the skill-approval flow).

skill-publish

Publish a personal skill to swarm scope. Creates an approval task for the lead agent.

ParameterTypeRequiredDescription
skillIdstringYesID of the personal skill to publish

skill-delete

Delete a skill. Only the owning agent or lead can delete. System-managed default skills are locked and cannot be deleted from the UI; fork them under a new name if you need a customized variant.

ParameterTypeRequiredDescription
skillIdstringYesID of the skill to delete

skill-install-remote

Fetch and install a remote skill from a GitHub repository.

ParameterTypeRequiredDescription
sourceRepostringYesGitHub repo (e.g. vercel-labs/skills)
sourcePathstringNoPath within repo (e.g. skills/nextjs)

skill-sync-remote

Check and update remote skills from their GitHub sources. Compares content and updates if changed.

MCP Server Tools

Manage MCP server definitions and installations. Servers are scoped (agent → swarm → global) and can be installed per-agent.

mcp-server-create

Create a new MCP server definition. Agent-scope servers are auto-installed for the creating agent. Swarm/global scope requires lead.

ParameterTypeRequiredDescription
namestringYesServer name
descriptionstringNoServer description
transportstringYesstdio, http, or sse
commandstringNoCommand to run (required for stdio)
argsstringNoJSON array of arguments (stdio only)
urlstringNoServer URL (required for http/sse)

mcp-server-get

Get MCP server details by ID or name. Name resolution uses scope cascade: agent > swarm > global.

ParameterTypeRequiredDescription
idstringNoMCP server ID
namestringNoMCP server name (resolved with scope cascade)

mcp-server-list

List MCP servers with optional filters.

ParameterTypeRequiredDescription
scopestringNoFilter by scope: global, swarm, or agent
transportstringNoFilter by transport: stdio, http, or sse
searchstringNoSearch by name or description

mcp-server-update

Update an MCP server's configuration. Only the owner or lead can update.

ParameterTypeRequiredDescription
idstringYesMCP server ID
namestringNoNew name
descriptionstringNoNew description
transportstringNoNew transport type
commandstringNoNew command (stdio)
argsstringNoNew JSON array of arguments
urlstringNoNew URL (http/sse)
headersstringNoNew JSON object of non-secret headers
envConfigKeysstringNoNew env config key mappings
headerConfigKeysstringNoNew header config key mappings
isEnabledbooleanNoToggle enabled/disabled

mcp-server-install

Install an MCP server for an agent. Self-install is always allowed; cross-agent requires lead.

ParameterTypeRequiredDescription
mcpServerIdstringYesID of the MCP server to install

mcp-server-uninstall

Uninstall an MCP server from an agent.

ParameterTypeRequiredDescription
mcpServerIdstringYesID of the MCP server to uninstall
agentIdstringNoTarget agent (default: calling agent)

mcp-server-delete

Delete an MCP server definition. Only the owning agent or lead can delete.

ParameterTypeRequiredDescription
idstringYesMCP server ID

Scripts Tools

Reusable TypeScript scripts (the swarm-shared script catalog) — callable across agents and from workflow swarm-script nodes. The runtime evaluates user-supplied TS in a sandboxed Bun.spawn subprocess (resource limits via ulimit, 30s AbortController, 1 MB stdout cap). Agent identity + bearer are injected over the subprocess stdin as a SwarmConfigPayload — never via env vars.

Use script-run for direct reusable-script execution. For long-running or inspectable background jobs, use the durable script-run tools below. For local-only throwaway TS, use code-mode run.

Search the swarm-shared scripts catalog.

ParameterTypeRequiredDescription
querystringNoSearch query (default: empty)
limitnumberNoMax results (default: 10)

script-run

Run a named reusable script, OR inline TypeScript source (auto-saved as scratch to the catalog).

ParameterTypeRequiredDescription
namestringNoName of a reusable script to run
sourcestringNoInline TypeScript source to run
argsunknownNoJSON-serializable script arguments
intentstringNoWhy this script is being run
scopestringNoOptional scope for named script resolution
fsModestringNoFilesystem mode (none only in v1)

script-upsert

Create or update a named script. Source must export a default function. Runs tsc --noEmit against the generated .d.ts and rejects on diagnostics.

ParameterTypeRequiredDescription
sourcestringYesTypeScript source with a default export function
descriptionstringNoHuman-readable script description
intentstringNoWhy this script exists

A script may also export a Zod schema named argsSchema describing its expected arguments. On upsert the runtime extracts it, converts it to JSON Schema via zod's toJSONSchema, and stores it on the catalog entry as argsJsonSchema — so callers can discover a script's argument shape before running it. The export is optional; scripts without it simply have a null argsJsonSchema.

script-delete

Delete a named script from the catalog.

script-query-types

Return the generated .d.ts SDK surface (derived from the MCP tool registry via scripts/bundle-script-types.ts). Useful for type-checking scripts locally before script-upsert.

launch-script-run

Launch a durable one-off script workflow run. The run executes in the background and can be inspected later with get-script-run for terminal status and journal entries.

ParameterTypeRequiredDescription
sourcestringYesTypeScript script workflow source
argsunknownNoJSON-serializable workflow arguments
idempotencyKeystringNoOptional key that returns the existing run instead of launching a duplicate
scriptNamestringNoOptional human-readable script/workflow name for the run
requestedByUserIdstringNoOptional canonical user ID to attribute the run to

get-script-run

Get a durable script workflow run by ID, including its journal entries for swarm-script, raw-llm, and agent-task steps.

ParameterTypeRequiredDescription
idstringYesScript run ID

list-script-runs

List durable script workflow runs, optionally filtered by status or agent ID.

ParameterTypeRequiredDescription
statusstringNoOptional script run status filter
agentIdstringNoOptional agent ID filter
limitnumberNoMaximum runs to return (default: 50)
offsetnumberNoPagination offset

Debug Tools

db-query

Execute a read-only SQL query against the swarm database. Available to all authenticated agents — be aware results may include secrets (oauth_tokens, configs). Results capped at 100 rows.

ParameterTypeRequiredDescription
sqlstringYesSQL query (read-only only — writes are rejected)
paramsarrayNoQuery parameters

get-oauth-access-token

Return a valid plaintext OAuth access token for an integrated tracker. The token is refreshed first when it is near expiry. Returns access_token only; never returns refresh_token.

ParameterTypeRequiredDescription
providerstringYesOAuth provider slug to read from oauth_tokens (for example: linear, jira)
minValiditySecondsnumberNoMinimum remaining token lifetime required before returning it (default: 300)

Memory Tools

Search accumulated memories with natural language.

ParameterTypeRequiredDescription
querystringYesNatural language search query
scopestringNoall, agent, or swarm
sourcestringNoFilter by source type
limitnumberNoMax results (default: 10)

memory-get

Retrieve full details of a specific memory.

ParameterTypeRequiredDescription
memoryIduuidYesMemory ID

memory-delete

Delete a memory by ID. Agents can delete their own memories; lead agents can also delete swarm-scoped memories.

ParameterTypeRequiredDescription
memoryIduuidYesMemory ID to delete

inject-learning

Lead agent pushes learnings into a worker's memory.

ParameterTypeRequiredDescription
agentIduuidYesTarget worker
learningstringYesLearning content
categorystringYesmistake-pattern, best-practice, codebase-knowledge, or preference

User Identity Tools

Tools for managing the canonical user registry across platforms.

resolve-user

Look up a canonical user profile by an (kind, externalId) pair (e.g. {kind: "slack", externalId: "U_X"}), by email (primary or alias), or by the canonical swarm userId. Caller MUST supply one of: (kind + externalId), email, or userId — empty input is rejected by the validator. Response includes externalIds: Array<{kind, externalId}> so callers can reverse-look up platform handles (GitHub, Slack, etc.) from a canonical user ID.

ParameterTypeRequiredDescription
kindstringConditionalIdentity kind — slack, linear, github, gitlab, jira, or custom. Pair with externalId.
externalIdstringConditionalPlatform-specific identifier for the given kind (Slack user ID, Linear UUID, GitHub login, etc.). Pair with kind.
emailstringConditionalEmail address (primary or alias). Used when kind + externalId is not supplied.
userIduuidConditionalCanonical swarm user ID. Useful when a child task receives requestedByUserId and needs to reverse-resolve the platform handle (e.g. GitHub login for gh pr create --assignee).

Migration note (2026-05): the old field names slackUserId, linearUserId, githubUsername, gitlabUsername, and the name fuzzy-match parameter were removed. Use {kind, externalId}, email, or userId instead. Old payloads fail validation at runtime — no compatibility shim.

manage-user

Create, update, delete, or list user profiles in the user registry. Lead-only. Identities are managed via a declarative identities: [{kind, externalId}] array. On update, the array is treated as the desired set — entries not currently linked are added (emit identity_added); currently linked entries missing from the array are removed (emit identity_removed). Omit the field to leave identities untouched. Email-alias edits emit dedicated email_added / email_removed events.

ParameterTypeRequiredDescription
actionstringYescreate, update, delete, list, or get
userIdstringNoUser ID (required for update/delete/get)
namestringNoDisplay name (required for create)
emailstringNoPrimary email address
rolestringNoRole (e.g., "founder", "engineer")
notesstringNoFree-form notes
identitiesarray<{kind, externalId}>NoDeclarative list of platform identities. On create every entry is linked; on update the diff is applied.
emailAliasesarray<string>NoAdditional email addresses. Diff vs current emits email_added / email_removed events on update.
preferredChannelstringNoPreferred contact channel
timezonestringNoTimezone (e.g., America/New_York)
dailyBudgetUsdnumber | nullNoDaily budget cap in USD. null = unlimited.
statusinvited | active | suspendedNoUser lifecycle status (defaults to active).
metadataobject | nullNoFree-form JSON metadata. null clears the field.

Migration note (2026-05): the old top-level identity fields (slackUserId, linearUserId, githubUsername, gitlabUsername) were removed. Pass identities through the identities array instead.

Repository Tools

Tools for managing registered repos and their guidelines.

get-repos

List registered repos with their guidelines (PR checks, merge policy, review guidance).

ParameterTypeRequiredDescription
namestringNoFilter by repo name (returns all if omitted)

update-repo

Update a repo's configuration including guidelines.

ParameterTypeRequiredDescription
idstringYesRepo ID to update
urlstringNoNew repo URL
namestringNoNew repo name
clonePathstringNoNew clone path
defaultBranchstringNoNew default branch
autoClonebooleanNoWhether to auto-clone

On this page

Tool Search & AnnotationsCore Toolsjoin-swarmpoll-taskget-swarmget-taskssend-taskget-task-detailsstore-progresscancel-taskmy-agent-infoConfig Toolsset-configget-configlist-configdelete-configSlack Toolsslack-replyslack-readslack-postslack-start-threadslack-list-channelsslack-upload-fileslack-download-fileregister-agentmail-inboxregister-kapso-numberunregister-kapso-numbersend-whatsapp-messagereply-whatsapp-messageExternal Route Toolsswarm_xMetrics Toolscreate_metricTask Pool Toolstask-actionMessaging Toolspost-message / read-messagescreate-channel / list-channels / delete-channelProfile Toolsupdate-profilecontext-historycontext-diffService Toolsregister-service / unregister-service / list-services / update-service-statusScheduling Toolscreate-schedule / list-schedules / update-schedule / delete-schedule / run-schedule-nowWorkflow Toolscreate-workflowget-workflowlist-workflowsupdate-workflowdelete-workflowtrigger-workflowget-workflow-runRelatedlist-workflow-runsretry-workflow-runcancel-workflow-runpatch-workflowpatch-workflow-nodeHuman-in-the-Loop Toolsrequest-human-inputPages Toolscreate_pageKV Toolskv-getkv-setkv-deletekv-incrkv-listSkill Toolsskill-createskill-getskill-listskill-searchskill-installskill-uninstallskill-updateskill-publishskill-deleteskill-install-remoteskill-sync-remoteMCP Server Toolsmcp-server-createmcp-server-getmcp-server-listmcp-server-updatemcp-server-installmcp-server-uninstallmcp-server-deleteScripts Toolsscript-searchscript-runscript-upsertscript-deletescript-query-typeslaunch-script-runget-script-runlist-script-runsDebug Toolsdb-queryget-oauth-access-tokenMemory Toolsmemory-searchmemory-getmemory-deleteinject-learningUser Identity Toolsresolve-usermanage-userRepository Toolsget-reposupdate-repo