Skip to main content
Glama

Open a received fax

get_inbound_fax
Idempotent

Use this for one received fax: who sent it, when, how many pages, and pdf_url, a link to its PDF for 5 minutes, for apps that can download files. Getting the link marks the fax read for the person. To read what the fax says in the chat, use read_inbound_fax instead. Needs the person to sign in to Faxette.

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

Input Schema

NameRequiredDescriptionDefault
idYesThe fax's id from get_inbound_faxes.
organizationYesThe organization's id from get_organizations. Ask the person which one if there are several.

Output Schema

NameRequiredDescriptionDefault
idYesPass it to get_inbound_fax or read_inbound_fax.
urlYesThe fax's page in the organization's inbox. Give it to the person.
readYesWhether the signed-in person has opened it.
lockedYesTrue when it arrived after the organization's plan ended. Nobody can open it until an owner restarts the plan.
statusYesfailed: the sender's machine gave up before the fax arrived.
pdf_urlYesThe PDF, for 5 minutes. Null when the fax is locked, failed or its document was deleted.
to_nameYesThat number's name, like Front desk.
to_numberYesWhich of the organization's numbers it was sent to.
page_countYes
from_numberYesWho sent it. Null when the sender hid their number.
received_atYes
failure_reasonYes
document_deletedYesTrue once the document has been deleted. Faxette deletes them 30 days after they arrive.
document_deleted_onYesWhen the document is or was deleted.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.6/5.0
Behavior5/5

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

Annotations declare readOnlyHint=false, and the description explains exactly why: 'Getting the link marks the fax read for the person' — a side effect an agent could not infer from the schema. It also discloses the 5-minute link expiry and the sign-in requirement, which are behavioral facts no structured field carries.

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?

The content is dense and front-loaded with the return payload before the routing hint and the side effect. The first sentence is a long run-on that packs fields, expiry, and an audience qualifier together, which costs a little readability but wastes no words.

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?

An output schema exists, yet the description still summarizes the key return fields, plus it covers the two things the schema cannot: the read-marking side effect and the auth requirement. For a two-parameter read-with-side-effect tool, nothing material 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 description coverage is 100%, so both parameters (id, organization) are already documented in the schema, including where to source each value. The description adds nothing about parameters beyond implying a single fax is targeted, which is the baseline for fully covered schemas.

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 names a specific resource (one received fax) and enumerates exactly what it returns: sender, timestamp, page count, and pdf_url. It also explicitly separates this tool from read_inbound_fax, so an agent can pick between them without opening either schema.

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?

It gives a positive usage condition ('for apps that can download files'), names the alternative and the condition that selects it ('To read what the fax says in the chat, use read_inbound_fax instead'), and states a prerequisite ('Needs the person to sign in to Faxette'). When-to-use, when-not-to-use, and prerequisites are all 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.