Agent tool reference

Ask for the result you want; the agent combines these capabilities. The reference lists 48 built-in tools and three additional outbound-call tools available with PrismVox. Settings → Tools shows what your session can use; administrator policy and connected services affect availability.

Download the tool schemas (JSON) →

Parameters below retain their API names. Required means required by the schema; individual actions can require additional fields. The downloadable JSON includes detailed English parameter descriptions. Credentials belong in the secure form, not in chat or example commands.

Files and execution

exec_command

Run a shell command inside the execution workspace. command contains the complete command; files and installed dependencies belong to that environment.

Parameters
NameTypeRequiredAllowed values
commandstringYes—
Example request
Run the project’s existing checks and explain any failures.

install_packages

Install workspace dependencies with the selected package manager and a package-name list. This does not install software on your laptop.

Parameters
NameTypeRequiredAllowed values
managerstringYesapt, pip
packagesstringYes—
Example request
Install the Python packages needed to read the spreadsheet I uploaded.

list_files

List a workspace directory. Use path to inspect the location before changing its files.

Parameters
NameTypeRequiredAllowed values
pathstringNo—
Example request
Show me the files in the reports folder.

read_file

Read a workspace file by path, including the current content needed before an edit.

Parameters
NameTypeRequiredAllowed values
pathstringYes—
Example request
Read reports/summary.md before changing it.

write_file

Create or replace the content of a workspace file. An existing file is overwritten; use edit_file for a targeted change.

Parameters
NameTypeRequiredAllowed values
contentstringYes—
pathstringYes—
Example request
Save this report as reports/summary.md.

edit_file

Replace exact old_text with new_text in a UTF-8 file. Read first; a single match is required unless replace_all is true. Empty replacement text deletes the match.

Parameters
NameTypeRequiredAllowed values
new_textstringYes—
old_textstringYes—
pathstringYes—
replace_allbooleanNo—
Example request
Change the report’s heading without rewriting the rest.

delete_file

Delete the file identified by path, on your request. Check the file and its consumers before deleting persistent data.

Parameters
NameTypeRequiredAllowed values
pathstringYes—
Example request
Delete the temporary export I identified, keeping the source data.

wget

Download a remote file directly to a workspace path. Prefer this for saving an original document or archive without copying it through chat.

Parameters
NameTypeRequiredAllowed values
pathstringYes—
urlstringYes—
Example request
Download the document at this URL into the workspace.

workspace_history

List recent recorded file changes, with commit identifiers. limit controls how many entries are returned.

Parameters
NameTypeRequiredAllowed values
limitintegerNo—
Example request
Show the recent changes to the workspace files.

workspace_restore

Restore one path from a commit found in workspace_history. The restoration is recorded as a new change; this does not restore the database or Docker volumes.

Parameters
NameTypeRequiredAllowed values
commitstringYes—
pathstringYes—
Example request
Restore that file from the version we selected in the history.

Widgets, services and resources

widget

Create, update, list or remove dashboard widgets. content is self-contained HTML; resources links their backend dependencies. Sharing actions publish, browse or copy group widgets; description explains a publication.

Parameters
NameTypeRequiredAllowed values
actionstringYesadd, update, remove, list, list_shared, add_shared, share, unshare
colsintegerNo—
contentstringNo—
descriptionstringNo—
groupstringNo—
heightintegerNo—
idstringNo—
kindstringNo—
resourcesarrayNo—
titlestringNo—
Example request
Add a filter to this tracker and keep the existing records.

resources

Inspect dependencies, link dedicated resources to a widget and preview cleanup. Use exact returned IDs. cleanup is a preview unless dry_run=false; applying cleanup needs your explicit request. Shared consumers protect resources.

Parameters
NameTypeRequiredAllowed values
actionstringYeslist, link, cleanup
allbooleanNo—
dry_runbooleanNo—
idsarrayNo—
offsetintegerNo—
widgetstringNo—
Example request
Preview the cleanup for this old workspace and show what would be kept.

