Skip to main content
Glama

Start a fax

create_fax

Use this once the person has confirmed the fax number, and given you their email if they aren't signed in. It creates the fax and returns status_url, the page where the person checks the fax number, documents and price, and pays to send it. Nothing is sent or charged until they pay there. Pass the document_ids from create_document. Without them, the fax waits on the status page for the person to add their files. Choose a private random idempotency_key for each intentional new fax. Reuse the exact same key and request after a timeout or request_in_progress; never change the key just to retry. The key is retained for 24 hours. To check a fax, use get_fax_status or get_fax.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "idempotency_key": "<idempotency_key>",
      "fax_number": "<fax_number>"
    },
    "name": "create_fax"
  }
}

Input Schema

NameRequiredDescriptionDefault
emailNoThe person's email address, where Faxette sends the receipt and updates. Ask the person for it. Leave it out when they're signed in: their account's email is used.
regionNoFor a fax to the US or Canada from a person who isn't signed in and who the conversation shows is in Europe: pass "eu" to send it through Faxette's European service. It's ignored for other numbers and when the person is signed in. Pass the same value to create_document and create_fax.
contentNoText approved by the person, rendered as a PDF before the uploaded documents. Markdown supports headings, lists, tables and links as printed text. Images, raw HTML and remote assets are refused. Always show the generated proof before sending.
languageNoThe language the person chooses for the fax page, checkout and emails. Check get_capabilities for this region. Omit to use the account preference or regional default.
cover_pageNoAn optional cover page. Confirm its wording with the person first. It counts toward the total pages; omit if not requested.
fax_numberYesThe fax number the fax goes to, in international format, like +14155552671. Numbers in the US, Canada, Mexico, Puerto Rico, Costa Rica, the EU, the UK, Switzerland, Norway, Iceland, Liechtenstein, Monaco, Montenegro, Ukraine and the Isle of Man only.
document_idsNoThe document_id of each file from create_document, in the order they're faxed. Up to 10. Leave it out to let the person add files on the status page.
organizationNoTo send as an organization: its id from get_organizations. The fax belongs to the organization and is paid by its plan or card. Leave it out for the person's own fax.
idempotency_keyYesA private random UUID for this intentional new fax. Keep it unchanged for retries of the same request within 24 hours.

Output Schema

