Tools reference

The PATHwd connector offers 26 tools: 22 that run PATHwd commands, grouped by what they do (read, add, change, remove) and by area, plus 4 helper tools for documentation and files. ChatGPT sees all 26; other clients see 25 (attach_chat_file is ChatGPT only).

Every command runs in your PATHwd account as you, with your own web-app permissions: a tool can only read or change what you could read or change in the PATHwd web app. Each command tool takes the command to run (one of its own), the command's options, and an output format (compact text, or ids only).

The hints are the MCP tool annotations your AI app reads to decide when to ask you before a call: readOnlyHint: true means the tool changes nothing; destructiveHint: true means it changes or removes existing data; openWorldHint: true means it reaches people or systems outside your PATHwd account.

All tools

ToolTitleGroupreadOnlyHintdestructiveHintopenWorldHint
path_accountPATH account and usersreadtruefalsefalse
path_data_modelPATH data modelreadtruefalsefalse
path_find_recordsFind PATH recordsreadtruefalsefalse
path_record_activityPATH record activityreadtruefalsefalse
path_my_workMy PATH tasks and feedreadtruefalsefalse
path_folders_reportsPATH folders and reportsreadtruefalsefalse
path_calendarsPATH calendarsreadtruefalsefalse
path_pathwaysPATH pathwaysreadtruefalsefalse
path_create_recordCreate a PATH recordaddfalsefalsefalse
path_add_to_recordAdd to a PATH recordaddfalsefalsefalse
path_send_emailSend an email from a PATH recordaddfalsetruetrue
path_update_recordUpdate a PATH recordchangefalsetruefalse
path_run_pathwayRun a PATH pathwaychangefalsetruefalse
path_manage_tasksManage PATH taskschangefalsetruefalse
path_my_settingsMy PATH notifications and profilechangefalsetruefalse
path_manage_calendarsManage PATH calendarschangefalsetruefalse
path_manage_folders_reportsManage PATH folders and reportschangefalsetruefalse
path_archive_recordArchive or unlink a PATH recordremovefalsetruefalse
path_remove_from_recordRemove from a PATH recordremovefalsetruefalse
path_cancel_taskCancel a PATH taskremovefalsetruefalse
path_delete_calendar_itemsDelete PATH calendar itemsremovefalsetruefalse
path_delete_folder_report_itemsDelete PATH folder and report itemsremovefalsetruefalse
request_file_uploadRequest a file uploadhelperfalsefalsefalse
attach_chat_fileUse a file from the chathelperfalsefalsefalse
write_workspace_fileWrite a workspace filehelperfalsefalsefalse
path_docsPATH docshelpertruefalsefalse

Read tools

Read tools only read. They change nothing in PATHwd.

path_account: PATH account and users

readOnlyHint: true · destructiveHint: false · openWorldHint: false

An account is one company's PATHwd; its session context sums it up: the account, its users and roles, the pathways startable from the dashboard and the user's process context. Shows the user's PATHwd accounts and picks the one later commands use; reads the account's session context, users, roles, the user's profile and notification settings, and web-app links.

