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.

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
checkout_quoteNo
failure_reasonYesFor a failed fax: temporary (busy or no answer on every attempt), wrong_number (no fax machine answered), or our_side.
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. 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"
      +}
  2. 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"
      +}
  3. First observed

TDQS

A4.1/5.0
Behavior5/5

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

Adds two traits the annotations do not carry: an authentication requirement (the person must be signed in, and an unauthenticated call triggers a sign-in prompt) and a rate limit during sending. 'It changes nothing' merely restates readOnlyHint, but the auth flow and polling throttle are substantive behavioral disclosures.

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?

Three tight sentences: purpose first, then provenance of the id and the throttle, then auth behavior. Nothing is buried and only the closing 'It changes nothing' is mildly redundant with the read-only annotation.

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

Completeness4/5

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

With an output schema present and annotations covering the safety profile, the description covers auth, rate limiting, and id sourcing, which is close to sufficient. The remaining gap is telling the agent when to prefer this over get_fax_status or get_fax_report.

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 'id' parameter is documented in the schema itself, so the description's note that the id comes from get_faxes or create_fax duplicates structured data rather than extending it. Baseline 3 applies when the schema already does the work.

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 ('one fax from the person's Faxette account') and enumerates what it returns: status, price, payment, document file names, history. It does not, however, distinguish itself from close siblings like get_fax_status, get_fax_report, or get_faxes, so an agent still has to infer which of the several fax-reading tools to pick.

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 concrete when-to-use context: pass an id obtained from get_faxes or create_fax, and throttle to at most once a minute while a fax is sending. No exclusions or explicit comparison against get_fax_status/get_fax_report are offered, so the routing guidance is clear but incomplete for a 15-tool family.

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.