NameRequiredDescriptionDefault
idYesThe fax's id. Pass it to get_fax when the person is signed in.
priceYesBefore tax. Null until the pages are counted.
statusYesdraft: waiting for files, or for a file to be fixed. processing_documents: counting pages. documents_ready: ready to pay. awaiting_payment: the person is paying. scheduled: paid, about to dial. sending, delivered, failed. canceled: not paid in time.
attemptYesThe current attempt to dial the fax number.
paymentYesThe person's payment once they start paying, by card or from their credit. amount_cents includes tax.
languageNo
resend_byYesFor a failed fax: until when the person can correct the fax number on the status page and send it again.
fax_numberYes
page_countYesNull until the pages are counted.
review_urlNoA private review link, valid for 30 minutes. Give it to the person so they can inspect the prepared PDF before paying.
status_urlYesThe page where the person checks the fax and pays. Give it to them.
max_attemptsYes
checkout_quoteNo
failure_reasonYesFor a failed fax: temporary (busy or no answer on every attempt), wrong_number (no fax machine answered), or our_side.
document_errorsYesFiles Faxette couldn't use. position is the file's number in the fax. The person fixes them on the status page.
next_attempt_atYesWhen the next attempt dials, if the line was busy or didn't answer.
checkout_availableYesTrue when the person can pay on the status page.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / properties / organization
      Added value: +{
      +  "description": "To send as an organization: its id from get_organizations. The fax belongs to the organization and is paid by its plan or card. Leave it out for the person's own fax.",
      +  "minLength": 1,
      +  "type": "string"
      +}
  2. Changed2 schema fields changed
    • changedInput schema / properties / fax_number / description
      Previous value: -"The fax number the fax goes to, in international format, like +14155552671. Numbers in the US, Canada, Mexico, Puerto Rico and Costa Rica only."New value: +"The fax number the fax goes to, in international format, like +14155552671. Numbers in the US, Canada, Mexico, Puerto Rico, Costa Rica, the EU, the UK, Switzerland, Norway, Iceland, Liechtenstein, Monaco, Montenegro, Ukraine and the Isle of Man only."
    • addedInput schema / properties / region
      Added value: +{
      +  "description": "For a fax to the US or Canada from a person who isn't signed in and who the conversation shows is in Europe: pass \"eu\" to send it through Faxette's European service. It's ignored for other numbers and when the person is signed in. Pass the same value to create_document and create_fax.",
      +  "enum": [
      +    "eu"
      +  ],
      +  "type": "string"
      +}
  3. Changed1 schema field changed
    • changedInput schema / properties / fax_number / description
      Previous value: -"The fax number the fax goes to, in international format, like +14155552671. Numbers in the US and Canada only."New value: +"The fax number the fax goes to, in international format, like +14155552671. Numbers in the US, Canada, Mexico, Puerto Rico and Costa Rica only."
  4. Changed8 schema fields changed
    • addedInput schema / properties / content
      Added value: +{
      +  "description": "Text approved by the person, rendered as a PDF before the uploaded documents. Markdown supports headings, lists, tables and links as printed text. Images, raw HTML and remote assets are refused. Always show the generated proof before sending.",
      +  "properties": {
      +    "format": {
      +      "enum": [
      +        "text",
      +        "markdown"
      +      ],
      +      "type": "string"
      +    },
      +    "text": {
      +      "maxLength": 50000,
      +      "minLength": 1,
      +      "type": "string"
      +    }
      +  },
      +  "required": [
      +    "text",
      +    "format"
      +  ],
      +  "type": "object"
      +}
    • addedInput schema / properties / cover_page
      Added value: +{
      +  "description": "An optional cover page. Confirm its wording with the person first. It counts toward the total pages; omit if not requested.",
      +  "properties": {
      +    "message": {
      +      "maxLength": 2000,
      +      "type": "string"
      +    },
      +    "recipient": {
      +      "maxLength": 120,
      +      "type": "string"
      +    },
      +    "sender": {
      +      "maxLength": 120,
      +      "type": "string"
      +    },
      +    "subject": {
      +      "maxLength": 200,
      +      "type": "string"
      +    }
      +  },
      +  "type": "object"
      +}
    • addedInput schema / properties / idempotency_key
      Added value: +{
      +  "description": "A private random UUID for this intentional new fax. Keep it unchanged for retries of the same request within 24 hours.",
      +  "pattern": "^[A-Za-z0-9_.-]{32,128}$",
      +  "type": "string"
      +}
    • addedInput schema / properties / language
      Added value: +{
      +  "description": "The language the person chooses for the fax page, checkout and emails. Check get_capabilities for this region. Omit to use the account preference or regional default.",
      +  "minLength": 1,
      +  "type": "string"
      +}
    • changedInput schema / required
      Previous value: -[
      -  "fax_number"
      -]New value: +[
      +  "idempotency_key",
      +  "fax_number"
      +]
    • addedOutput schema / properties / checkout_quote
      Added value: +{
      +  "type": [
      +    "string",
      +    "null"
      +  ]
      +}
    • addedOutput schema / properties / language
      Added value: +{
      +  "type": [
      +    "string",
      +    "null"
      +  ]
      +}
    • addedOutput schema / properties / review_url
      Added value: +{
      +  "description": "A private review link, valid for 30 minutes. Give it to the person so they can inspect the prepared PDF before paying.",
      +  "format": "uri",
      +  "type": "string"
      +}
  5. First observed

TDQS

A4.3/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Goes well beyond the annotations by disclosing the payment gate ('Nothing is sent or charged until they pay there'), the fallback state when document_ids is omitted, and a detailed 24-hour idempotency-key retention and retry policy with an explicit 'never change the key just to retry' warning. That is exactly the operational context the destructiveHint/readOnlyHint/ idempotentHint flags cannot convey.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loads the precondition, then behavior, then parameter orders, then retry policy, then sibling routing — a sensible ordering with no filler sentences. It is dense and slightly long for a tool description, but every sentence carries an actionable instruction rather than restating the title.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a 9-parameter, nested-object mutation with a payment step, the description covers the gating condition, what is and isn't created server-side without documents, the idempotency contract, and where to go for status checks. An output schema exists so return values need no explanation, and the remaining parameters are fully documented in the schema.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the baseline is 3; the description earns an increment because it adds cross-tool dependency and retry semantics not present in the schema — 'Pass the document_ids from create_document' and the rule that the same key must be reused after a timeout even though a fresh key is chosen per intentional fax. A few of its statements duplicate schema text (key retained 24 hours), and it says nothing about region, language, organization or cover_page, but the schema already carries those.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource (creates the fax) plus the concrete outcome (returns status_url where the person reviews number, documents and price and pays). It clearly distinguishes itself from the read-side siblings by routing to get_fax_status/get_fax for checking, but never contrasts itself with send_fax or resend_fax, which is the most likely point of confusion for an agent deciding how to get a fax delivered.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives an explicit precondition ('once the person has confirmed the fax number, and given you their email if they aren't signed in') and explicitly names alternatives for the verification step. It also gives a strong retry rule (reuse the same key after a timeout or request_in_progress). What is missing is guidance on when to choose this over send_fax/resend_fax, so the alternative set is only partially covered.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.