docker_run

Start a service from image, name and its internal port; purpose explains what it serves. Deployment Docker mode and permissions determine where it runs. This is useful for a real service behind a widget.

Parameters
NameTypeRequiredAllowed values
commandstringNo—
envobjectNo—
extra_portsarrayNo—
gpubooleanNo—
imagestringYes—
namestringYes—
portintegerYes—
purposestringNo—
volumesarrayNo—
Example request
Deploy the HTTP service this dashboard needs and connect its interface here.

docker_manage

List, inspect logs, execute a command in or stop managed containers. Select action and the service name; stopping a service does not erase all persistent data.

Parameters
NameTypeRequiredAllowed values
actionstringYesps, list, logs, exec, stop
commandstringNo—
namestringNo—
tailintegerNo—
Example request
Read the recent logs of the monitoring service.

docker_compose

Operate a multi-service application from a Compose file already written in the workspace. file identifies it; action chooses up, down, inspection or execution. Review persistent volumes separately.

Parameters
NameTypeRequiredAllowed values
actionstringYesup, down, ps, logs, restart, exec
commandstringNo—
filestringYes—
projectstringNo—
servicestringNo—
tailintegerNo—
Example request
Start the application from the Compose file we prepared in the workspace.

register_tool

Register a reusable Python backend tool from code and its TOOL metadata. Its declared parameters become callable by the agent and widgets. Store credentials in secrets rather than script source.

Parameters
NameTypeRequiredAllowed values
codestringYes—
Example request
Make this data-fetching script a reusable tool for the dashboard.

list_tools

List available custom tools and their usage information before reusing or changing them. This is distinct from the complete built-in catalogue on this page.

No parameters.

Example request
Which custom tools can we reuse for this request?

show_in_editor

Open a workspace text file in Prism’s file editor. This editor is separate from the Notes, email, task and event forms handled by editor.

Parameters
NameTypeRequiredAllowed values
pathstringYes—
Example request
Open the generated script in the file editor.

Web and browser

http_request

Send an HTTP request with method, URL, optional headers and body. Use it for an API response; use wget when the goal is saving a remote file unchanged.

Parameters
NameTypeRequiredAllowed values
bodystringNo—
headersobjectNo—
methodstringNo—
urlstringYes—
Example request
Query this API and show the fields useful for my widget.

deep_research

Investigate question through several research rounds. max_rounds bounds that process; larger investigations take longer and make more model/tool calls.

Parameters
NameTypeRequiredAllowed values
max_roundsintegerNo—
questionstringYes—
Example request
Research the available approaches and give me a sourced comparison.

browser_get

Open a URL in the server-side browser and inspect the rendered page. An optional script can inspect its state; this is not your signed-in personal browser.

Parameters
NameTypeRequiredAllowed values
scriptstringNo—
urlstringYes—
Example request
Open this page and inspect what is actually rendered.

browser_act

Interact with a web page using the browser action list. Useful for forms, clicks and checks that require a rendered interface. Authentication and reachable hosts still depend on that browser environment.

Parameters
NameTypeRequiredAllowed values
actionsarrayYes—
urlstringNo—
Example request
Test the form we built with fictional data.

add_attachment

Attach an existing workspace file to the conversation so you can download it. path must identify the completed file.

Parameters
NameTypeRequiredAllowed values
pathstringYes—
Example request
Attach the finished CSV so I can download it.

Personal apps and open forms

editor

Open, read or update a note, email composer, task or event form. Read its current revision before updating, including unsaved text. Notes save immediately; other forms await user save/send. This tool never sends mail.

Parameters
NameTypeRequiredAllowed values
actionstringYesopen, read, update
all_daybooleanNo—
appstringNo—
bodystringNo—
descriptionstringNo—
duestringNo—
endstringNo—
folderstringNo—
locationstringNo—
offsetintegerNo—
prioritystringNolow, normal, high
revisionstringNo—
startstringNo—
subjectstringNo—
tagsstringNo—
titlestringNo—
tostringNo—
uidintegerNo—
Example request
Improve the open email draft and leave it for my review.

