faxforagents-mcp 0.4.2 → 0.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,27 @@
1
1
  # Changelog
2
2
 
3
+ ## 0.5.0 (2026-11-12)
4
+
5
+ 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.
6
+ 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.
7
+ The guide gains the sections `one_time` and `going_live`, also as resources.
8
+
9
+ A sandbox fax is named a simulation in the text of `send_approved_fax` and `get_fax_status`.
10
+ `insufficient_balance` carries the link where a person adds funds and, when the server offers it, the card path for that exact send.
11
+ `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.
12
+ `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`.
13
+ New remedies for `quote_pricing_mismatch`, `one_time_unavailable`, `too_many_pages` and `dispute_open`.
14
+
15
+ The tool definitions, output schemas and guide follow API 1.17.0. The hosted server lists the same 17 tools since 2026-11-12.
16
+ `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.
17
+ `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.
18
+ 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.
19
+ The README names price card launch-v2, effective 2026-10-31.
20
+
21
+ ## 0.4.3 (2026-11-09)
22
+
23
+ `quote_fax` takes `sender_name` (the station name in the fax header) and `delete_after_send`. The tool definitions, guide and output schemas follow API 1.12.0. The resolution text names the measured figures.
24
+
3
25
  ## 0.4.2 (2026-11-09)
4
26
 
5
27
  `quote_fax` takes `quality`: standard, fine (the default), superfine or ultra. The quote text names the level. Same price at every level. Needs API 1.11.0.
package/README.md CHANGED
@@ -23,7 +23,7 @@
23
23
  <a href="https://github.com/faxforagents/mcp/actions/workflows/ci.yml"><img src="https://img.shields.io/github/actions/workflow/status/faxforagents/mcp/ci.yml?branch=main&label=ci" alt="CI"></a>
24
24
  <a href="https://github.com/faxforagents/mcp/blob/main/LICENSE"><img src="https://img.shields.io/badge/licence-MIT-1f6feb" alt="MIT licence"></a>
25
25
  <a href="https://nodejs.org"><img src="https://img.shields.io/badge/node-20%2B-339933" alt="Node 20+"></a>
26
- <a href="https://faxforagents.com/mcp/"><img src="https://img.shields.io/badge/MCP-15%20tools-6b4fbb" alt="MCP"></a>
26
+ <a href="https://faxforagents.com/mcp/"><img src="https://img.shields.io/badge/MCP-17%20tools-6b4fbb" alt="MCP"></a>
27
27
  <a href="https://lobehub.com/mcp/faxforagents-mcp"><img src="https://lobehub.com/badge/mcp/faxforagents-mcp" alt="LobeHub"></a>
28
28
  </p>
29
29
 
@@ -31,7 +31,7 @@
31
31
  faxes. It is made by JSB Holdings LLC and built by [Synapse](https://synapsereality.io/).
32
32
 
33
33
  The hosted server at `https://mcp.faxforagents.com/mcp/` takes your API key on every request. The trailing slash matters.
34
- This package implements the same 15 tool names locally over stdio and calls the REST API.
34
+ This package implements the same 17 tool names locally over stdio and calls the REST API.
35
35
  It reads `FAXFORAGENTS_API_KEY` from the environment and sends it to the API as a bearer credential.
36
36
  It also serves guide resources and two prompts for sending and receiving faxes.
37
37
 
@@ -168,7 +168,7 @@ As a client entry, the same image:
168
168
 
169
169
  ## Tools
170
170
 
171
- The 15 tool definitions are checked against a snapshot exported from the hosted Python source.
171
+ The 17 tool definitions are checked against a snapshot exported from the hosted Python source.
172
172
 
173
173
  | Tool | Does | Scope |
174
174
  |---|---|---|
@@ -182,6 +182,8 @@ The 15 tool definitions are checked against a snapshot exported from the hosted
182
182
  | `list_faxes` | List outbound faxes your organization sent, newest first. | `fax:read` |
183
183
  | `get_fax_balance` | Read available and held wallet funds in the credential's environment. | `billing:read` |
184
184
  | `cancel_fax` | Request cancellation of one outbound fax. | `fax:cancel` |
185
+ | `request_card_payment` | Ask a person to pay for one quoted fax by card, with no wallet balance. | `fax:send` |
186
+ | `get_card_payment_status` | Read one card payment order: whether a person paid, what was charged and the fax it sent. | `fax:read` |
185
187
  | `request_human_review` | Ask a person to approve a quoted send or help with a fax. | `approval:request` |
186
188
  | `get_review_status` | Read the human approval decision for one review request. | `approval:read` |
187
189
  | `list_inbox` | List received faxes on your organization's numbers, newest first. | `inbox:read` |
@@ -199,7 +201,7 @@ accepted the fax. Every string the carrier supplied is named under `untrusted`.
199
201
 
200
202
  The guide is also a resource. `faxforagents://guide` is the whole manual as `text/markdown`, and
201
203
  `faxforagents://guide/{section}` is one section (`overview`, `send`, `states`, `errors`, `approvals`,
202
- `policies`, `agents`, `inbox`, `ocr`). Neither needs a key.
204
+ `policies`, `agents`, `inbox`, `ocr`, `one_time`, `going_live`). Neither needs a key.
203
205
 
204
206
  Two prompts walk a client through the product. `send_a_fax` takes `to` and an optional `summary` and
205
207
  orders the steps: `prepare_fax`, `quote_fax`, `request_human_review` and `get_review_status`,
@@ -228,11 +230,27 @@ The approval path is `request_human_review` with the `quote_id`, then a person d
228
230
  never approve its own send. `unknown` and `partial`
229
231
  never retransmit on their own.
230
232
 
233
+ ## One fax by card
234
+
235
+ `request_card_payment` turns a live quote into an order that a person pays by card, with no wallet
236
+ balance. It is for a send the wallet does not cover, or for a person who wants to pay for one fax only.
237
+ The tool returns `status_url`. Give that link to the person. They accept the acceptable use policy and
238
+ the terms there and pay on a hosted page. The agent cannot accept, pay or confirm, and nothing is sent
239
+ before the person pays.
240
+
241
+ Paying by card does not replace approval. The tool takes the same `approval_id` as `send_approved_fax`,
242
+ or a delegated policy has to allow the send. `get_card_payment_status` reads the order: `next` is
243
+ `checkout`, `confirm`, `wait` or `done`, and once the fax was released the answer carries the fax and
244
+ the carrier's evidence. The card is authorized at payment and charged only for pages the carrier
245
+ reports as arrived. Live keys only, United States and Canada. The guide section `one_time` has the
246
+ steps, and `going_live` says how to get from the sandbox to a real fax.
247
+
231
248
  ## Prices
232
249
 
233
- Price card launch-v1 is effective from 2026-10-28. $0.039 per page sent, $0.019 per page received.
250
+ Price card launch-v2 is effective from 2026-10-31. $0.039 per page sent, $0.019 per page received.
234
251
  $2 per number per month, $19 per month for the Agent workspace. Sandbox pages cost 0.
235
- `get_fax_capabilities` returns the card in force.
252
+ `get_fax_capabilities` returns the card in force. One fax by card has its own price: the order names
253
+ it in `amount_micro`, and the [pricing page](https://faxforagents.com/pricing/) lists it.
236
254
 
237
255
  ## Working on this repository
238
256