Skip to main content
Glama

Check a fax in the account

get_fax
Read-onlyIdempotent

Use this for one fax from the person's Faxette account: its status, price, payment, documents' file names and history. Pass the id from get_faxes or create_fax. While a fax is sending, call it at most once a minute. Needs the person to sign in to Faxette; calling it while they aren't asks the app to sign them in. It changes nothing.

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": {
      "id": "<id>"
    },
    "name": "get_fax"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYesThe fax's id, from get_faxes or create_fax.

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.
historyYesWhat has happened to the fax, oldest first.
paymentYesThe person's payment once they start paying, by card or from their credit. amount_cents includes tax.
languageNo
documentsYesThe documents' file names, in the order they're faxed. Empty once deleted.
failed_atYes
resend_byYesFor a failed fax: until when the person can correct the fax number on the status page and send it again.
created_atYes
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.
credit_priceYesWhat send_fax takes from the credit for this fax. Null once it can no longer be paid for.
credit_quoteNo
delivered_atYes
max_attemptsYes
organizationNoThe organization's id when the fax was sent as an organization, null for the person's own.
checkout_quoteNo
failure_reasonYesFor a failed fax: temporary (busy or no answer on every attempt), wrong_number (no fax machine answered), or our_side.
payment_optionNoFor an organization's fax that's ready to send: how send_fax would pay. plan: the organization's plan covers it, with no charge. saved_card: amount_cents is held on the card ending card_last4 and charged when the fax is delivered. Null when neither can pay.
status_messageYesWhere the fax is, in the words the fax page uses.
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.
immediate_sending_consent_requiredNoWhen true, obtain agreement to immediate sending and acknowledgement that the withdrawal right ends on delivery before calling send_fax.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • addedOutput schema / properties / organization
      Added value: +{
      +  "description": "The organization's id when the fax was sent as an organization, null for the person's own.",
      +  "type": [
      +    "string",
      +    "null"
      +  ]
      +}
    • addedOutput schema / properties / payment_option
      Added value: +{
      +  "anyOf": [
      +    {
      +      "additionalProperties": false,
      +      "properties": {
      +        "amount_cents": {
      +          "maximum": 9007199254740991,
      +          "minimum": -9007199254740991,
      +          "type": "integer"
      +        },
      +        "card_brand": {
      +          "type": "string"
      +        },
      +        "card_last4": {
      +          "type": "string"
      +        },
      +        "currency": {
      +          "type": "string"
      +        },
      +        "payment_method": {
      +          "enum": [
      +            "plan",
      +            "saved_card"
      +          ],
      +          "type": "string"
      +        },
      +        "quote": {
      +          "type": "string"
      +        }
      +      },
      +      "required": [
      +        "payment_method",
      +        "amount_cents",
      +        "currency"
      +      ],
      +      "type": "object"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "description": "For an organization's fax that's ready to send: how send_fax would pay. plan: the organization's plan covers it, with no charge. saved_card: amount_cents is held on the card ending card_last4 and charged when the fax is delivered. Null when neither can pay."
      +}
  2. Changed4 schema fields changed
    • addedOutput schema / properties / checkout_quote
      Added value: +{
      +  "type": [
      +    "string",
      +    "null"
      +  ]
      +}
    • addedOutput schema / properties / credit_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"
      +}
  3. Changed1 schema field changed
    • addedOutput schema / properties / immediate_sending_consent_required
      Added value: +{
      +  "description": "When true, obtain agreement to immediate sending and acknowledgement that the withdrawal right ends on delivery before calling send_fax.",
      +  "type": "boolean"
      +}
  4. First observed

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, non-destructive and closed-world. The description adds valuable context beyond them: authentication is required, the tool will trigger a sign-in prompt if the user is not signed in, and the rate-limit behavior during sending. It doesn't discuss error cases, but for a read tool the added auth and polling guidance is substantive.

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-loaded with purpose and return fields, followed by source of id, rate limit, auth requirement, and a final reassurance. It is dense but all sentences carry useful information; minor redundancy is the repeated id source already in the schema.

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?

With an output schema present, return format needn't be explained, yet the description still summarizes the key fields. Auth behavior, polling limits, and id provenance round out what an agent needs to call this read-only tool correctly.

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

Parameters3/5

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

The single parameter is fully described in the schema (100% coverage) and the description repeats the source of the id. No extra syntax or format details are added beyond the schema, so baseline 3 applies.

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

Purpose5/5

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

The description states a specific verb (retrieves/checks) and resource (one fax from the person's Faxette account) and lists the data returned: status, price, payment, document file names, and history. It is distinguishable from siblings like get_faxes (plural list) and get_fax_status (status only) by its single-fax scope and broader payload.

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?

It says to use it for one fax and where the id comes from (get_faxes or create_fax), and adds a polling constraint ('while a fax is sending, call it at most once a minute'). It does not explicitly contrast with get_fax_status or get_fax_report, so the agent must infer which sibling to choose when it only wants status.

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.