faxforagents-mcp 0.5.2 → 0.5.4
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 +49 -0
- package/README.md +6 -3
- package/dist/index.js +916 -52
- package/llms-install.md +1 -1
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,54 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 0.5.4 (2026-11-15)
|
|
4
|
+
|
|
5
|
+
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.
|
|
6
|
+
|
|
7
|
+
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.
|
|
8
|
+
|
|
9
|
+
- `get_fax_balance`: `balance.held_jobs`, the fax jobs whose hold is still in place.
|
|
10
|
+
- `quote_fax`: `quote.route_paused`, true while an operator has paused sends on the route.
|
|
11
|
+
- `prepare_fax` and `get_fax_document`: `document.converted_from`, the name of an image that became the PDF, and `document.received`, the received fax the document came from.
|
|
12
|
+
- `request_human_review` and `get_review_status`: `document`, `requested_by_name` and `decided_by_name` on the review request.
|
|
13
|
+
- `get_fax_capabilities`: `default_scopes` and `admin_scopes`.
|
|
14
|
+
- `send_approved_fax`, `get_fax_status`, `list_faxes`, `cancel_fax` and `get_card_payment_status`: six receipt fields of a one-time order on `one_time`.
|
|
15
|
+
|
|
16
|
+
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.
|
|
17
|
+
|
|
18
|
+
The tool list was taken from the hosted server's `tools/list` on 2026-11-15, when it reported version 1.20.7.
|
|
19
|
+
The list equals the definitions `scripts/import-hosted.py` imported from the product source at v1.20.6.
|
|
20
|
+
`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.
|
|
21
|
+
|
|
22
|
+
## 0.5.3 (2026-11-14)
|
|
23
|
+
|
|
24
|
+
The stdio server follows the hosted server at API 1.20.5.
|
|
25
|
+
|
|
26
|
+
An argument a tool does not list is refused. The answer is `invalid_input` with `isError` true, and nothing is done.
|
|
27
|
+
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.
|
|
28
|
+
`details.unknown_arguments` and `details.accepted_arguments` carry the names. A value is never repeated, and at most five names are.
|
|
29
|
+
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.
|
|
30
|
+
Four names a workflow client adds to every call are still dropped: `sessionId`, `action`, `chatInput` and `toolCallId`.
|
|
31
|
+
Every input schema in the tool list says `additionalProperties: false`.
|
|
32
|
+
|
|
33
|
+
`quote_fax` with a test key and no policy reports `policy.decision: "allow"` and `policy_id: null`.
|
|
34
|
+
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.
|
|
35
|
+
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`.
|
|
36
|
+
`policy` carries `managed`, which is `connected_apps` when the organization's auto-send setting decided.
|
|
37
|
+
|
|
38
|
+
A `not_found` of `quote_fax` says which id was not found. The API names it in `details.field`.
|
|
39
|
+
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.
|
|
40
|
+
Other tools keep the short answer.
|
|
41
|
+
|
|
42
|
+
`get_fax_capabilities` says whose scopes are whose. `me.scopes` is what the API key can do. `capabilities.scopes` is every scope that exists.
|
|
43
|
+
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.
|
|
44
|
+
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.
|
|
45
|
+
The `send_a_fax` prompt says a send goes as it is under a delegated policy or with a test key.
|
|
46
|
+
|
|
47
|
+
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.
|
|
48
|
+
`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.
|
|
49
|
+
`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.
|
|
50
|
+
The README writes the hosted address as `https://mcp.faxforagents.com/mcp/` and no longer says the trailing slash matters.
|
|
51
|
+
|
|
3
52
|
## 0.5.2 (2026-11-14)
|
|
4
53
|
|
|
5
54
|
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.
|
package/README.md
CHANGED
|
@@ -31,7 +31,7 @@
|
|
|
31
31
|
[Fax for Agents](https://faxforagents.com) is a fax API, a hosted MCP server and SDKs built so AI agents can send and receive
|
|
32
32
|
faxes. It is made by JSB Holdings LLC and built by [Synapse](https://synapsereality.io/).
|
|
33
33
|
|
|
34
|
-
The hosted server at `https://mcp.faxforagents.com/mcp/` takes your API key on every request.
|
|
34
|
+
The hosted server at `https://mcp.faxforagents.com/mcp/` takes your API key on every request.
|
|
35
35
|
This package implements the same 17 tool names locally over stdio and calls the REST API.
|
|
36
36
|
It reads `FAXFORAGENTS_API_KEY` from the environment and sends it to the API as a bearer credential.
|
|
37
37
|
It also serves guide resources and two prompts for sending and receiving faxes.
|
|
@@ -274,13 +274,16 @@ npm run pack:mcpb # the Claude Desktop bundle
|
|
|
274
274
|
This package implements tool behavior over REST. It does not forward calls to the hosted MCP endpoint.
|
|
275
275
|
It validates arguments locally and formats REST responses as MCP results.
|
|
276
276
|
Wrong argument types and malformed resource IDs return `ok=false`, `error_code=invalid_input` and `isError=true`.
|
|
277
|
+
An argument the tool does not list gets the same answer. The message names it and, for a near miss, the argument that was meant (`from` for `from_number`, `status` for `state`).
|
|
278
|
+
`details.unknown_arguments` and `details.accepted_arguments` carry the names. Four names a workflow client adds to every call are dropped instead: `sessionId`, `action`, `chatInput` and `toolCallId`.
|
|
277
279
|
The message names the argument, its expected type or ID format, and the correction to make.
|
|
278
280
|
Resource IDs require the correct prefix and exactly 32 lowercase hexadecimal characters.
|
|
279
281
|
Well-formed unknown IDs reach the REST API and return `not_found`.
|
|
280
282
|
Protocol errors, such as a non-object arguments container, remain JSON-RPC errors.
|
|
281
283
|
Tests use hosted responses recorded on 2026-11-02 and a local fake REST API. They need no hosted credentials.
|
|
282
|
-
The tool snapshot is the hosted server's `tools/list` of 2026-11-
|
|
283
|
-
|
|
284
|
+
The tool snapshot is the hosted server's `tools/list` of 2026-11-15, with the tools of API 1.20.6. Normal tests never contact the hosted server.
|
|
285
|
+
`test/hosted-unknown-arguments.json` holds what the hosted source answers for 20 calls with unknown arguments. `test/validation.mjs` compares each one.
|
|
286
|
+
The server does not start when a handler's inputs differ from the tool list. `test/inputs.mjs` calls every listed input over stdio. A wrong type has to be refused and the listed example accepted. An argument a tool does not list has to be refused by name.
|
|
284
287
|
To import definitions before deployment, run the following with the product checkout's Python environment.
|
|
285
288
|
|
|
286
289
|
```bash
|