Start PromptFax session
start_sessionUse this first when a user wants to send or price a fax. PromptFax is built for irregular, pay-per-use outbound faxing: every real send requires a user-reviewed quote and Stripe payment authorization before transmission. MCP clients should set hostType to identify their host: chatgpt, claude, browser, or other. In ChatGPT, pass official files[] file parameters first when they are available so PromptFax can immediately import files[].download_url; never pass a raw file_id or local path as the document. The ChatGPT widget opens for destination entry, automatic quote creation, Stripe Checkout, status tracking, and Choose PDF from ChatGPT fallback when automatic attachment is unavailable or fails. If no document is attached, tell the user to attach a document in the widget. The widget does not provide a document preview step. Do not tell ChatGPT users to get a quote; after the widget has a document and valid destination, tell them to verify the price and use Pay & send when ready. Standards-compatible MCP Apps hosts use the inline PromptFax picker, and text-only clients use the hosted PromptFax session page or attach_document with a fetchable HTTPS URL. Do not call get_quote, checkout, or send_fax for a ChatGPT widget session unless the user explicitly asks for fallback behavior or the widget is unavailable. Use get_status only for a textual status refresh.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| files | No | Optional host-supplied files for initial attachment. ChatGPT file parameters include files[].download_url and files[].file_id. | |
| hostType | No | Identify the MCP host so PromptFax can choose the right interaction mode. Use chatgpt for ChatGPT, claude for Claude, browser for a browser-hosted app, or other for unknown clients. | |
| metadata | No | Optional host-specific metadata for diagnostics or session continuity. | |
| faxNumber | No | Destination US fax number. Accepts common human formats such as 415-555-0182 or E.164 format such as +14155550182. | |
| sessionId | No | PromptFax MCP session identifier returned by start_session. Use this to continue a session-backed fax workflow. | |
| hostCapabilities | No | Optional host capability hints, such as whether the client supports widgets, file-picking, hosted links, or other interactive surfaces. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||