email

Connect, read, search, send and organize mail, folders and inbox rules. UIDs belong to a folder; use returned IDs and exact folder names. Use password_secret for credentials, and rule_preview before applying a new rule.

Parameters
NameTypeRequiredAllowed values
actionstringYesconfig, list, read, search, send, reply, folders, create_folder, rename_folder, delete_folder, move, archive, trash, mark_read, mark_unread, rules, rule_save, rule_delete, rule_preview, rules_apply
bodystringNo—
enabledbooleanNo—
folderstringNo—
fromstringNo—
imap_hoststringNo—
imap_portintegerNo—
insecurebooleanNo—
limitintegerNo—
list_limitintegerNo—
namestringNo—
offsetintegerNo—
passwordstringNo—
password_secretstringNo—
querystringNo—
rule_actionstringNomove, mark_read
rule_containsstringNo—
rule_fieldstringNofrom, to, subject
securitystringNossl, starttls
smtp_hoststringNo—
smtp_portintegerNo—
subjectstringNo—
targetstringNo—
tostringNo—
uidintegerNo—
userstringNo—
Example request
Preview a rule moving this sender’s mail to the chosen folder.

note

Create, list, update, delete or share Markdown notes. An omitted update field is preserved; an empty body clears it. For the note currently being edited, editor includes unsaved state.

Parameters
NameTypeRequiredAllowed values
actionstringYesadd, list, update, delete, share, unshare
bodystringNo—
idstringNo—
tagsstringNo—
titlestringNo—
Example request
Create a meeting note with these decisions and action owners.

task

Create, filter, update, complete, reopen or delete personal tasks. Use an ID from list; due and priority describe deadlines and urgency. Scheduled automation jobs are separate.

Parameters
NameTypeRequiredAllowed values
actionstringYesadd, update, list, done, reopen, delete
duestringNo—
filterstringNoall, today, overdue, upcoming, high
idstringNo—
include_donebooleanNo—
prioritystringNolow, normal, high
querystringNo—
titlestringNo—
Example request
List overdue tasks and mark the selected one complete.

calendar

List, create, update or delete events on the active calendar source. start/end and all_day determine timing; an all-day end date is exclusive.

Parameters
NameTypeRequiredAllowed values
actionstringYesadd, update, list, delete
all_daybooleanNo—
descriptionstringNo—
endstringNo—
fromstringNo—
idstringNo—
locationstringNo—
startstringNo—
titlestringNo—
tostringNo—
Example request
Create a one-hour review tomorrow at 10 in my timezone.

pim_source

Inspect or change calendar, task and Notes sources. CalDAV and Todoist use stored secret names and test connections; Google/Microsoft consent remains in the browser. A vault path is inside the server container.

Parameters
NameTypeRequiredAllowed values
actionstringYesstatus, set, connect_caldav, disconnect_caldav, connect_todoist, disconnect_todoist, set_notes_vault, use_builtin_notes
calendarstringNoauto, local, caldav, google, microsoft
event_pathstringNo—
password_secretstringNo—
pathstringNo—
task_pathstringNo—
tasksstringNoauto, local, caldav, todoist
token_secretstringNo—
urlstringNo—
userstringNo—
Example request
Use the connected Todoist account for my tasks.

Knowledge, memory and procedures

rag_ingest

Index one workspace file through source_path, or supplied content, into collection. Use one file per call; configured embeddings are required.

Parameters
NameTypeRequiredAllowed values
collectionstringYes—
contentstringNo—
sourcestringNo—
source_pathstringNo—
Example request
Index the uploaded manual into product-manual.

rag_manage

List collections/documents, describe a collection or delete selected content. Descriptions explain when to search. Shared-mode changes require group administration rights.