CommandWhat it does
list-accountsList your accounts (not the ones you've been deactivated in)
use-accountSet the default account for subsequent commands (kept for this connection), and show its session context: the account and its context (what the business does), the pathways you can start from the dashboard, and your process context
get-accountShow the active account (or --account-id): its name, time zone, country and context, the designers' description of the business
session-contextReturns the session context in full: the account and its context, its users and their roles, the pathways the user can start from the dashboard, the user's process context, and PATH's core concepts
get-profileShow your profile settings: name, email, phone, time zone and muted report emails
get-notification-settingsYour notification settings: account-wide rows (task, feed, …), or with --resolved every notification that can reach you and which channels you may turn on
list-usersThe account's active users: each one's name and role names, nothing else (every user also has All Users)
list-rolesList roles
web-linkPrint the PATH web app link to a record, folder or report (the same link the app opens and shares)
clear-cacheClear the cached design metadata (all accounts, or one with --account); the next commands fetch it again

Example requests:

  • "Which PATHwd accounts can I open?"
  • "Switch to account 1234."
  • "Who are the users in this account, and what roles do they have?"

As sent to the connector: command use-account, args 1234.

path_data_model: PATH data model

readOnlyHint: true · destructiveHint: false · openWorldHint: false

A business object is a kind of thing the business tracks (Jobs, Quotes, Customers); its fields, linked records, milestones and workflow steps are how the account is set up. Reads how the account is set up: business objects, fields, field groups, relationships, workflow milestones, steps and tasks, tag groups, file types and appointment fields, with the designers' context; parses and prints Logic Builder formulas.

CommandWhat it does
list-business-objectsList business objects (id, name, plural), then each one's context: what the designer says it is for
get-business-objectShow one business object: names, type, identifier field, menu/messages/email switches, and its context (the designer's description of what it is for)
list-fieldsList a business object's fields: id, name, type, whether a value is mandatory (req), the relationship a linked field comes from, and selection options; then each field's context (what it holds and when to fill it). get-field shows one field whole
get-fieldShow one field: type, whether a value is mandatory, whether --data can write it, group, the relationship a linked field comes from, format, default, every selection option, and its context (the designer's description of what the field holds and when to fill it)
list-field-groupsList a business object's field groups (id, name), then each one's context
list-relationshipsList a business object's relationships (id, name, the business object it links to), then each one's context
list-workflow-milestonesList a business object's workflow milestones (id, name, initial/disabled, the workflow tasks it creates or offers, what runs on entry), then each one's context. get-filter milestone <id> prints a milestone's entry criteria
list-workflow-stepsList a business object's workflow steps (id, name, initial/disabled), then each one's context
list-workflow-tasksList a business object's workflow tasks (id, title, pathway, assignment, stored rules), then each one's context
list-tag-groupsList tag groups and their active tags
list-file-typesList a business object's file types, as Designer → Files → File Types lists them (the system types Archived and Email Attachment are left out unless --include-hidden)
list-appointment-fieldsList the appointment fields calendar events can be scheduled on
parse-filterValidate a Logic Builder formula (e.g. '[Department] = "Retail" AND INMILESTONE("Lead")') against a business object without saving it
get-filterPrint a stored Logic Builder filter as formula text (milestone criteria, task criteria, Fork conditions, folder/report/sticker filters, visibility rules)

Example requests:

  • "What fields does a Job have?"
  • "What milestones does a Job go through?"
  • "How are Jobs related to Customers?"

As sent to the connector: command list-fields, args --bo-name Job.

path_find_records: Find PATH records

readOnlyHint: true · destructiveHint: false · openWorldHint: false

A record is one item of a business object, such as Job 1234 or the Smith quote. Finds and reads records: global search, Logic Builder searches over one business object, folder lists, one record as the record viewer shows it, and its related records.

CommandWhat it does
searchSearch records globally, like the web's search (archived records left out unless --include-archived)
find-recordsAdvanced search: the records of one business object that match a Logic Builder formula (e.g. 'ISLASTWEEK([Created Date]) AND HASSTEP("Job Won")'), run on the fly without saving a folder or report
list-recordsList one business object's records: the ones you viewed recently (--bo-name / --bo-id alone), or a folder's (--folder-name with --bo-name / --bo-id, or --folder-id, whose folder must belong to the business object when one is given)
get-recordGet a single record by ID, as the record viewer shows it to you: field names with display values under their field groups, related records with their ids, then the designer context of what it shows (business object, fields, relationships; once per session) and what can be done on it now: the pathways its Pathways tab offers you (as pathway-run available --record-id) and the open tasks on it (each with the pathway completing it runs)
list-related-recordsA record's related records as the record viewer shows them to you

Example requests:

  • "Find the Smith job."
  • "Show me Jobs created in the last 30 days that are still in Lead."
  • "Open Job 26-0073 and tell me its status and balance."

As sent to the connector: command search, args --query "Smith".

path_record_activity: PATH record activity

readOnlyHint: true · destructiveHint: false · openWorldHint: false

A record's activity is what happened on it: its files, notes, messages, emails, tasks and change history. Reads a record's activity: its files (and downloads one), notes, messages, emails, tasks and change history.

CommandWhat it does
list-record-filesList every file attached to a record (optionally only the given file types), with each file's type names
download-record-fileDownload one file attached to a record (to a workspace path, or to stdout with --stdout)
list-record-notesList a record's Notes fields and every note in them, newest first, as the record viewer shows them: author, when (your clock), note id, and whether each is yours (only the author can edit or delete a note)
list-record-messagesList the messages on a record, newest first (deleted messages left out)
list-record-emailsList emails on a record (newest first); --email-id shows one email in full, body included
list-record-tasksList tasks on a record
get-history-by-recordChange history for a record as a flat event table (read-only)
get-history-sessionEvery event one activity session recorded — e.g. everything an inbound integration request did: the record it created, fields set, pathway steps, outbound calls — as the flat event table, oldest first (read-only)
get-event-metadataGet the metadata (and context) of a single history event (read-only)

Example requests:

  • "What files are on Job 26-0073?"
  • "Read me the latest notes on the Smith job."
  • "What changed on Job 26-0073 this week, and who changed it?"

As sent to the connector: command list-record-files, args --record-id 6a9056455ff33756afba5084.

path_my_work: My PATH tasks and feed

readOnlyHint: true · destructiveHint: false · openWorldHint: false

The user's work is the tasks assigned to them and their Feed of notifications. Reads the signed-in user's own work: tasks assigned to them, notifications, the dashboard Feed and its unread counts, and popups.

CommandWhat it does
list-user-tasksYour open tasks (the dashboard's task list), as a short table: id, task, record ("Job 1347"), record_id, due (your time zone), soonest due first
list-notificationsList notifications
list-feedList your dashboard Feed (newest first), like the web Feed page
feed-unread-countsUnread Feed counts per business object (the menu badges) or per record
feed-recordsThe records your Feed and popups mention (the Feed page record list)
list-popupsList your popup notifications (the in-app popups)

Example requests:

  • "What tasks do I have due this week?"
  • "Do I have unread notifications?"
  • "What is new in my Feed?"

As sent to the connector: command list-user-tasks.

path_folders_reports: PATH folders and reports

readOnlyHint: true · destructiveHint: false · openWorldHint: false

A folder is a saved list of one business object's records that meet set conditions; a report is a table of such records with chosen columns. Lists folders and reports, shows a report's columns and filter, and runs a report.

CommandWhat it does
list-foldersList the folders in the user's folder menu: id, business object, name
list-reportsList the reports the user can open: id, business object, grouped, name
get-reportShow a report: its business object and type, its columns (column id, name, type, hidden, the COLUMN("name") a filter compares, a computed column's definition), its filter-only Custom Fields (CUSTOMFIELD("name")), its filter as formula text, its user filters, and the report's and each column's own context (what it is for; once per session like all context)
run-reportRun a report and print its rows (the web app's report view; in real-world mode only reports the acting user can open): a table of record (the record id; total on a group total row) and the report's own columns with the cells as the web shows them, then a paging footer

Example requests:

  • "What folders are there for Jobs?"
  • "Run the 'Won this month' report."
  • "What columns and filter does report 42 use?"

As sent to the connector: command list-folders, args --bo-name Job.

path_calendars: PATH calendars

readOnlyHint: true · destructiveHint: false · openWorldHint: false

A calendar holds events (appointments); an event can fill a record's appointment field. Reads calendars, calendar groups and calendar events (appointments) in a date window.

CommandWhat it does
list-calendarsList calendars: id, name, synced (google / outlook when merged with one), owner. get-calendar <id> shows who it is shared with
get-calendarShow a calendar: color, owner, what All Users get, and (for its owner or an Admin / Calendar Admin) who it is shared with
list-calendar-groupsList the calendar groups you can see, with their calendars and owner
get-calendar-groupShow a calendar group: its calendars, owner, what All Users get, and (for its owner or an Admin / Calendar Admin) who it is shared with
list-calendar-eventsList calendar events (all origins) in a date window: id, when (your clock; all-day events as days), calendar, from (the record id of a record appointment, or the provider of a synced Google / Office 365 event; read-only), title. get-calendar-event <id> shows one in full
get-calendar-eventShow one calendar event: title, when (your clock), calendar, the record and appointment field it is on, source (standalone, or the synced provider and organizer), read-only, location, participants, description, created

Example requests:

  • "What's on the Installs calendar next week?"
  • "Show me tomorrow's appointments."
  • "Which calendars can I see?"

As sent to the connector: command list-calendars.

path_pathways: PATH pathways

readOnlyHint: true · destructiveHint: false · openWorldHint: false

A pathway is a guided, step-by-step flow that moves a record through its process, as in the web app. Lists the pathways the user can start from the dashboard or a record (the only pathway lists, as in the web app; also a folder or task), maps a pathway's steps before running it, and shows saved runs and their logs. Nothing runs.

CommandWhat it does
pathway-run availableWhich pathways a user could start from a launch point (a record's Pathways tab, the dashboard, a folder or a task), each with its designer context (what it is for: read it to decide whether a pathway does what the user asked)
pathway-run mapMap a pathway before running it (read-only, nothing runs): every step in order with what its screen shows and asks for (fields, choices, question text) or what it does on its own, and where the run goes next for each outcome — Fork conditions as formula text, Yes/No and found/not-found branches, List Loops, steps that loop back, sub-pathways, ends, unreachable steps. --record-id also says whether the user could start it on that record now and which branch each Fork on the starting record takes now
pathway-run showShow a run: the screen it is waiting on, or how it ended
pathway-run listList saved pathway runs, newest first
pathway-run logA run's trace: steps, busy messages, every server request and reply

Example requests:

  • "Which pathways can I start on Job 26-0073?"
  • "What steps does the Win Job pathway have?"
  • "Show me the log of my last pathway run."

As sent to the connector: command pathway-run available, args --from dashboard.

Add tools

Add tools add new data (a record, a note, a file, a message, an email). They change or remove nothing that already exists.

path_create_record: Create a PATH record

readOnlyHint: false · destructiveHint: false · openWorldHint: false

A record is one item of a business object, such as Job 1234 or the Smith quote. Creates a record on a business object, or links two records.

CommandWhat it does
create-recordCreate a record on a business object
link-recordLink two records via a relationship

Example requests:

  • "Create a Customer named Acme Builders."
  • "Link Job 26-0073 to the Acme Builders customer."

As sent to the connector: command create-record, args --bo-name Customer --data '{"fields": [{"field_id": 20401, "value": "Acme Builders"}]}'.

path_add_to_record: Add to a PATH record

readOnlyHint: false · destructiveHint: false · openWorldHint: false

A record's activity is what happened on it: its files, notes, messages, emails, tasks and change history. Adds to a record's activity: a note in a Notes field, files (from the workspace), or a message.

CommandWhat it does
add-record-noteAdd a note to a record's Notes field, as the field's Add Note button does (posted as you, now)
upload-record-fileUpload one or more workspace files to a record
send-messagePost a message on a record

Example requests:

  • "Add a note to Job 26-0073: 'Called the customer; delivery moved to Friday.'"
  • "Post a message on the Smith job saying the deposit was received."
  • "Attach this PDF to Job 26-0073 as a Quote."

As sent to the connector: command add-record-note, args --record-id 6a9056455ff33756afba5084 --note "Called the customer; delivery moved to Friday.".

path_send_email: Send an email from a PATH record

readOnlyHint: false · destructiveHint: true · openWorldHint: true

A record's Emails list holds the emails sent or received about it. Sends a real email from a record as the signed-in user, as the record's Email tab Compose does: it goes out from their name and PATH email address to the recipients given (people outside PATH receive it), CCs the record's own address and saves the sent email to the record's Emails list; it can attach the record's files. A sent email can't be recalled.

CommandWhat it does
send-record-emailSend a real email from a record, as the record viewer's Email tab Compose → Send does: it goes out from you (your name and PATH email address), the record's own address is always CC'd, you are CC'd unless --no-cc-me, your default email signature follows the body, and the sent email is saved to the record's Emails list

Example requests:

  • "Email the revised quote on Job 26-0073 to pat@example.com."
  • "Show me the email you would send to the customer before sending it."

As sent to the connector: command send-record-email, args --record-id 6a9056455ff33756afba5084 --to pat@example.com --subject "Revised quote" --body "Hi Pat, the revised quote is attached." --record-file "Revised Quote.pdf" --preview.

Change tools

Change tools change data that already exists in PATHwd.

path_update_record: Update a PATH record

readOnlyHint: false · destructiveHint: true · openWorldHint: false

A record's fields are the pieces of information on it; some are typed in, others are calculated by PATH and can't be typed over. Changes a record: its field values, its appointment fields, a note, a file's details or a message; also unarchives a record or a file.

CommandWhat it does
update-recordUpdate a record by ID
unarchive-recordUnarchive a record
unarchive-record-fileUnarchive a file on a record
set-appointmentSchedule or change a record's appointment field (creates or updates the calendar event that owns it)
update-record-noteChange the text of a note in a record's Notes field, as its Edit Note form does
update-record-fileUpdate a file on a record
update-messageUpdate a message on a record

Example requests:

  • "Set Job 26-0073's department to Retail."
  • "Schedule the install for Job 26-0073 on November 20 from 9 to 12."
  • "Unarchive Job 26-0073."

As sent to the connector: command update-record, args --record-id 6a9056455ff33756afba5084 --data '{"fields": [{"field_id": 191620, "value": "Retail"}]}'.

path_run_pathway: Run a PATH pathway

readOnlyHint: false · destructiveHint: true · openWorldHint: false

A pathway is a guided, step-by-step flow that moves a record through its process, as in the web app. Runs pathways and workflow steps on records as the web app does: starts a run, answers its screens, cancels it, runs a workflow step, or runs a pathway on the headless runner as scheduled pathways and integrations do (a pathway with screen steps only with --skip-screens).

CommandWhat it does
pathway-run startStart a pathway run, exactly as the web app runs it; stops at the first screen that needs input
pathway-run submitAnswer the paused screen (only what that screen allows) and continue the run
pathway-run actA non-advancing action on the paused screen, e.g. a lookup search: --set search=Acme [--set page=2]
pathway-run cancelCancel a paused run (like closing the web modal)
execute-pathwayRun a pathway on a record on PATH's headless runner, the way scheduled pathways and integrations run: no screens, so it suits a pathway whose steps are all automatic
run-stepRun a workflow step on a record (triggers milestone evaluation)

Example requests:

  • "Run the Win Job pathway on Job 26-0073."
  • "Cancel the pathway run I just started."

As sent to the connector: command pathway-run start, args --pathway-name "Win Job" --record-id 6a9056455ff33756afba5084.

path_manage_tasks: Manage PATH tasks

readOnlyHint: false · destructiveHint: true · openWorldHint: false

A task is a to-do on a record, assigned to a person with a due date; many are created and completed automatically as milestones change. Creates, edits, assigns and completes tasks on records.

CommandWhat it does
create-taskCreate a task on a record, like the record viewer's New Task: from a task template that the record's current milestones offer (--template; list them with --list-templates), or a custom task (--title)
edit-taskEdit an open task on a record, like a task's Edit button
assign-taskAssign a task on a record to a user: --user takes the name list-users shows (or an email or id); a name two users share is refused, asking for the email
complete-taskMark a task as complete on a record

Example requests:

  • "Create a task on Job 26-0073 to call the customer tomorrow."
  • "Mark the 'Review Quote' task on Job 26-0073 as complete."
  • "Assign that task to Jane Doe."

As sent to the connector: command create-task, args --record-id 6a9056455ff33756afba5084 --title "Call the customer" --due 2026-11-14.

path_my_settings: My PATH notifications and profile

readOnlyHint: false · destructiveHint: true · openWorldHint: false

The Feed lists the user's notifications; their notification settings say which channels reach them. Changes the signed-in user's own Feed items (read, pinned), notification settings and profile.

CommandWhat it does
mark-notification-readMark one of your Feed items (or with --popup, a popup) as read
mark-all-notifications-readMark every unread Feed item read (the Feed page "Mark all as read"), or one record's with --record-id
pin-notificationPin (or with --unpin, unpin) one of your Feed items
update-notification-settingsTurn your notification channels on or off, or change your notification phone number
update-profileChange your name or time zone, the way the profile settings modal saves them

Example requests:

  • "Mark all my notifications as read."
  • "Set my time zone to America/Chicago."
  • "Pin that notification."

As sent to the connector: command mark-notification-read, args 4321.

path_manage_calendars: Manage PATH calendars

readOnlyHint: false · destructiveHint: true · openWorldHint: false

A calendar holds events (appointments); an event can fill a record's appointment field. Creates, changes and shares calendars and calendar groups, and creates or changes calendar events.

CommandWhat it does
create-calendarCreate a calendar (Admins and Calendar Admins, as the web's Add Calendar form)
update-calendarRename or recolor a calendar, or set what All Users get (view, edit or none) — the calendar's owner or an Admin / Calendar Admin
share-calendarShare a calendar with users and/or roles (view or edit its events), make one user its owner, or remove their access — the calendar's owner or an Admin / Calendar Admin, as the web's Permissions tab
create-calendar-groupCreate a calendar group (Admins and Calendar Admins, as the web's Add Group form)
update-calendar-groupRename a calendar group or change its calendars (Edit on the group), or set what All Users get (the group's owner or an Admin / Calendar Admin)
share-calendar-groupShare a calendar group with users and/or roles (view, or edit its name and calendars), make one user its owner, or remove their access — the group's owner or an Admin / Calendar Admin
create-calendar-eventCreate a calendar event (standalone, or a record appointment with --record/--field)
update-calendar-eventUpdate a calendar event, or link/unlink it to a record appointment field

Example requests:

  • "Add a site visit to the Installs calendar on November 20 at 9."
  • "Move that event to the next day."
  • "Share the Installs calendar with the Sales role, view only."

As sent to the connector: command create-calendar-event, args --title "Site visit" --start 2026-11-20T09:00 --end 2026-11-20T10:00 --calendar Installs.

path_manage_folders_reports: Manage PATH folders and reports

readOnlyHint: false · destructiveHint: true · openWorldHint: false

A folder is a saved list of one business object's records that meet set conditions; a report is a table of such records with chosen columns. Creates and changes folders, reports, a report's Custom Fields and a folder's stickers, and saves Logic Builder filters.

CommandWhat it does
create-folderCreate a folder with permissions (and its context: --context / --context-file)
update-folderChange a folder's context or settings, saved the way the folder form saves it (everything else as stored)
create-reportCreate a report the way the web report builder does: columns (fields, Relationship.Field, milestone/step dates, Milestones, Count, CALC(<expression>), TIMEBETWEEN(<from>, <to>)), Group / Calculation columns, a Logic Builder filter, Custom Fields, context
update-reportChange a report's context or settings, saved the way the report form saves it (columns, filter, scheduling as stored)
set-filterReplace a stored Logic Builder filter from formula text
create-folder-stickerAdd a sticker of the folder's own (shown on its rows when its formula matches), saved the way the folder form saves it
update-folder-stickerChange one of the folder's own stickers: name, icon, color, formula and/or context (the rest as stored)
hide-folder-stickerHide an inherited business object sticker on this folder (it keeps showing on the business object's other folders)
show-folder-stickerShow again an inherited business object sticker hidden on this folder
create-custom-fieldAdd a filter-only Custom Field to a report: a calculation (--expression, expression syntax) or a Time Between (--from/--to: today | field:<date field> | milestone:<name> | step:<name>, or the same on a related record through to-one relationships, e.g. milestone:Order Related PO.Received)
update-custom-fieldChange a report Custom Field's name, definition (--expression, or --from/--to) or context (--context / --context-file)

Example requests:

  • "Create a Jobs folder called 'Lead Jobs' for the Sales role, showing Jobs in Lead."
  • "Make a report of Jobs won this month with the job name and sell price."
  • "Change folder 88 to show only Residential jobs."

As sent to the connector: command create-folder, args --bo-name Job --folder-name "Lead Jobs" --logic 'INMILESTONE("Lead")' --roles Sales.

Remove tools

Remove tools archive, unlink, cancel or delete. Each command says below whether it can be undone. Permanent deletes ask for a confirmation code first (see Safety and confirmations).

readOnlyHint: false · destructiveHint: true · openWorldHint: false

An archived record is left out of lists and searches but kept, and can be unarchived. Archives records, or removes the link between two records.

CommandWhat it doesAsks for a confirmation code
archive-recordarchives the record (or several); path_update_record unarchive-record brings it backNo
unlink-recordremoves a link between two records; path_create_record link-record links them againNo

Counterpart of path_create_record.

Example requests:

  • "Archive Job 26-0073."
  • "Unlink the customer from Job 26-0073."

As sent to the connector: command archive-record, args --record-id 6a9056455ff33756afba5084.

path_remove_from_record: Remove from a PATH record

readOnlyHint: false · destructiveHint: true · openWorldHint: false

A record's activity is what happened on it: its files, notes, messages, emails, tasks and change history. Archives or deletes a record's files, notes and messages.

CommandWhat it doesAsks for a confirmation code
archive-record-filearchives a file; path_update_record unarchive-record-file brings it backNo
delete-record-filedeletes a file permanentlyYes
delete-record-notedeletes a note permanently (its author only)Yes
delete-messagedeletes a message permanently (your own only)Yes

Counterpart of path_add_to_record.

Example requests:

  • "Archive the old quote file on Job 26-0073."
  • "Delete my note on Job 26-0073 about the delivery date."

As sent to the connector: command archive-record-file, args --record-id 6a9056455ff33756afba5084 --file-id 6a99b04605b6362500875af0.

path_cancel_task: Cancel a PATH task

readOnlyHint: false · destructiveHint: true · openWorldHint: false

A task is a to-do on a record, assigned to a person with a due date; many are created and completed automatically as milestones change. Cancels an open task on a record.

CommandWhat it doesAsks for a confirmation code
cancel-taskcancels the task; there is no command to reopen it (path_manage_tasks create-task makes a new one)No

Counterpart of path_manage_tasks.

Example requests:

  • "Cancel the 'Call the customer' task on Job 26-0073."

As sent to the connector: command cancel-task, args --record-id 6a9056455ff33756afba5084 --task-id 777.

path_delete_calendar_items: Delete PATH calendar items

readOnlyHint: false · destructiveHint: true · openWorldHint: false

A calendar holds events (appointments); an event can fill a record's appointment field. Deletes calendars, calendar groups and calendar events, or clears a record's appointment field.

CommandWhat it doesAsks for a confirmation code
delete-calendardeletes a calendar and its events permanently (record appointments are cleared), or first moves the events to another calendarYes
delete-calendar-groupdeletes a calendar group permanently (its calendars and events stay)Yes
delete-calendar-eventdeletes an event permanently (a record appointment field it fills is cleared)Yes
clear-appointmentclears a record's appointment field and deletes its event; path_update_record set-appointment schedules it againYes

Counterpart of path_manage_calendars.

Example requests:

  • "Delete the site visit on November 20."
  • "Clear the install date on Job 26-0073."

As sent to the connector: command delete-calendar-event, args 6aa08c047f73f73dd53720c7.

path_delete_folder_report_items: Delete PATH folder and report items

readOnlyHint: false · destructiveHint: true · openWorldHint: false

A folder sticker is a label shown on a folder's rows when its formula matches; a report's Custom Field is a calculation its filter can compare. Deletes a folder's own stickers (one, or all of them by resetting to Standard) and a report's Custom Fields.

CommandWhat it doesAsks for a confirmation code
delete-folder-stickerdeletes one of the folder's own stickers permanentlyYes
reset-folder-stickersputs the folder's stickers back to Standard: its own stickers are deleted permanently and hidden ones show againYes
delete-custom-fielddeletes a report's Custom Field permanentlyYes

Counterpart of path_manage_folders_reports.

Example requests:

  • "Delete the 'Overdue' sticker from folder 88."
  • "Remove the 'Days Open' custom field from report 42."

As sent to the connector: command delete-folder-sticker, args --folder-id 88 --sticker Overdue.

Helper tools

path_docs: PATH docs

readOnlyHint: true · destructiveHint: false · openWorldHint: false

Returns PATHwd reference documentation: what PATH terms mean, the syntax of every command the tools run, step-by-step guides, and a search over all of them. It reads documentation that ships with the connector and makes no call to PATHwd.

Available in: every client.

Example requests:

  • "How do Logic Builder formulas work in PATH?"
  • "What does a milestone mean in PATH?"

request_file_upload: Request a file upload

readOnlyHint: false · destructiveHint: false · openWorldHint: false

Opens an upload so a file from your computer can be used by a command (for example to attach it to a record). It returns the file's place in your private workspace on the connector, a browser link where you pick or drop the file (it asks you to sign in to PATHwd; valid 30 minutes), and a command-line upload with a token valid 15 minutes that an assistant able to run code can use (for one file the token works once; for several files, up to 20 until it expires). Nothing is uploaded to PATHwd until a later command uses the file.

Available in: every client.

Example requests:

  • "I need to attach a file from my computer to Job 26-0073."

write_workspace_file: Write a workspace file

readOnlyHint: false · destructiveHint: false · openWorldHint: false

Writes a small file (text, or base64 up to about 1 MB) into your private workspace on the connector, such as an email body or scripted answers for a pathway run. A file that already exists at that path is kept, and the call reports it, unless the request explicitly asks to replace it.

Available in: every client.

Example requests:

  • "Use this HTML as the body of the email to the customer."

attach_chat_file: Use a file from the chat

readOnlyHint: false · destructiveHint: false · openWorldHint: false

Stores a file you attached in the chat in your private workspace on the connector, so a command can use it. The connector downloads the file from the chat service's own file link (only from chatgpt.com and *.oaiusercontent.com, over HTTPS).

Available in: ChatGPT only: it is listed only for clients that pass attached files to tools as file inputs, which ChatGPT does. Claude clients never see it.

Example requests:

  • "(With a photo attached in ChatGPT) Upload this photo to Job 26-0073."

Not available on the connector

These PATH CLI commands are refused, whoever asks:

CommandWhy
apithe raw API is not available on PATHwd
authsign-in happens when the connector is connected
logoutsigning out is disconnecting the connector in the app
pathway-run testpathway tests are not available on PATHwd
pathway-run save-testpathway tests are not available on PATHwd
pathway-run cleanuppathway tests are not available on PATHwd
pathway-run deletesaved runs are kept on the server and not deleted from here

The full syntax of every command (its options and values) is in the command reference.

Thank you! Your message was sent. We'll be in touch soon.
Something went wrong. Please refresh the page and try again, or reach out directly by email.

Privacy Contact

If you have any questions, concerns, or requests related to our privacy policy, please contact us.

  • privacy@pathwd.com