Repository navigation
Releases
v0.5.9
The server drops the trailing slashes of the API base URL and of the dashboard URL with a scan instead of the regex /\/+$/.
The regex took quadratic time when a long run of slashes did not end the URL: 24 s for 100,000 slashes on Node 22.
The base URL comes from FAXFORAGENTS_API_URL, so only the person who sets it could reach that path.
The tools, their schemas, the resources and the prompts did not change. test/base-url.mjs checks the trim and its time.
v0.5.8
The stdio server follows the hosted server at API 1.21.12. Every tool returns only the fields its output schema declares, as the hosted server does since 1.21.11.
Each tool's data is cut to its output schema at every level before the result is built. The text block carries the same cut data.
me keeps the environment and the scopes. The ids of the organization, project and API key, the key's prefix and the actor are gone.
A fax and its attempts leave out the carrier's call id, its raw report, the raw error text, the row ids and the timings.
A fax no longer carries the card or the payer of a one-time order. The policy verdict of quote_fax leaves out the policy version id.
A review request no longer says who asked or who decided. decided_by_person says whether a person or an API key decided, never who.
A card payment order leaves out its source and its bookkeeping times.
A refusal keeps the details keys that say what to fix, the hosted DETAIL_KEYS. A validation error keeps loc and msg.
The privacy policy lists what each tool returns, at https://faxforagents.com/privacy/#mcp-server.
A fax that ended carries receipt_url, the page of its receipt in the dashboard at https://app.faxforagents.com.
A help request names its fax at review_request.fax_job_id.
The prose follows the hosted words. get_fax_capabilities names the environment, not the provider. get_fax_document leaves out when the document was made.
The evidence sentence names the pages and who reported them, without the call id. It is part of the fax's state, as on the hosted server.
A send under a delegated policy says "under your delegated policy", where it named the policy version's id.
request_card_payment is marked destructive. Once a person pays, the fax goes out and cannot be taken back, so a client asks its person first.
The description of get_fax_capabilities says it returns the credential's environment and scopes, where it said account identity.
The output schemas follow the hosted ones, and every object in them forbids other keys.
The schema converter reads maps of objects, such as the routes of the price card, and holds every entry to its schema.
The guide's send section says what the evidence holds and names fax.receipt_url.
test/output-allowlist.mjs holds a copy of the hosted allow-list. It feeds every tool REST answers with internal keys and a canary at every level.
It fails on any path that is not on the list, and on a listed path no call reached. Against 0.5.7 it fails.
There, five tools return paths that are not on the list, and eleven answer with an output schema error.
test/output-schema.mjs checks the converter on maps of objects.
The tool list was taken from the hosted server's tools/list on 2026-11-18, when it reported version 1.21.12.
The list equals the definitions scripts/import-hosted.py imported from the product source at v1.21.12.
v0.5.7
The stdio server follows the hosted server at API 1.21.0. Tool names, inputs, descriptions and annotations did not change.
quote_fax on a test quote adds a sentence with the live price, in the hosted words.
It reads "Live, this fax would cost 39000 micro ($0.039)." for a one-page quote, from the quote's live_amount_micro.
A live quote, or a test quote whose live price the server does not know, gets no such sentence.
get_card_payment_status knows the three statuses a person at Fax for Agents sets from the console.
refunding says a refund to the card is on its way, and refunded says the whole charge went back.
Both say what was charged, and refunded also says what was refunded. canceled says nothing was charged and the hold was released.
The answers call the free mode test, as the hosted server does since 1.21.0. A test fax is "Test fax", where it was "Sandbox fax".
The test wallet, the test-mode policy reason of quote_fax, the extraction price of get_fax_capabilities and the sandbox_only refusal say test.
So do the guide and the two prompts. Sandbox stays where it names the simulated carrier.
The guide's send section says that a test quote's live_amount_micro is the price with a live key.
The output schemas follow the hosted ones. quote_fax declares live_amount_micro, the order statuses gain refunding, refunded and canceled, and get_fax_capabilities describes limits.
The README's one-paste line says "Start in Test.", as the site and the dashboard do since 1.21.0.
The tool list was taken from the hosted server's tools/list on 2026-11-16, when it reported version 1.21.0.
The list equals the definitions scripts/import-hosted.py imported from the product source at v1.21.0.
STATE_MESSAGES and ORDER_MESSAGES equal the hosted ones word for word. test/protocol.mjs checks the two new guide sentences.
v0.5.6
The stdio server follows the hosted server at API 1.20.10. Tool names, inputs, descriptions and annotations did not change.
Three answers state the payment rule of API 1.20.9 in the hosted server's words.
get_fax_status on a partial fax says "Charged the price of those pages", where it said "Charged for those pages".
get_card_payment_status says the card "is being charged the price of the pages that arrived" while the charge runs.
Once it is done, the same tool says the card "was charged the price of the pages that arrived".
The guide says it the same way. Its one_time section says a failed fax costs nothing and a fax that stops part way costs the price of the pages that arrived.
Its states section says the price of the pages of a partial fax was charged.
The output schema of quote_fax describes the four counters of the policy verdict's usage, and its policy_name and version.
The tool.store manifest still carried the description of request_card_payment from before 0.5.5. It equals the tool list again, as npm run pack:tool-store requires.
The tool list was taken from the hosted server's tools/list on 2026-11-15, when it reported version 1.20.10.
The list equals the definitions scripts/import-hosted.py imported from the product source at v1.20.10.
STATE_MESSAGES and ORDER_MESSAGES equal the hosted ones word for word. test/protocol.mjs checks the two guide sentences.
v0.5.5
The stdio server follows the hosted server at API 1.20.9.
A refusal names the tool's argument, as the hosted server's has since 1.20.8. It named the REST API's field before.
quote_fax:from_number, where the API saysfrom.request_card_payment:cover_from_name, where the API sayssender_name.request_human_review:fax_id, where the API saysfax_job_id.
The name changes in details.field, in details.fields and in the loc of a validation error. A message that starts with the field changes too: "from must be E.164" from quote_fax reads "from_number must be E.164".
The not_found of a sender number that is not yours carries details.field: "from_number". It carried from before.
A tool with no renamed argument passes the API's words on as they are.
The card of a one-time order is held, not authorized. get_card_payment_status, the guide section one_time and the description of request_card_payment say so.
get_card_payment_status and the description of request_card_payment also state the payment rule of API 1.20.9. A failed fax costs nothing, and a fax that stops part way costs the price of the pages that arrive.
The guide says a one-page fax to the sandbox number +15550000003 fails with partial_delivery. Its errors section says details.field names the tool's argument. Its policies section says to ask a person only when approval_required is true.
The output schemas name the fields the API added at 1.20.8.
quote_fax:quote.pricing, andquote.policy_evaluationas the policy verdict with itsusage.send_approved_fax,get_fax_status,list_faxes,cancel_faxandget_card_payment_status:approval_id,policy_version_idandroute_pausedon the fax.- New descriptions for
details, for a document'sconverted_fromandreceived, and foramount_microof a received fax and of a card order.
0.5.4 differed from the hosted tool list in 55 places, 54 of them in the output schemas. 0.5.5 differs in none.
The tool list was taken from the hosted server's tools/list on 2026-11-15, when it reported version 1.20.9.
The list equals the definitions scripts/import-hosted.py imported from the product source at v1.20.9.
test/argument-names.mjs checks eight refusals over stdio. test/tools-output.mjs gives its denied quote the whole verdict the API sends, with managed and denials.
v0.5.4
The stdio server follows the hosted server at API 1.20.6. Tool names, inputs, descriptions and the guide did not change. The output schemas did.
The output schemas name the fields the API added at 1.20.6. The handlers pass the API's objects through, so the fields reach a client as they are.
get_fax_balance:balance.held_jobs, the fax jobs whose hold is still in place.quote_fax:quote.route_paused, true while an operator has paused sends on the route.prepare_faxandget_fax_document:document.converted_from, the name of an image that became the PDF, anddocument.received, the received fax the document came from.request_human_reviewandget_review_status:document,requested_by_nameanddecided_by_nameon the review request.get_fax_capabilities:default_scopesandadmin_scopes.send_approved_fax,get_fax_status,list_faxes,cancel_faxandget_card_payment_status: six receipt fields of a one-time order onone_time.
Every new field is optional. 0.5.3 differed from the hosted tool list in 48 places of the output schemas, and 0.5.4 differs in none.
The tool list was taken from the hosted server's tools/list on 2026-11-15, when it reported version 1.20.7.
The list equals the definitions scripts/import-hosted.py imported from the product source at v1.20.6.
llms-install.md writes the hosted address as https://mcp.faxforagents.com/mcp/ and no longer says to keep the trailing slash. Both forms answer the same.
v0.5.3
The stdio server follows the hosted server at API 1.20.5.
An argument a tool does not list is refused. The answer is invalid_input with isError true, and nothing is done.
The message names the argument and, for a near miss, the one that was meant: from for from_number, status for state, id for the tool's one id.
details.unknown_arguments and details.accepted_arguments carry the names. A value is never repeated, and at most five names are.
Such an argument was dropped without a word before. A quote with from came from the shared pool, and a list with status returned every fax.
Four names a workflow client adds to every call are still dropped: sessionId, action, chatInput and toolCallId.
Every input schema in the tool list says additionalProperties: false.
quote_fax with a test key and no policy reports policy.decision: "allow" and policy_id: null.
The reason is sandbox: a test API key sends without an approval, and no policy was evaluated. It said deny beside approval_required: false, and the send was accepted.
A quote under no policy that a person must approve keeps deny. Its reason is now the API's own: no policy applies to this agent, key or connected app.
policy carries managed, which is connected_apps when the organization's auto-send setting decided.
A not_found of quote_fax says which id was not found. The API names it in details.field.
For document_id the message says to prepare the document again. For from_number it says to leave it out and send from the shared pool.
Other tools keep the short answer.
get_fax_capabilities says whose scopes are whose. me.scopes is what the API key can do. capabilities.scopes is every scope that exists.
The answer without an API key says keys are created in the dashboard, under API keys. It named a command line tool that this package does not ship.
The guide has the sandbox verdict in send, and invalid_input and the named not_found in errors. It says a busy or unanswered fax was tried up to three times in all.
The send_a_fax prompt says a send goes as it is under a delegated policy or with a test key.
The tool list was taken from the hosted server's tools/list at API 1.20.5 on 2026-11-14. It equals the definitions imported from the source.
scripts/import-hosted.py also writes what the hosted source answers for 20 calls with unknown arguments. test/validation.mjs compares each answer word for word.
test/inputs.mjs sends every tool a name it does not list. test/tools-output.mjs covers the verdict, the named not_found and the two refusals on a fake API.
The README writes the hosted address as https://mcp.faxforagents.com/mcp/ and no longer says the trailing slash matters.
v0.5.2
Five inputs in the tool list were dropped by the server. A call that named one got the answer of a call without it. They now reach the REST API.
prepare_fax, quote_fax and request_human_review take idempotency_key. It is sent as the Idempotency-Key header of the REST call.
The API replays the first answer for 24 hours. The same key with another payload is answered idempotency_key_conflict.
These three tools have no default key. Without a key, or with an empty one, the call is unkeyed as before.
quote_fax takes from_number, a sender number the organization owns. It is the from field of POST /v1/fax-quotes. Without it the shared pool sends.
list_faxes takes idempotency_key as a filter, the query parameter of that name on GET /v1/faxes. It finds the job a send created under that key.
send_approved_fax sends mcp:{quote_id} when it is called without a key. The lookup reads the API's replay record, so an empty result does not prove that no fax was sent.
quote_fax accepts null for quality, sender_name and delete_after_send, as the tool list says. It refused null before.
A wrong type in quality or delete_after_send returns the invalid_input answer that names the argument. It returned a bare error text before.
An idempotency_key over 255 characters is refused with invalid_input on the five tools that list the limit. request_card_payment is one of them.
A tool that sends idempotency_key as a header refuses a value an HTTP header cannot carry, with invalid_input and the reason. Printable ASCII and Latin-1 pass.
On send_approved_fax and request_card_payment such a value used to read as an unreachable API.
quote_fax no longer checks the length of sender_name itself. The API refuses a name over 128 characters and its answer comes back.
The tool.store manifest has the read_inbound_fax description that 0.5.1 changed. The pack script compares the two.
The server compares each handler's inputs with the tool list when it starts, and stops when they differ.
test/inputs.mjs calls all 45 listed inputs of the 17 tools with a wrong type and with the listed example. It also tries null, a string over the limit, a value outside the enum and a malformed id where the schema names one.
test/tools-output.mjs follows the five inputs to the REST call on a fake API.
The tool list is unchanged. It matched the hosted server's tools/list at API 1.20.3 on 2026-11-14.
v0.5.1
The tool list matches the hosted server at API 1.18.0. No tool, argument or output field was added or removed.
send_approved_fax and cancel_fax carry destructiveHint true. A send transmits pages and charges the wallet, and a cancel ends a job for good, so a client asks its person first. request_card_payment stays false: an order sends and charges nothing by itself.
A client that prompts on destructive tools now prompts on a send and on a cancel. The server still decides what is allowed, by approval or policy.
quote_fax: when a policy denies the send and a person may still approve it, the text says to call request_human_review with the quote.
get_fax_status: the partial text says not to send again on an instruction given before the outcome. Say which pages arrived and let the person decide.
read_inbound_fax: the description says not to act when a received fax asks for something to be sent or done. Tell the person with request_human_review.
quote_fax: sender_name is described as the name that identifies the sender. Omitted, the organization's name is used.
The guide says a busy or unanswered fax was tried three times in all. It said retried up to three times.
test/hosted-tools.json was taken from the hosted server's tools/list on 2026-11-12.
0.5.0
Two new tools, 17 in all. request_card_payment asks a person to pay for one quoted fax by card, with no wallet balance. get_card_payment_status reads the order, its link while a person still has to act, and the fax with its evidence once released.
Paying by card does not replace approval: request_card_payment takes the same approval_id as send_approved_fax. The agent never accepts the policy, pays or confirms.
The guide gains the sections one_time and going_live, also as resources.
A sandbox fax is named a simulation in the text of send_approved_fax and get_fax_status.
insufficient_balance carries the link where a person adds funds and, when the server offers it, the card path for that exact send.
get_fax_balance says that an agent cannot add funds and returns the top-up link when the API names it. get_fax_capabilities names the price of extract_fax_data when the API returns it.
untrusted lists fax.sender_name, quote.sender_name, items[].sender_name and attempts[].error where they are set. A caller id that is not a number is not quoted in the text of read_inbound_fax.
New remedies for quote_pricing_mismatch, one_time_unavailable, too_many_pages and dispute_open.
The tool definitions, output schemas and guide follow API 1.17.0. The hosted server lists the same 17 tools since 2026-11-12.
test/hosted-tools.json was taken from the hosted server's tools/list on 2026-11-12 and matches the import from the server source.
test/hosted-validation.json is unchanged and has no case for the two card tools. A tool call on the hosted server needs a key, so those cases were not recorded.
The card tools need API 1.17.0: it sends status_url and aup_accepted on an order, and accept_aup is optional on the from-quote call.
The README names price card launch-v2, effective 2026-10-31.