Parameters
NameTypeRequiredAllowed values
actionstringYeslist, delete, describe
collectionstringNo—
descriptionstringNo—
documentstringNo—
Example request
Show the documents in this collection before we remove the obsolete one.

save_user_info

Remember a user fact under topic and content, such as a preference. This is personal memory, not a reference document collection.

Parameters
NameTypeRequiredAllowed values
contentstringYes—
topicstringYes—
Example request
Remember that I prefer short reports with action items first.

save_learning

Save a useful learned fact or lesson with a title and content for later retrieval. Use skill for a structured reusable procedure.

Parameters
NameTypeRequiredAllowed values
contentstringYes—
titlestringYes—
Example request
Save the cause and fix of the error we just resolved.

search_history

Find relevant saved conversation history with query and an optional limit. Results are bounded and cannot reconstruct details that were never saved.

Parameters
NameTypeRequiredAllowed values
limitintegerNo—
querystringYes—
Example request
Find our earlier discussion about the export format.

skill

Store, retrieve, update or delete a reusable procedure. name, description, when_to_use and body explain when and how to apply it. Skills guide tool use; they do not grant new permissions.

Parameters
NameTypeRequiredAllowed values
actionstringYesadd, save, update, get, list, delete
bodystringNo—
descriptionstringNo—
namestringNo—
when_to_usestringNo—
Example request
Save this validated workflow as a reusable Skill.

Automation and delegation

cron

Create, list, update, pause or remove a scheduled workspace command. schedule is a cron expression; command is executed in the workspace and description explains its purpose. New schedules use the applicable user timezone.

Parameters
NameTypeRequiredAllowed values
actionstringYeslist, add, update, remove, enable, disable
commandstringNo—
descriptionstringNo—
namestringNo—
schedulestringNo—
Example request
Refresh the dashboard data every thirty minutes with the script we tested.

webhook

Create or manage an incoming HTTP trigger for the agent. prompt can include {{content}}; session chooses the conversation and respond waits synchronously. Keep the generated URL/token private.

Parameters
NameTypeRequiredAllowed values
actionstringYeslist, add, update, remove
deliverstringNotelegram, slack, webex
enabledbooleanNo—
idstringNo—
modelstringNo—
namestringNo—
promptstringNo—
respondbooleanNo—
sessionstringNo—
Example request
Create a webhook that summarizes monitoring alerts in a dedicated conversation.

notify

Show a notification with message, optional title, level and delay. A local notification is not proof that an external recipient received an email or chat message.

Parameters
NameTypeRequiredAllowed values
delay_secondsintegerNo—
levelstringNoinfo, success, warning, error
messagestringNo—
titlestringYes—
Example request
Notify me when this export is ready.

subagent

Delegate an independent bounded task, inspect its status, wait or cancel. Helpers share the model, workspace, permissions and task budget; they cannot delegate again. The parent collects results.

Parameters
NameTypeRequiredAllowed values
actionstringYesspawn, status, wait, cancel
contextstringNo—
idstringNo—
taskstringNo—
Example request
Delegate the independent checks, keep the file edits separate, then combine the results.

Connections and agent settings

mcp

List, connect, refresh, toggle or remove MCP servers. Use a stored auth_secret for Bearer authentication. Shared-mode changes require a group admin; a new OAuth grant needs browser consent.

Parameters
NameTypeRequiredAllowed values
actionstringYeslist, add, refresh, remove, enable, disable
auth_secretstringNo—
namestringNo—
urlstringNo—
Example request
Refresh this MCP server after its update.

request_secret

Open a secure credential form using name and description. The value is stored without being pasted into chat; subsequent tools refer to its name.

Parameters
NameTypeRequiredAllowed values
descriptionstringYes—
namestringYes—
Example request
Ask me securely for the credential needed by this integration.

secrets

