add_catalog_rate
ChatGPTAdd a rate item to a catalog (POST /catalogs/{id}/rates). Use this when the user wants a priced item added to a rate catalog.
add_estimate_group
ChatGPTAdd a section (app: 'group') to an estimate (POST /estimates/{id}/sections). Use this when the user wants a new group of line items in an estimate (the app calls it a group).
add_estimate_item
ChatGPTAdd a line item to an estimate (POST /estimates/{id}/items). Use this when the user wants one line item added to a draft estimate. Use it for one line item at a time..
add_estimate_markup
ChatGPTAdd a below-the-line markup (POST /estimates/{id}/below-the-line-markups). Use this when the user wants overhead, profit or a fee added below the line of an estimate.
add_estimate_section
ChatGPTAdd a room (app: 'section') to an estimate (POST /estimates/{id}/rooms). Use this when the user wants a new section (e.g. a room or area) in an estimate (the app calls it a section).
add_payment_schedule_entry
ChatGPTAdd a payment schedule entry (POST /estimates/{id}/payment-schedule/entries). Use this when the user wants a deposit or milestone payment added to an estimate's payment schedule.
add_schedule_phase
ChatGPTAdd a schedule phase (POST /projects/{id}/schedule/phases). Use this when the user wants a phase added to a project's schedule.
apply_proposal_message_template
ChatGPTUse when the user wants to regenerate a draft client message using a saved proposal message template. It is not executed unless confirm is true.
apply_proposal_terms_template
ChatGPTUse when the user wants to apply saved terms and conditions to a proposal. It is not executed unless confirm is true.
apply_scan_quantity_suggestions
ChatGPTUse when the user accepts selected quantities for a draft estimate. It is not executed unless confirm is true.
approve_document
ChatGPTAccept a client document signature (POST /documents/{id}/approve). Use this when the client explicitly approves a document and supplies their signature and the existing active share token. Do not use it for approving solely with a company API key or inventing a client signature or share token. It is not executed unless confirm is true.
approve_expenses
ChatGPTApprove a batch of expenses awaiting review (POST /projects/{id}/expenses/approve). Use this when the user has reviewed PENDING_REVIEW expenses and wants to confirm them; approval can create an Other expense line and notify the team. It is not executed unless confirm is true.
approve_proposal
ChatGPTUse when the user wants to record approval of a sent proposal or change order using its proposal ID. It is not executed unless confirm is true.
archive_cost_code
ChatGPTArchive a cost code (POST /cost-codes/{id}/archive). Use this when the user wants a cost code archived.
archive_estimate
ChatGPTArchive an estimate (POST /estimates/{id}/archive). Use this when the user approves archiving every version; this can cancel an unsold proposal and remove proposal-group membership. It is not executed unless confirm is true.
attach_files_to_document
ChatGPTAttach files to a document (POST /documents/{id}/attachments). Use this when the user wants existing accessible files appended to a document's attachments without removing any.
award_bid
ChatGPTAward a submitted bid (POST /bid-requests/{id}/invitations/{invitationId}/award). Use this when the user approves selecting a submitted bid as the winner, closing the request and declining other bidders; optional notification messages contact bidders. It is not executed unless confirm is true.
bulk_update_tasks
ChatGPTBulk edit task status, assignees and due dates (PATCH /tasks/bulk). Use this when the user approves changing task status, assignees or due dates; inspect failedIds and retry only failures. It is not executed unless confirm is true.
cancel_bid_request
ChatGPTCancel a bid request (POST /bid-requests/{id}/cancel). Use this when the user approves closing a sent request; supply expectedRevision and optionally a bidderNotification message. It is not executed unless confirm is true.
cancel_client_portal_invite
ChatGPTCancel a client portal invitation (DELETE /projects/{id}/client-portal/invites/{inviteId}). Use this when the company user wants a pending invitation revoked; use inviteId from get_client_portal.invites. It is not executed unless confirm is true.
cancel_invoice_send_schedule
ChatGPTCancel a scheduled invoice send (DELETE /invoice-payments/{id}/send-schedule). Use this when the user wants an unsent scheduled invoice stopped. Use the payment-request id.
cancel_proposal
ChatGPTCancel a proposal (POST /proposals/{id}/cancel). Use this when the user wants a sent proposal withdrawn.
cancel_time_entry_change_request
ChatGPTUse this when the requester wants to cancel their own pending correction. It is not executed unless confirm is true.
check_invoices_and_payments
ChatGPTLists the user's Handoff invoice payment requests with amounts due, due dates, and payment status, and totals what is outstanding and overdue. Use this when the user asks about money owed or received, e.g. "Who still owes me money?", "What's overdue?", or "Has the Johnson invoice been paid?". Do not use it to create, send, or record invoices or payments. Defaults to unpaid requests, overdue and failed payments first, then by due date. Filter by projectId or projectName (a case-insensitive match on the project or client name). Amounts are in US dollars and match the Handoff app's invoice calculations. Results only include projects the user's role can see.
clear_estimate_discount
ChatGPTClear the estimate discount (DELETE /estimates/{id}/discount). Use this when the user wants an estimate's discount removed.
clock_in
ChatGPTUse this when the user wants to start their own shift; project is optional and the app eligibility and geofence rules apply. It is not executed unless confirm is true.
clock_out
ChatGPTUse this when the user wants to close their own running shift; preserve any required daily log and break rules. It is not executed unless confirm is true.
combine_estimates
ChatGPTCombine estimates (POST /estimates/combine). Use this when the user approves combining estimates into rooms; uses the first source's tax and markup policy and rejects configured choices. It is not executed unless confirm is true.
commit_catalog_rate_import
ChatGPTUse when extraction succeeded and the user approved the rows to import. It is not executed unless confirm is true.
commit_contact_import
ChatGPTUse when extraction succeeded and the user approved the rows to import. It is not executed unless confirm is true.
commit_cost_code_import
ChatGPTUse when extraction succeeded and the user approved the rows to import. It is not executed unless confirm is true.
copy_document
ChatGPTCopy a project document (POST /documents/{id}/copy). Use this when the user wants an independent duplicate of a document in the same project.
copy_estimate
ChatGPTCopy an estimate (POST /estimates/{id}/copy). Use this when the user wants an independent copy including the estimate's version history.
copy_invoice
ChatGPTCopy an invoice as a new draft (POST /invoices/{id}/copy). Use this when the user wants a new draft copied from an existing invoice.
create_bid_request_draft
ChatGPTCreate a bid request draft (POST /bid-requests/drafts). Use this when the user wants to request subcontractor bids; create an unsent draft, fill it with update_bid_request_draft, then send separately.
create_calendar_event
ChatGPTUse this when the user wants an event saved in the Handoff calendar. It is not executed unless confirm is true.
create_catalog
ChatGPTCreate a rate catalog (POST /catalogs). Use this when the user wants a new rate catalog.
create_change_order
ChatGPTCreate a change order from an estimate (POST /estimates/{id}/change-orders). Use this when the user wants a change order on an approved estimate.
create_client_portal_message
ChatGPTPost a company message to the client portal (POST /projects/{id}/client-portal/messages). Use this when the company user explicitly wants a message posted to the client; item targets require both entityType and entityId. Do not use it for posting as the client or inventing a portal-user identity. It is not executed unless confirm is true.
create_company_ai_instruction
ChatGPTUse when the user wants to add a standing instruction for their company's AI.
create_construction_estimate
ChatGPTStarts a new construction estimate generated by Handoff AI from a scope of work, plans, or photos, priced with the user's own catalogs, pricing defaults, and location. Use this when the user wants a new estimate, e.g. "Make an estimate for this kitchen remodel", "Estimate a 400 sq ft deck", or "Price out these plans". Do not use it to edit, re-price, or add lines to an existing estimate, or to import exact line items the user already has. Generation is asynchronous and returns a jobId, not a finished estimate. get_estimate with that jobId reports GENERATING until the estimate is ready, typically in 2–3 minutes. Calling this tool again starts a second estimate unless the same idempotencyKey is reused. Provide scope, fileIds, or both. Without a project it creates a new project for the estimate.
create_contact
ChatGPTCreate a contact (POST /contacts). Use this when the user wants to add a client, vendor or other contact.
create_contact_type
ChatGPTUse when the user wants to add a contact type for their organization.
create_cost_code
ChatGPTCreate a cost code (POST /cost-codes). Use this when the user wants a new cost code.
create_daily_log
ChatGPTCreate a daily log (POST /daily-logs). Use this when the user wants a site daily log written for a project.
create_document
ChatGPTCreate a document (POST /documents). Use this when the user wants a new written document on a project.
create_estimate
ChatGPTCreate an estimate (blank, or AI-generated from scope/photos/PDFs) (POST /estimates). Use this when the user wants a blank estimate with just a name, optionally on a project. Do not use it for an AI-generated estimate from scope, plans or photos; use create_construction_estimate.
create_estimate_version
ChatGPTCreate an estimate version (POST /estimates/{id}/versions). Use this when the user wants a snapshot before editing; setAsCurrent defaults to true, then edit the returned estimate ID.
create_expense
ChatGPTCreate an expense (POST /expenses). Use this when the user wants a cost recorded against a project.
create_file_folder
ChatGPTCreate a project file folder (POST /projects/{id}/file-folders). Use this when the user wants a named folder in a project, optionally inside an existing parent folder.
create_file_upload_urls
ChatGPTGet presigned upload URLs (direct-to-S3) (POST /files/upload-urls). Use this when you need to upload local files to Handoff; it returns presigned URLs to upload to.
create_invoice
ChatGPTCreate a blank or custom-amount itemized invoice (POST /invoices). Use this when the user wants a blank invoice or a client invoice for a set amount, including the amount of a subcontractor invoice. Pass subTotalUsdCents in integer USD cents, then use send_invoice with the returned id when asked to send it.
create_invoice_from_estimate
ChatGPTCreate an invoice from an estimate (POST /invoices/from-estimate). Use this when the user wants to bill an approved estimate.
create_invoice_from_proposal
ChatGPTCreate an invoice from an approved proposal (POST /invoices/from-proposal). Use this when the user wants to invoice an approved proposal using its accepted scope and pricing.
create_invoice_from_schedule_entry
ChatGPTUse when the user asks to invoice one scheduled payment. Pass the row's entryId and store from list_project_payment_schedules. If the project, proposal or entry is ambiguous, for example two proposals each have a Final payment, ask the user which one first; when the API answers with choices, show them and ask. An already invoiced entry returns its existing invoice: tell the user and create nothing. The invoice is a draft and is not sent.
create_project
ChatGPTCreates a new project (job) in the user's Handoff account, optionally with a new or existing client. Use this when the user wants to start tracking a new job, e.g. "Start a new job for the Lees" or "Create a project for the Smith bathroom remodel". Do not use it to update or look up an existing project, or to create an estimate; create_construction_estimate creates its own project when none is given. Each call creates another project, so a retry after an unclear failure can leave a duplicate. A client email that matches an existing client links that client instead of creating a new one. The site address can be added later in Handoff.
create_project_from_magicplan_scan
ChatGPTUse when creating a destination from a scan.
create_project_label
ChatGPTUse when the user wants a new label for their organization.
create_project_with_document
ChatGPTCreate a project with an attached document (synchronous) (POST /projects/with-document). Use this when the user wants a new project created together with a written document, photos or files. Do not use it for a plain new project; use create_project.
create_proposal
ChatGPTCreate a proposal (POST /proposals). Use this when the user wants a client proposal drafted from an estimate.
create_remaining_invoice
ChatGPTUse when the user asks to invoice the remaining, unbilled value of a project. It bills only value not covered by invoices or uninvoiced schedule entries (those keep their own invoices), as Invoice remaining does in the app. The invoices are drafts and are not sent. Ask which project when it is ambiguous. Do not use it for invoicing one scheduled payment; use create_invoice_from_schedule_entry.
create_schedule_version
ChatGPTUse this when the user wants a new schedule version; inspect the returned version before further changes. It is not executed unless confirm is true.
create_task
ChatGPTCreate task (POST /tasks). Use this when the user wants a to-do created, optionally assigned.
create_task_category
ChatGPTCreate a task category (POST /task-categories). Use this when the user wants a new organization task category; requires company-settings edit permission.
create_task_list
ChatGPTCreate a task list (POST /task-lists). Use this when the user wants a named task list for the company or a project.
create_template
ChatGPTUse when the user wants to save a new template, including a client message or terms and conditions. It is not executed unless confirm is true.
create_time_entry
ChatGPTCreate a time entry (POST /time-entries). Use this when the user wants hours logged for a person on a project.
decline_bid
ChatGPTDecline a submitted bid (POST /bid-requests/{id}/invitations/{invitationId}/decline). Use this when the user approves rejecting one bidder's submitted bid. It is not executed unless confirm is true.
decline_document
ChatGPTDecline a shared document (POST /documents/{id}/decline). Use this when the client explicitly declines a document and supplies the existing active share token, with optional feedback. Do not use it for declining solely with a company API key or inventing a share token. It is not executed unless confirm is true.
delete_bid_request
ChatGPTDelete a bid request (DELETE /bid-requests/{id}). Use this when the user approves permanently removing a request or discarding a draft; supply expectedRevision, optional bidderNotification applies only to sent requests. It is not executed unless confirm is true.
delete_calendar_event
ChatGPTUse this when the user explicitly wants this Handoff calendar event deleted. It is not executed unless confirm is true.
delete_catalog_rate
ChatGPTDelete a catalog rate item (DELETE /catalog-rates/{id}). Use this when the user wants a rate item removed from a catalog.
delete_contact
ChatGPTDelete a contact (DELETE /contacts/{id}). Use this when the user wants a contact deleted.
delete_contact_type
ChatGPTUse when the user requests removal of a custom contact type. It is not executed unless confirm is true.
delete_daily_log
ChatGPTDelete a daily log (DELETE /daily-logs/{id}). Use this when the user wants a daily log deleted.
delete_document
ChatGPTDelete a document (DELETE /documents/{id}). Use this when the user wants a document deleted.
delete_estimate
ChatGPTDelete an estimate (DELETE /estimates/{id}). Use this when the user wants an estimate deleted.
delete_estimate_group
ChatGPTDelete an estimate section (app: 'group') and its items (DELETE /estimate-sections/{id}). Use this when the user wants a group and all its line items removed.
delete_estimate_item
ChatGPTDelete an estimate line item (DELETE /estimate-items/{id}). Use this when the user wants a line item removed from a draft estimate. Use it for one line item at a time..
delete_estimate_markup
ChatGPTRemove a below-the-line markup (DELETE /estimates/{id}/below-the-line-markups/{markupId}). Use this when the user wants a below-the-line markup removed from an estimate.
delete_estimate_section
ChatGPTDelete an estimate room (app: 'section') with its sections and items (DELETE /estimate-rooms/{id}). Use this when the user wants a section with all its groups and line items removed.
delete_file
ChatGPTRemove a file (DELETE /files/{id}). Use this when the user wants a file removed.
delete_file_folder
ChatGPTDelete a project file folder and its contents (DELETE /file-folders/{id}). Use this when the user approves deleting the folder, its subfolders and all files inside. It is not executed unless confirm is true.
delete_other_expense_line
ChatGPTDelete an Other expense budget line and its costs (DELETE /projects/{id}/budget/other-expense-lines/{lineId}). Use this when the user explicitly wants this budget line AND all its linked expenses removed. It is not executed unless confirm is true.
delete_payment_schedule_entry
ChatGPTDelete a payment schedule entry (DELETE /payment-schedule-entries/{id}). Use this when the user wants a payment schedule entry removed.
delete_project
ChatGPTDelete a project (DELETE /projects/{id}). Use this when the user wants a project deleted.
delete_schedule_phase
ChatGPTRemove a schedule phase (DELETE /schedule-phases/{id}). Use this when the user wants a schedule phase removed.
delete_takeoff_item
ChatGPTUse when the user wants a takeoff item removed. It is not executed unless confirm is true.
delete_task
ChatGPTDelete a task (DELETE /tasks/{id}). Use this when the user approves deleting a task. It is not executed unless confirm is true.
delete_task_category
ChatGPTDelete a task category (DELETE /task-categories/{id}). Use this when the user approves deleting a category; tasks remain and can be reassigned to a replacement category. It is not executed unless confirm is true.
delete_task_list
ChatGPTDelete a task list and its tasks (DELETE /task-lists/{id}). Use this when the user approves deleting a list and all tasks in it. It is not executed unless confirm is true.
delete_template
ChatGPTUse when the user explicitly wants to delete a saved template. It is not executed unless confirm is true.
duplicate_estimate_item
ChatGPTDuplicate an estimate line item (POST /estimate-items/{id}/duplicate). Use this when the user wants another copy of an item in a current draft; beforeId must be a sibling.
edit_takeoff_item
ChatGPTUse when the user wants to rename, move or recolor a takeoff item.
enable_client_portal
ChatGPTEnable the client portal (POST /projects/{id}/client-portal/enable). Use this when the company user explicitly wants to enable the client portal for a project. It is not executed unless confirm is true.
enable_nahb_cost_codes
ChatGPTUse when the user wants the standard NAHB library and accepts archiving matching active codes. It is not executed unless confirm is true.
end_break
ChatGPTUse this when the user wants to finish their active break on their own running shift. It is not executed unless confirm is true.
export_document
ChatGPTExport a document (PDF) (POST /documents/{id}/export). Use this when the user wants a PDF of a document.
export_estimate
ChatGPTExport an estimate (PDF/CSV) (POST /estimates/{id}/export). Use this when the user wants a PDF or CSV of an estimate.
export_invoice
ChatGPTExport an invoice (PDF) (POST /invoices/{id}/export). Use this when the user wants a PDF of an invoice or receipt.
export_project_budget_pdf
ChatGPTExport a project's budget as PDF (POST /projects/{id}/budget/export/pdf). Use this when the user wants a budget PDF with the app's totals, costs and permitted labor details; wait for fileUrl.
export_project_schedule
ChatGPTExport the project schedule (CSV) (POST /projects/{id}/schedule/export). Use this when the user wants a CSV of a project's schedule.
export_proposal
ChatGPTExport a proposal (PDF) (POST /proposals/{id}/export). Use this when the user wants a PDF of a proposal.
export_takeoff
ChatGPTUse when the user wants a takeoff PDF.
extend_bid_request_due_date
ChatGPTExtend a bid request due date (POST /bid-requests/{id}/extend-due-date). Use this when the user approves extending an open or expired request; supply expectedRevision and a future newDueAt, notifyBidders defaults to true. It is not executed unless confirm is true.
find_project_files
ChatGPTFinds files stored in the user's Handoff projects, such as plans, photos, permits, and documents, and returns a short-lived download link for one file. Use this when the user asks for project documents, e.g. "Pull up the plans for the Lee job", "Find the permit PDF", or to get fileIds for create_construction_estimate or run_takeoff. Do not use it to upload or delete files. Filter by projectId or projectName (a case-insensitive match on the project or client name) and by fileName. Newest first, up to 100 per page; pass nextCursor for more. Pass fileId for a download link that expires shortly after it is returned.
generate_estimate_group_summary
ChatGPTGenerate a section summary with AI (POST /estimate-sections/{id}/summary/generate). Use this when the user wants Handoff AI to write a group's proposal summary.
generate_project_schedule
ChatGPTUse this when the user wants AI to generate and save a schedule from an explicit prompt; poll get_schedule_generation_status with the returned jobId and do not start another while pending. It is not executed unless confirm is true.
generate_project_tasks
ChatGPTGenerate project tasks with AI asynchronously (POST /task-generations). Use this when the user wants a project checklist generated from an explicit prompt. This saves tasks asynchronously. Supply projectId and optional listId or listName, then poll the returned jobId with get_task_generation_status. Do not start another generation while pending. It is not executed unless confirm is true.
get_activity
ChatGPTGet an activity (GET /activities/{id}). Use this when you have an activity id and need its details.
get_bid_request
ChatGPTRead a bid request (GET /bid-requests/{id}). Use this when you need scope, bidder invitation IDs, submitted bids and the current revision before changing a request.
get_business_advisor_schema
ChatGPTGet the Business Advisor semantic schema (GET /business-advisor/schema). Use this when you are about to run run_business_advisor_query and need the tables and recipes it accepts.
get_calendar_event
ChatGPTUse this when the user needs a saved Handoff calendar event.
get_catalog_rate_import
ChatGPTUse when polling an extraction or reviewing previews for catalog rates. If autoImported is true the rates are already saved.
get_client_portal
ChatGPTRead client portal state (GET /projects/{id}/client-portal). Use this when the company user needs a project's portal state, client invitations, active members or access identifiers.
get_client_portal_message_thread
ChatGPTRead a client portal conversation (GET /projects/{id}/client-portal/messages). Use this when the company user needs messages for the direct conversation or one shared item; item targets require both entityType and entityId.
get_company_change_order_defaults
ChatGPTUse when the user asks how new change order work is configured.
get_company_estimate_defaults
ChatGPTUse when the user asks how new estimate work is configured.
get_company_proposal_defaults
ChatGPTUse when the user asks how new proposal work is configured.
get_company_schedule_defaults
ChatGPTUse when the user asks how new schedule work is configured.
get_contact
ChatGPTGet a contact (GET /contacts/{id}). Use this when you have a contact id and need its details.
get_contact_import
ChatGPTUse when polling an extraction or reviewing previews for contacts.
get_contact_ratings
ChatGPTUse when the user asks for the internal ratings of a contact.
get_cost_code
ChatGPTGet a cost code (GET /cost-codes/{id}). Use this when you have a cost code id and need its details.
get_cost_code_import
ChatGPTUse when polling an extraction or reviewing previews for cost codes.
get_custom_domain
ChatGPTGet the custom domain (GET /custom-domain). Use this when you need the account's custom client-portal domain.
get_daily_log
ChatGPTGet a daily log (GET /daily-logs/{id}). Use this when you have a daily log id and need its content.
get_document
ChatGPTGet a document (GET /documents/{id}). Use this when you have a document id and need its content.
get_estimate
ChatGPTShows one of the user's Handoff estimates: its name, project, client, status, and client total, and optionally its line items. Use this when the user asks what is in an estimate or what it totals, e.g. "What's in the Smith estimate and what's the total?", "Show me the lines of the kitchen remodel estimate", or to check on an estimate that create_construction_estimate is generating (pass its jobId). Do not use it to change an estimate; it only reads. Identify the estimate with estimateId, or with estimateName (a case-insensitive match on the estimate, project, or client name). When several estimates match, it returns status AMBIGUOUS with candidates and no estimate. With jobId it returns GENERATING while Handoff AI is still working (typically 2–3 minutes), GENERATION_FAILED with the error, or the finished estimate. detail "lines" returns up to 100 lines per page in display order; pass nextCursor to read the next page. Amounts are in US dollars.
get_estimate_catalog_rematch_status
ChatGPTPoll the estimate catalog re-match (GET /estimates/{id}/catalogs/rematch-status). Use this when set_estimate_catalogs started a re-match and you need its progress.
get_estimate_catalogs
ChatGPTGet the catalogs applied to an estimate (GET /estimates/{id}/catalogs). Use this when you need which rate catalogs and suppliers an estimate prices from.
get_estimate_details
ChatGPTGet an estimate (GET /estimates/{id}). Use this when you need the estimate record itself (status, client, totals, settings) by id. Do not use it for reading line items; use list_estimate_rows or get_estimate.
get_estimate_discount
ChatGPTGet the estimate discount and totals (GET /estimates/{id}/discount). Use this when you need an estimate's discount and resulting totals.
get_estimate_generation_status
ChatGPTPoll AI estimate-generation status (GET /estimate-generations/{jobId}). Use this when create_estimate or create_construction_estimate returned a generation jobId and you need its progress.
get_estimate_payment_schedule
ChatGPTGet an estimate's payment schedule (GET /estimates/{id}/payment-schedule). Use this when you need the payment schedule entries (deposits, milestones) of an estimate.
get_expense
ChatGPTGet an expense (GET /expenses/{id}). Use this when you have an expense id and need its details.
get_file
ChatGPTGet a file (GET /files/{id}). Use this when you have a file id and need its details or processing status.
get_file_download_url
ChatGPTGet a download URL for a file (GET /files/{id}/download-url). Use this when the user wants to open or download a file you have the id of.
get_google_calendar_connection
ChatGPTUse when the user wants to know if their organization is connected or when it last synced.
get_google_calendar_settings
ChatGPTUse when the user wants the selected calendar and organization-wide sync settings.
get_invoice
ChatGPTGet an invoice (GET /invoices/{id}). Use this when you have an invoice id and need its details.
get_invoice_payment
ChatGPTGet an invoice payment (GET /invoice-payments/{id}). Use this when you have a payment id and need its details.
get_invoice_recipients
ChatGPTRead invoice recipients (GET /invoices/{id}/recipients). Use this when you need the contacts explicitly configured to receive an invoice.
get_magicplan_workspace
ChatGPTUse when checking workspace sync or counts.
get_project
ChatGPTGet a project (GET /projects/{id}). Use this when you have a project id and need its details.
get_project_google_calendar_sync
ChatGPTUse when the user wants to check project sync or see which phases are linked to Google events.
get_project_labels
ChatGPTUse when you need the project's current labels before adding or removing one.
get_project_receivables_summary
ChatGPTUse when the user asks what a project is worth, what has been invoiced or paid on it, what the client still owes, or what is left to invoice. Unpaid balances are invoiced money still owed; left to invoice is project value not billed yet.
get_project_schedule
ChatGPTGet a project's schedule (GET /projects/{id}/schedule). Use this when you need a project's schedule phases with dates and status.
get_project_status
ChatGPTSummarizes where one of the user's Handoff projects stands: status, client, contract value, billed, collected, and outstanding amounts, its estimates, upcoming schedule phases, and recent activity. Use this when the user asks how a job is going, e.g. "Where are we on the Johnson job?", "How much have we billed on the Lee project?", or "What's next on the schedule for the bathroom remodel?". Do not use it to list every project or to change a project; it reads one project. Identify the project with projectId, or with projectName (a case-insensitive match on the project or client name). When several projects match, it returns status AMBIGUOUS with candidates. Amounts are in US dollars. Sections the user's role cannot view are listed in unavailable instead of failing the whole call.
get_proposal
ChatGPTGet a proposal (GET /proposals/{id}). Use this when you have a proposal id and need its details or status.
get_proposal_follow_up_reminders
ChatGPTUse when you need the proposal's reminder settings and delivery status.
get_receipt_expense_import
ChatGPTRead receipt extraction progress and draft expenses (GET /projects/{id}/expense-imports/{jobId}). Use this when you need the status, draft expenses or errorReason for a receipt import; PROCESSED means review is required.
get_receivables_summary
ChatGPTUse when the user asks how much is unpaid, overdue, not sent or paid in the last 30 days across the business or for one client or project. The numbers are the cards on the app's invoices page. Unpaid is money already invoiced and still owed; it is not work left to invoice, which get_project_receivables_summary returns per project. Do not use it for listing individual invoices; use list_invoices with the same filters.
get_scan_quantity_suggestions
ChatGPTUse when you need suggested quantities from a confirmed scan.
get_schedule_generation_status
ChatGPTUse this when a generation returned a jobId; wait about 10 seconds between pending polls; COMPLETE names the saved scheduleVersionId, FAILED should be reported.
get_schedule_version
ChatGPTUse this when the user needs phases, dependencies and assignees in a saved version.
get_subcontractor_conversation
ChatGPTRead a subcontractor portal conversation (GET /projects/{id}/vendor-portal/contacts/{contactId}/message-thread). Use this when the user needs messages with one vendor, either direct or contextual to a shared item, daily log, invoice or bid invitation.
get_subcontractor_invoice
ChatGPTRead a subcontractor invoice and its import result (GET /projects/{id}/vendor-portal/invoices/{submissionId}). Use this when you need its submitted amountUsdCents, vendor, attachment, or importJobStatus and extracted budgetExpenses; pass amountUsdCents to a client invoice as subTotalUsdCents.
get_submitted_bid
ChatGPTRead a submitted bid (GET /bid-requests/{id}/bids/{invitationId}). Use this when you have a request ID and invitationId and need that bidder's current submission and previous revisions.
get_takeoff
ChatGPTShows the progress and results of a Handoff AI takeoff: its stage, measured quantity totals by unit and category, and the measured items. Use this when the user asks about a takeoff that run_takeoff started, e.g. "Is the takeoff done?" or "What quantities did the takeoff find?". Do not use it to start a takeoff. A takeoff usually takes 30–120 minutes; while it runs, status is processing. Once complete, items are paginated up to 100 per page with nextCursor, and estimateId names the estimate the quantities were placed in (readable with get_estimate).
get_takeoff_credits
ChatGPTGet AI takeoff credits (GET /takeoff-credits). Use this when you need how many AI takeoff credits remain before run_takeoff.
get_takeoff_export
ChatGPTUse when you need the PDF export status and URL.
get_task_generation_status
ChatGPTPoll AI task generation status (GET /task-generations/{jobId}). Use this when generate_project_tasks returned a jobId. For PENDING or PROCESSING wait about 10 seconds and poll the same job. COMPLETE returns saved taskIds and listIds; FAILED returns a safe error and should be reported.
get_template
ChatGPTGet a template (GET /templates/{id}). Use this when you have a template id and need its content.
get_time_tracking_settings
ChatGPTGet time tracking settings (GET /time-tracking/settings). Use this when you need the account's time tracking settings.
get_vendor_portal
ChatGPTGet a project's vendor portal (GET /projects/{id}/vendor-portal). Use this when you need which subcontractors and vendors can see a project and what is shared with them.
handoff_action
ChatGPTPerforms destructive or irreversible Handoff actions that the user explicitly requested, such as deleting, sending, approving, rejecting, revoking access, or rematching a catalog. Rejects reads and reversible writes. Destructive execution requires confirm:true. Handoff destructive or irreversible action commands. • call <tool> <json-args> Run a destructive catalog operation. • api <METHOD> <path> [<json>] Run a destructive endpoint directly. Deletes, proposal and invoice actions, vendor-portal access changes, time-entry approval/rejection, task creation/updates that can grant project access, and estimate-catalog rematching require "confirm": true in the args.
handoff_read
ChatGPTThe user's Handoff account data. Handoff is a construction estimating & project-management product; this tool reads the user's own Handoff projects, estimates, proposals, invoices, contacts, daily logs, documents, tasks, and expenses, and discovers available operations. Finds, lists, or summarizes the user's Handoff business records. It does not access issue trackers, code repositories, or engineering project boards. Supports operation discovery with context and search, read-only catalog calls with call, and direct read-only Handoff API requests with api. Features: • activities (2) • business-advisor (2) • catalog-rates (2) • catalogs (6) • comments (4) • contacts (6) • cost-codes (8) • custom-domain (1) • daily-logs (6) • documents (7) • estimate-generations (1) • estimates (24) • expenses (4) • files (7) • hooks (3) • invoice-payments (3) • invoices (10) • me (1) • projects (22) • proposals (1) • schedule-phases (2) • suppliers (5) • tasks (7) • templates (2) • time-tracking (8) • triggers (6) --- Handoff read and discovery commands. The feature overview is always above — no need to fetch it. • context <feature> List a feature's tools, each with its arg summary. e.g. context estimates • search <regex> Find a tool by name/description across features. e.g. search invoice • call <tool> <json-args> Run a read-only catalog tool. Args: {pathParams?, query?} e.g. call get_projects_by_id {"pathParams":{"id":"<uuid>"}} • api <METHOD> <path> [<json>] Run a read-only endpoint directly. json: {query?, body?} e.g. api GET /contacts {"query":{"limit":5}}
handoff_write
ChatGPTCreates or updates Handoff business records when the operation is reversible. Rejects reads and destructive or irreversible actions. Handoff reversible write commands. • call <tool> <json-args> Run a non-destructive create or update operation. • api <METHOD> <path> [<json>] Run an endpoint that changes state but is not destructive.
ignore_magicplan_project
ChatGPTUse when hiding a project from the unmatched list. It is not executed unless confirm is true.
import_magicplan_projects
ChatGPTUse when importing to confirmed Handoff destinations.
import_receipt_expenses
ChatGPTExtract draft expenses from an uploaded receipt (POST /projects/{id}/expense-imports). Use this when a receipt has been uploaded with upload-urls and GET /files/{id} reports PROCESSING_COMPLETED; start extraction and poll the returned id before approving. It is not executed unless confirm is true.
import_subcontractor_invoice
ChatGPTImport a subcontractor invoice into project costs (POST /projects/{id}/vendor-portal/invoices/{submissionId}/import). Use this when the user wants to extract a submitted invoice into project costs; then poll get_subcontractor_invoice, and review extracted costs in the app.
invite_bid_request_bidders
ChatGPTInvite more bidders (POST /bid-requests/{id}/invitations). Use this when the user approves adding subcontractor/vendor contacts to an open bid request; this can grant portal project access and sends invitations. It is not executed unless confirm is true.
invite_client_portal_contact
ChatGPTInvite a client to the portal (POST /projects/{id}/client-portal/contacts/{contactId}/invite). Use this when the company user wants an existing contact invited to the client portal; use the contact ID and confirm the recipient. It is not executed unless confirm is true.
invite_vendor_portal_contact
ChatGPTInvite a contact to the vendor portal (POST /projects/{id}/vendor-portal/contacts/{contactId}/invite). Use this when the user wants a subcontractor or vendor invited to a project's vendor portal.
link_estimate_item_catalog_rate
ChatGPTLink a catalog rate to an estimate item (PUT /estimate-items/{id}/catalog-rate). Use this when the user approves repricing a current draft item from an active company catalog rate. It is not executed unless confirm is true.
link_google_calendar_event_to_project
ChatGPTUse when the user wants to move an imported Google event into a project's current schedule. It is not executed unless confirm is true.
list_active_time_entries
ChatGPTList running time entries (GET /time-tracking/active). Use this when you need who is clocked in right now.
list_activities
ChatGPTList activities (feed) (GET /activities). Use this when you need the recent activity feed of the account or of one project.
list_bid_requests
ChatGPTList a project's bid requests (GET /bid-requests). Use this when you need a project's bid requests and saved drafts; supply project_id and optionally include_drafts.
list_calendar_events
ChatGPTUse this when the user needs Handoff calendar events within a date range; follow nextCursor for more.
list_catalog_rates
ChatGPTList a catalog's rate items (GET /catalogs/{id}/rates). Use this when you need the rate items (prices) inside a rate catalog.
list_catalogs
ChatGPTList rate catalogs (GET /catalogs). Use this when you need the account's rate catalogs and their ids.
list_client_portal_message_threads
ChatGPTList client portal message threads (GET /projects/{id}/client-portal/message-threads). Use this when the company user needs the project's client conversations and unread counts.
list_client_portal_shares
ChatGPTRead client portal sharing state (GET /projects/{id}/client-portal/shares). Use this when the company user needs shared and unshared resource IDs before changing what the client can see.
list_company_ai_instructions
ChatGPTUse when the user asks which instructions Handoff follows for their company.
list_contact_changes
ChatGPTContact delta (sync feed) (GET /contacts/delta). Use this when you are syncing contacts and need what changed since a cursor.
list_contact_types
ChatGPTUse when the user wants to see built-in and organization contact types.
list_contacts
ChatGPTList contacts (GET /contacts). Use this when you need clients, vendors or other contacts and their ids.
list_cost_codes
ChatGPTList cost codes (GET /cost-codes). Use this when you need the account's cost codes and their ids.
list_daily_logs
ChatGPTList daily logs (GET /daily-logs). Use this when you need site daily logs of the account or a project.
list_document_changes
ChatGPTDocument delta (sync feed) (GET /documents/delta). Use this when you are syncing documents and need what changed since a cursor.
list_documents
ChatGPTList documents (GET /documents). Use this when you need written documents (contracts, notes) and their ids.
list_estimate_changes
ChatGPTEstimate delta (sync feed) (GET /estimates/delta). Use this when you are syncing estimates and need what changed since a cursor.
list_estimate_markups
ChatGPTList the estimate's below-the-line markups (GET /estimates/{id}/below-the-line-markups). Use this when you need the markups (overhead, profit, fees) applied below the line of an estimate.
list_estimate_rows
ChatGPTList an estimate's line items & sections (GET /estimates/{id}/rows). Use this when you need every line item, group and section of an estimate with ids, quantities and prices, e.g. before editing items. Do not use it for a summary of an estimate; use get_estimate.
list_estimate_versions
ChatGPTList estimate versions (GET /estimates/{id}/versions). Use this when you need saved estimate versions, their totals and the current version ID.
list_estimates
ChatGPTList estimates (GET /estimates). Use this when you need the estimates of the account or of one project (projectId), or an estimate id by name.
list_expenses
ChatGPTList expenses (GET /expenses). Use this when you need recorded expenses (costs) of the account or a project.
list_file_changes
ChatGPTFile delta (sync feed) (GET /files/delta). Use this when you are syncing files and need what changed since a cursor.
list_files
ChatGPTList files (GET /files). Use this when you need uploaded files (plans, photos, documents) and their ids, optionally for one project. Do not use it for questions like "find the plans for this job"; use find_project_files.
list_google_calendar_projects
ChatGPTUse when the user wants to find projects and check which are selected for sync.
list_google_calendars
ChatGPTUse when the user needs to choose a calendar from the connected Google account.
list_invoice_changes
ChatGPTInvoice delta (sync feed) (GET /invoices/delta). Use this when you are syncing invoices and need what changed since a cursor.
list_invoice_payments
ChatGPTList invoice payments (GET /invoices/{id}/payments). Use this when you need the payments recorded on one invoice.
list_invoices
ChatGPTList invoices (GET /invoices). Use this when you need the invoices of the account or of one project. Do not use it for a summary of money owed or received; use check_invoices_and_payments.
list_magicplan_projects
ChatGPTUse when listing projects or filtering by matchState.
list_notifications
ChatGPTUse when the user wants their inbox; filter by UNREAD to show unread notifications.
list_project_budget_lines
ChatGPTList a project's assignable budget lines and actual costs (GET /projects/{id}/budget-lines). Use this when you need a project's budget lines and actual costs, e.g. to assign an expense.
list_project_changes
ChatGPTProject delta (sync feed) (GET /projects/delta). Use this when you are syncing projects and need what changed since a cursor.
list_project_file_folders
ChatGPTList a project's file folders (GET /projects/{id}/file-folders). Use this when you need a project's folder tree and folder IDs before organizing files; page through all results.
list_project_labels
ChatGPTUse when you need available project labels and their IDs.
list_project_members
ChatGPTList a project's team members (GET /projects/{id}/members). Use this when you need who works on a project.
list_project_payment_schedules
ChatGPTUse when you need a project's scheduled payments (deposits, milestones, final payment) from every proposal and change order, with each entry's status and linked invoice. Read it before invoicing a scheduled payment so you can name the exact entry.
list_project_scans
ChatGPTUse when you need scans from a Handoff project.
list_project_stages
ChatGPTUse when you need the project board columns and their IDs.
list_projects
ChatGPTList projects (GET /projects). Use this when the user asks which jobs they have or names a project you need the id of, e.g. "show my projects" or "find the Lee kitchen job". Filter with search; page with starting_after. Do not use it for how one job is going overall; use get_project_status.
list_proposal_layouts
ChatGPTList proposal layouts (GET /proposal-layouts). Use this when you need the available proposal layouts.
list_proposals
ChatGPTList proposals (GET /proposals). Use this when you need proposals of the account or of one project.
list_schedule_versions
ChatGPTUse this when the user needs the version history for a project.
list_subcontractor_completed_tasks
ChatGPTRead tasks a subcontractor marked complete (GET /projects/{id}/vendor-portal/contacts/{contactId}/completed-tasks). Use this when the user asks which assigned tasks this subcontractor personally marked complete.
list_subcontractor_conversations
ChatGPTList subcontractor portal conversations (GET /projects/{id}/vendor-portal/message-threads). Use this when the user wants portal conversation previews or unread counts, optionally filtered by contact.
list_subcontractor_daily_logs
ChatGPTRead daily logs submitted by subcontractors (GET /projects/{id}/vendor-portal/daily-logs). Use this when the user asks what subcontractors reported on a project; read report dates and page through the vendor-authored updates.
list_subcontractor_invoices
ChatGPTList subcontractor invoices submitted through the portal (GET /projects/{id}/vendor-portal/invoices). Use this when you need invoices submitted by subcontractors on a project, optionally filtered by vendor or status.
list_subcontractor_time_entries
ChatGPTRead subcontractor time entries (GET /projects/{id}/vendor-portal/time-entries). Use this when the user needs vendor hours for a project and date range, excluding employee time.
list_submitted_bids
ChatGPTList submitted bids (GET /bid-requests/{id}/bids). Use this when you need to compare the bids submitted for a request; invitationId is the stable ID used for awarding or declining.
list_supplier_connections
ChatGPTList supplier connections (GET /supplier-connections). Use this when you need which supplier catalogs (e.g. Home Depot) are connected.
list_suppliers
ChatGPTList suppliers (GET /suppliers). Use this when you need the suppliers Handoff can price from.
list_takeoff_items
ChatGPTList measured takeoff items (GET /takeoffs/{id}/items). Use this when you need every measured quantity of a finished AI takeoff. Do not use it for takeoff progress or totals; use get_takeoff.
list_takeoffs
ChatGPTList AI takeoffs for a project or estimate (GET /takeoffs). Use this when you need the AI takeoffs of a project or estimate.
list_task_assignee_options
ChatGPTList eligible task assignees (GET /tasks/assignee-options). Use this when you need who a task can be assigned to.
list_task_categories
ChatGPTList task categories (GET /task-categories). Use this when you need task categories and their ids.
list_task_lists
ChatGPTList task destinations (GET /task-lists). Use this when you need where tasks can be filed (task lists and projects).
list_tasks
ChatGPTList tasks (GET /tasks). Use this when you need to-dos, optionally filtered by project, assignee, status or due date.
list_templates
ChatGPTList templates (GET /templates). Use this when you need estimate or document templates and their ids.
list_time_entries
ChatGPTList time entries (GET /time-entries). Use this when you need clocked hours, optionally filtered by user, project, status or date.
list_time_entry_change_requests
ChatGPTUse this when the user needs the correction history for a time entry they can access.
manage_invoice_rows
ChatGPTManage invoice line items in a batch (POST /invoices/{id}/rows). Use this when the user wants to add, edit, delete or reorder invoice line items. Read get_invoice first for row ids; combine related edits in one atomic batch.
mark_notification_read
ChatGPTUse when the user wants one of their notifications marked as read.
mark_notifications_read
ChatGPTUse when the user wants to mark multiple notifications in their inbox as read.
mark_subcontractor_invoice_paid
ChatGPTMark a subcontractor invoice paid (POST /projects/{id}/vendor-portal/invoices/{submissionId}/mark-paid). Use this when the user confirms the vendor invoice has already been paid; this records payment status and does not transfer money.
match_expenses_to_budget
ChatGPTMatch a batch of expenses to one budget line (POST /projects/{id}/expenses/match). Use this when the user wants expenses assigned to one current budget line; get its id from list_project_budget_lines and send exactly one target.
match_magicplan_project
ChatGPTUse when choosing a Handoff destination before async import.
merge_projects
ChatGPTUse when the user explicitly wants two projects combined into one new project; this retires both original projects. It is not executed unless confirm is true.
move_estimate_group
ChatGPTMove or reorder an estimate section (app: 'group') (POST /estimate-sections/{id}/move). Use this when the user wants a group moved to another section or reordered.
move_estimate_item
ChatGPTMove or reorder an estimate line item (POST /estimate-items/{id}/move). Use this when the user wants a line item moved to another group or reordered.
move_estimate_section
ChatGPTReorder an estimate room (app: 'section') (POST /estimate-rooms/{id}/move). Use this when the user wants a section moved before another one.
move_file
ChatGPTMove a project file into a folder (POST /files/{id}/move). Use this when the user wants a file moved within its project; set folderId to null to move it to the root.
move_file_folder
ChatGPTMove a project file folder (POST /file-folders/{id}/move). Use this when the user wants a folder moved within its project; set parentId to null to move it to the root.
move_payment_schedule_entry
ChatGPTReorder a payment schedule entry (POST /payment-schedule-entries/{id}/move). Use this when the user wants a payment schedule entry moved before another entry or to the end.
move_project_stage
ChatGPTUse when the user wants to move a project to another board column.
pause_proposal_follow_up_reminders
ChatGPTUse when the user wants to pause scheduled reminders for one proposal. It is not executed unless confirm is true.
record_invoice_payment
ChatGPTLog a manual payment on an invoice (mark paid) (POST /invoices/{id}/payments). Use this when the user received a payment outside Handoff (cash, check) and wants the invoice marked paid.
rename_estimate_group
ChatGPTRename an estimate section (app: 'group') (PATCH /estimate-sections/{id}). Use this when the user wants to rename a group of line items.
rename_estimate_section
ChatGPTRename an estimate room (app: 'section') (PATCH /estimate-rooms/{id}). Use this when the user wants to rename a section of an estimate.
rename_file_folder
ChatGPTRename a project file folder (PATCH /file-folders/{id}). Use this when the user wants an existing file folder renamed.
rename_other_expense_line
ChatGPTRename an Other expense budget line (PATCH /projects/{id}/budget/other-expense-lines/{lineId}). Use this when the user wants to change the name of an existing Other expense line.
rename_task_category
ChatGPTRename a task category (PATCH /task-categories/{id}). Use this when the user approves renaming an organization task category. It is not executed unless confirm is true.
rename_task_list
ChatGPTRename a task list (PATCH /task-lists/{id}). Use this when the user approves renaming an existing task list. It is not executed unless confirm is true.
request_bid_revision
ChatGPTRequest a bid revision (POST /bid-requests/{id}/invitations/{invitationId}/request-revision). Use this when the user approves asking a bidder to revise a submitted bid; message reaches that bidder verbatim. It is not executed unless confirm is true.
request_time_entry_change
ChatGPTUse this when the user wants a correction to their own completed shift reviewed. It is not executed unless confirm is true.
resend_client_portal_invite
ChatGPTResend a client portal invitation (POST /projects/{id}/client-portal/invites/{inviteId}/resend-invite). Use this when the company user wants a pending invitation resent; use inviteId from get_client_portal.invites. It is not executed unless confirm is true.
resolve_time_entry_change_request
ChatGPTUse this when an authorized manager wants to approve or reject a pending correction. It is not executed unless confirm is true.
restore_estimate_group
ChatGPTRestore a deleted estimate section (app: 'group') (POST /estimate-sections/{id}/restore). Use this when the user wants a deleted group brought back.
restore_estimate_item
ChatGPTRestore a deleted estimate line item (POST /estimate-items/{id}/restore). Use this when the user wants a deleted line item brought back.
restore_estimate_section
ChatGPTRestore a deleted estimate room (app: 'section') (POST /estimate-rooms/{id}/restore). Use this when the user wants a deleted section brought back.
restore_magicplan_project
ChatGPTUse when removing ignored status.
restore_schedule_version
ChatGPTUse this when the user wants an earlier schedule restored; this clones it into a new current version. It is not executed unless confirm is true.
resume_proposal_follow_up_reminders
ChatGPTUse when the user wants to restore paused reminders for one proposal. It is not executed unless confirm is true.
retry_expense_quickbooks_sync
ChatGPTUse when the user requests expense retry; require canRetry=true. It is not executed unless confirm is true.
retry_invoice_quickbooks_sync
ChatGPTUse when invoice sync failed or conflicted; read status and require canRetry=true. It is not executed unless confirm is true.
revoke_client_portal_access
ChatGPTRevoke client portal member access (POST /projects/{id}/client-portal/members/{memberId}/revoke). Use this when the company user wants an active client's project access revoked; use memberId from get_client_portal.members. It is not executed unless confirm is true.
run_business_advisor_query
ChatGPTRun a Business Advisor analysis (POST /business-advisor/query). Use this when the user asks an analytical question across jobs (profit, margins, revenue by period); read get_business_advisor_schema first. Do not use it for invoice and payment status questions; use check_invoices_and_payments.
run_takeoff
ChatGPTStarts a Handoff AI takeoff that measures quantities (areas, lengths, counts) from construction plans and places them in an estimate. Use this when the user asks to measure plans, e.g. "Do a takeoff from these plans" or "How many square feet of flooring are on these drawings?". Do not use it to check on a takeoff that is already running (get_takeoff does that) or to estimate from a scope description. Each run spends one AI takeoff credit and cannot be undone. Without confirm:true it starts nothing and returns NEEDS_CONFIRMATION with the credits remaining, so the user can decide; with confirm:true it starts and returns a takeoffId. It returns NO_CREDITS when none remain. A takeoff usually takes 30–120 minutes. Calling again with confirm:true starts and charges another takeoff unless the same idempotencyKey is reused.
schedule_invoice_send
ChatGPTSchedule an invoice send (PUT /invoice-payments/{id}/send-schedule). Use this when the user asks to send an invoice on a future date. Use the payment-request id from list_invoice_payments and confirm the date, recipients and EMAIL/SMS methods first. It is not executed unless confirm is true.
send_bid_reminder
ChatGPTRemind a bidder (POST /bid-requests/{id}/invitations/{invitationId}/remind). Use this when the user approves an EMAIL or SMS reminder to an unanswered bidder or a bidder who owes a revision. It is not executed unless confirm is true.
send_bid_request
ChatGPTSend a bid request (POST /bid-requests/{id}/send). Use this when the user approves sending the completed draft to its selected bidders; this can grant portal project access and sends invitations. It is not executed unless confirm is true.
send_invoice
ChatGPTSend an invoice to the client (POST /invoices/{id}/send). Use this when the user explicitly asks to email or text an invoice to the client. Pass confirm: true only after the user approves. It is not executed unless confirm is true.
send_invoice_reminder
ChatGPTUse when the user explicitly asks to remind the client now about one identified sent, unpaid invoice. Ask which invoice when it is ambiguous. Pass recipientContactId to remind one of the invoice's recipients only. Pass confirm: true only after the user approves. It is not executed unless confirm is true.
send_proposal
ChatGPTSend a proposal (POST /proposals/{id}/send). Use this when the user explicitly asks to email or text a proposal to the client. Pass either recipients, each with its own methods, or methods for the proposal's saved recipients, not both. Pass confirm: true only after the user approves the recipients. It is not executed unless confirm is true.
send_proposal_follow_up_reminder
ChatGPTUse when the user wants to send a manual reminder to proposal recipients. It is not executed unless confirm is true.
send_subcontractor_message
ChatGPTSend a message to a subcontractor portal contact (POST /projects/{id}/vendor-portal/contacts/{contactId}/messages). Use this when the user asks to send a portal message to this subcontractor, optionally about one resource. It is not executed unless confirm is true.
set_all_google_calendar_projects
ChatGPTUse when the user wants every current and future project to use the same Google Calendar sync setting. It is not executed unless confirm is true.
set_change_order_parent
ChatGPTUse when the user wants to attach a change order to an estimate or detach it by setting the parent to null. It is not executed unless confirm is true.
set_change_order_status
ChatGPTUse when the user wants to change whether an estimate is a change order; use approve_proposal for approval. It is not executed unless confirm is true.
set_contact_rating
ChatGPTUse when the user wants to rate or revise their rating for a vendor or subcontractor.
set_current_estimate_version
ChatGPTSwitch the current estimate version (POST /estimates/{id}/current-version). Use this when the user approves selecting a saved version within this estimate's version group. It is not executed unless confirm is true.
set_estimate_catalogs
ChatGPTSet estimate catalog exclusions (triggers AI re-match) (PUT /estimates/{id}/catalogs). Use this when the user wants to change which catalogs or suppliers an estimate prices from; it re-prices the estimate.
set_estimate_discount
ChatGPTSet the estimate discount (PUT /estimates/{id}/discount). Use this when the user wants a percentage or fixed discount on an estimate; it replaces any existing discount.
set_estimate_group_summary
ChatGPTSet a section's proposal summary (PUT /estimate-sections/{id}/summary). Use this when the user wants to write the summary text a group shows on the proposal.
set_estimate_item_client_choice
ChatGPTSet a line item's options or add-on (PUT /estimate-items/{id}/client-choice). Use this when the user wants a line item offered to the client as options or as an optional add-on.
set_estimate_tax_rate
ChatGPTSet an estimate tax rate (PUT /estimates/{id}/tax-rate). Use this when the user approves replacing the current estimate version's tax rate. It is not executed unless confirm is true.
set_invoice_recipients
ChatGPTSet invoice recipients (PUT /invoices/{id}/recipients). Use this when the user wants to replace or clear an invoice's recipient list.
set_project_google_calendar_sync
ChatGPTUse when the user wants one project to start or stop syncing to Google Calendar. It is not executed unless confirm is true.
set_project_labels
ChatGPTUse when the user wants to assign or remove project labels; send the complete desired set of label IDs and preserve labels the user wants to keep.
set_proposal_signature_requirement
ChatGPTUse when the user wants to require a signature for proposal acceptance or make it optional. It is not executed unless confirm is true.
set_schedule_item_google_calendar_sync
ChatGPTUse when the user wants one phase or calendar event to start or stop syncing. It is not executed unless confirm is true.
set_schedule_phase_assignees
ChatGPTUse this when the user wants to replace people assigned to a current schedule phase; empty arrays remove assignments. It is not executed unless confirm is true.
set_supplier_catalog_enabled
ChatGPTEnable or disable a supplier catalog (PATCH /supplier-connections/{slug}/catalog). Use this when the user wants a supplier's catalog turned on or off for pricing.
share_client_portal_resources
ChatGPTShare resources with the client portal (POST /projects/{id}/client-portal/shares). Use this when the company user wants documents, daily logs, schedule or files visible to the client; targets use canonical resource IDs and FILE targets use file-group IDs, while fileIds groups raw project files. It is not executed unless confirm is true.
share_daily_log
ChatGPTShare a daily log with a client (POST /daily-logs/{id}/share). Use this when the user wants a daily log shared through a link, email or SMS; confirm the chosen delivery methods and recipient. It is not executed unless confirm is true.
share_document
ChatGPTShare a document with a client (POST /documents/{id}/share). Use this when the user wants a document shared through a link, email or SMS; confirm the chosen delivery methods and recipient. It is not executed unless confirm is true.
share_with_vendor_portal_contact
ChatGPTShare resources through the vendor portal (POST /projects/{id}/vendor-portal/contacts/{contactId}/shares). Use this when the user wants files, estimates or schedule shared with a subcontractor or vendor through the vendor portal.
sign_document
ChatGPTAdd the contractor signature (POST /documents/{id}/sign). Use this when the contractor wants to add their own signature before sending a document to the client. Do not use it for signing for the client; client approval requires their existing active share token. It is not executed unless confirm is true.
split_estimate
ChatGPTSplit an estimate by rooms (POST /estimates/{id}/split). Use this when the user approves splitting rooms into estimates; configured choices are rejected. It is not executed unless confirm is true.
start_break
ChatGPTUse this when the user wants to start a break on their own running shift. It is not executed unless confirm is true.
start_catalog_rate_import
ChatGPTUse when the user supplied an uploaded file ID and wants to import catalog rates. Poll get_catalog_rate_import after starting. It is not executed unless confirm is true.
start_contact_import
ChatGPTUse when the user supplied an uploaded file ID and wants to import contacts. Poll get_contact_import after starting.
start_cost_code_import
ChatGPTUse when the user supplied an uploaded file ID and wants to import cost codes. Poll get_cost_code_import after starting.
sync_expense_to_quickbooks
ChatGPTUse when the user explicitly requests expense sync; require canSync=true. It is not executed unless confirm is true.
sync_invoice_to_quickbooks
ChatGPTUse when the user explicitly requests invoice sync; read status and require canSync=true. It is not executed unless confirm is true.
sync_magicplan_workspace
ChatGPTUse when refreshing workspace projects.
unarchive_estimate
ChatGPTUnarchive an estimate (POST /estimates/{id}/unarchive). Use this when the user approves restoring an archived estimate and its app proposal state. It is not executed unless confirm is true.
undo_estimate_action
ChatGPTUndo estimate changes (POST /estimates/{id}/undo). Use this when the user approves restoring a current draft to a known timestamp from server history. It is not executed unless confirm is true.
unmatch_magicplan_project
ChatGPTUse when clearing a match and keeping imported scans and files. It is not executed unless confirm is true.
unshare_client_portal_resources
ChatGPTUnshare client portal resources (DELETE /projects/{id}/client-portal/shares). Use this when the company user wants selected items removed from client visibility; use FILE group IDs returned by sharing state, never raw file IDs. It is not executed unless confirm is true.
update_bid_request_draft
ChatGPTReplace a bid request draft (PUT /bid-requests/{id}/draft). Use this when the user wants to set an unsent request's scope, deadline, required documents or contactIds; supply all lists and expectedRevision from the last read.
update_catalog
ChatGPTUpdate a rate catalog (PATCH /catalogs/{id}). Use this when the user wants a rate catalog renamed or described.
update_catalog_rate
ChatGPTUpdate a catalog rate item (PATCH /catalog-rates/{id}). Use this when the user wants a rate item's price, unit or details changed.
update_company_ai_instruction
ChatGPTUse when the user wants to edit or disable an existing company AI instruction.
update_company_change_order_defaults
ChatGPTUse when the user wants to change defaults for new change order work.
update_company_estimate_defaults
ChatGPTUse when the user wants to change defaults for new estimate work.
update_company_proposal_defaults
ChatGPTUse when the user wants to change defaults for new proposal work.
update_company_schedule_defaults
ChatGPTUse when the user wants to change defaults for new schedule work.
update_contact
ChatGPTUpdate a contact (PATCH /contacts/{id}). Use this when the user wants to change a contact's details.
update_daily_log
ChatGPTUpdate a daily log (PATCH /daily-logs/{id}). Use this when the user wants a daily log's content or date changed.
update_document
ChatGPTUpdate a document (PATCH /documents/{id}). Use this when the user wants a document's content changed.
update_estimate
ChatGPTUpdate an estimate (PATCH /estimates/{id}). Use this when the user wants to rename an estimate or change its client, project, notes or proposal settings.
update_estimate_item
ChatGPTUpdate an estimate line item (PATCH /estimate-items/{id}). Use this when the user wants to change a line item's label, description, quantity, rate, unit, cost code or category. Use it for one line item at a time..
update_estimate_markup
ChatGPTUpdate a below-the-line markup (PATCH /estimates/{id}/below-the-line-markups/{markupId}). Use this when the user wants a below-the-line markup's title or amount changed.
update_expense
ChatGPTEdit an expense (PATCH /expenses/{id}). Use this when the user wants a recorded expense corrected.
update_google_calendar_projects
ChatGPTUse when the user wants to change which of several projects sync to Google Calendar. It is not executed unless confirm is true.
update_google_calendar_settings
ChatGPTUse when the user wants to change the target calendar or organization-wide sync settings. It is not executed unless confirm is true.
update_invoice
ChatGPTUpdate an invoice (PATCH /invoices/{id}). Use this when the user wants an invoice's title, client, terms or due date changed.
update_invoice_payment
ChatGPTEdit a manual payment (PATCH /invoice-payments/{id}). Use this when the user wants a recorded manual payment corrected.
update_payment_schedule_entry
ChatGPTUpdate a payment schedule entry (PATCH /payment-schedule-entries/{id}). Use this when the user wants a payment schedule entry's amount, name or due date changed.
update_project
ChatGPTUpdate a project (PATCH /projects/{id}). Use this when the user wants to rename a project or change its status, client, address or assigned user.
update_schedule_phase
ChatGPTEdit a schedule phase (PATCH /schedule-phases/{id}). Use this when the user wants a schedule phase's name, dates, status or color changed.
update_task
ChatGPTUpdate, complete, reopen or assign task (PATCH /tasks/{id}). Use this when the user wants a task edited, completed, reopened or reassigned.
update_template
ChatGPTUse when the user wants to change a saved template. It is not executed unless confirm is true.
update_time_tracking_settings
ChatGPTUse this when a time tracking manager wants org defaults changed using the app settings permissions; saved fields clear matching member overrides. It is not executed unless confirm is true.
upload_file_from_url
ChatGPTUpload a file by URL (POST /files). Use this when the user gives a public https URL of a file to add to Handoff.
void_invoice
ChatGPTDelete (void) an invoice (DELETE /invoices/{id}). Use this when the user wants an invoice voided.
handoff_action
Claudehandoff_read
Claudehandoff_write
Claude