Skip to main content
Glama

Check a fax

get_fax_status
Read-onlyIdempotent

Use this when the person asks how their fax is doing, or to see whether it's ready to pay. It reads the fax from its status_url and returns its status, page count, price, payment and attempts. checkout_available is true once the person can pay on the status page. It changes nothing. While a fax is sending, call it at most once a minute.

Input Schema

NameRequiredDescriptionDefault
status_urlYesThe status_url create_fax returned, like https://eu.faxette.com/f/abc123?token=xyz.

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. Changed3 schema fields changed
    • 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"
      +}
  2. First observed

TDQS

A4.5/5.0
Behavior5/5

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

Annotations already establish readOnly/idempotent/non-destructive, and the description still adds value: 'It changes nothing', the polling rate limit during send, the exact returned fields, and the meaning of checkout_available as the pay-readiness signal. That is behavior beyond what structured fields declare.

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

Conciseness5/5

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

Front-loaded with the use case, then return contents, then the checkout_available rule, then the constraint. Six short sentences, each carrying distinct information with no repetition of the title or 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?

For a single-parameter read tool with full annotations and an output schema, the description covers use case, return payload, key field semantics, and polling limits. Nothing an agent needs to invoke or interpret it is missing.

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?

Schema coverage is 100% and the single status_url parameter is fully documented in the schema (including provenance from create_fax). The description's mention that it reads from status_url only echoes the schema, so baseline 3 applies.

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 (reads the fax from its status_url and returns status, page count, price, payment, attempts) rather than restating the name. Purpose is unambiguous, but it never distinguishes itself from the sibling get_fax, which an agent could plausibly pick for the same request.

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

Usage Guidelines5/5

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

Gives explicit triggering conditions: 'when the person asks how their fax is doing, or to see whether it's ready to pay.' It also adds an operational constraint that shapes call frequency ('while a fax is sending, call it at most once a minute'), leaving little to inference.

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.