List secret names, delete one on request or share a personal secret with an eligible group. Values are not returned to the model by listing.

Parameters
NameTypeRequiredAllowed values
actionstringYeslist, delete, share
groupstringNo—
namestringNo—
Example request
List the available secret names without showing their values.

channel

Inspect channel connections, connect a Telegram bot with token_secret or unlink its chat. Slack and group Webex administration use their respective settings screens.

Parameters
NameTypeRequiredAllowed values
actionstringYesstatus, telegram_connect, telegram_unlink
token_secretstringNo—
Example request
Guide me through connecting my personal Telegram bot.

agent_settings

Read/change personal agent behavior or manage permitted AI sources and model settings. Keys are stored secret names; embedding reindexing requires agreement. Deployment AI changes are global-admin-only in shared mode.

Parameters
NameTypeRequiredAllowed values
actionstringYesget, set, ai_get, ai_set, ai_test, ai_models, ai_reset, ai_embedding_models, ai_embedding_test, ai_source_set, ai_source_remove, ai_source_default, ai_source_models, ai_source_test, ai_model_get, ai_model_set
base_urlstringNo—
chat_visionbooleanNo—
context_windowintegerNo—
embedding_base_urlstringNo—
embedding_key_secretstringNo—
embedding_modelstringNo—
embedding_providerstringNoopenai, ollama, other
embedding_source_idstringNo—
embedding_use_same_providerbooleanNo—
key_secretstringNo—
lean_promptbooleanNo—
make_defaultbooleanNo—
max_iterationsintegerNo—
modelstringNo—
model_visionstringNoauto, yes, no
namestringNo—
personalitystringNo—
prompt_profilestringNoguided, standard, minimal
providerstringNoopenai, anthropic, ollama, other
reasoning_effortstringNolow, medium, high, xhigh, default
reindexbooleanNo—
source_idstringNo—
source_namestringNo—
thinkingbooleanNo—
timezonestringNo—
Example request
Show the configured AI sources and the current context setting for this model.

update_system_prompt

Change the personality for this dashboard workspace. Use agent_settings for the default personality across workspaces. Neither overrides platform access rules.

Parameters
NameTypeRequiredAllowed values
personalitystringYes—
Example request
In this workspace, focus on tracking my maintenance work.

prism_help

Read Prism’s embedded help by topic, or get the topic index and current connection status. Ask the agent where a setting is or how to use a capability.

Parameters
NameTypeRequiredAllowed values
topicstringNo—
Example request
Where do I configure my calendar, and is one connected?

When PrismVox is connected

place_call

Queue an outbound phone mission using contact_name or phone_number and a self-contained mission. Only the supplied mission is given to the calling agent; scheduling a call is not evidence it succeeded.

Parameters
NameTypeRequiredAllowed values
contact_namestringNo—
missionstringYes—
phone_numberstringNo—
Example request
Call the test contact and ask for tomorrow’s opening hours; do not make a booking.

list_calls

Inspect queued and recent outbound calls and read their summaries. done means the call ended, not necessarily that the requested outcome was obtained.

No parameters.

Example request
How did the last outbound mission go? Read its actual outcome.

cancel_call

Cancel a still-pending outbound call using call_id returned by list_calls. It cannot cancel a call already being dialed.

Parameters
NameTypeRequiredAllowed values
call_idintegerYes—
Example request
Cancel the pending call we scheduled.

Bundled capture analysis: pcap

The supplied protected Python tool pcap reads a capture already in the workspace using tshark. It lists SIP calls, reads messages and SDP, applies display filters or produces a packet timeline. It needs path; mode selects calls, messages, filter or timeline. call_id, only, offset and limit narrow the output. It does not capture traffic by itself.

Tools during a phone call

PrismVox handles transfer_call, take_message and end_call during voice conversations. A recognized caller in Prism gets a restricted voice toolset, not the web catalogue above. See the connection guide for identities, knowledge and permissions.

Understand the voice connection →