# Faxbot

> Self-hosted, open source, fax-sending API. HIPAA compliant. This fax API includes MCP (Model Context Protocol) support for AI assistant integration.

- **Type:** MCP server
- **Install:** `agentstack add mcp-dmontgomery40-faxbot`
- **Verified:** Yes — security-reviewed for prompt injection and unsafe behavior
- **Seller:** [DMontgomery40](https://agentstack.voostack.com/s/dmontgomery40)
- **Installs:** 0
- **Category:** [Integrations](https://agentstack.voostack.com/c/integrations)
- **Latest version:** 0.1.0
- **License:** MIT
- **Upstream author:** [DMontgomery40](https://github.com/DMontgomery40)
- **Source:** https://github.com/DMontgomery40/Faxbot
- **Website:** https://faxbot.net/

## Install

```sh
agentstack add mcp-dmontgomery40-faxbot
```

Requires the [AgentStack CLI](https://agentstack.voostack.com/docs/cli). Works with Claude Code, Cursor, and any MCP-compatible agent.

## About

The first and only open‑source, self‑hostable fax platform with a GUI‑first Admin Console, multi‑backend adapters (cloud + self‑hosted), and AI assistant integration.

## GUI‑first: Admin Console
- One place to configure backends, keys, inbound, storage, and run diagnostics.
- Open http://localhost:8080 and use the Admin Console (served by the API).
- Traits‑first UI: screens render only what your active provider supports.

## Why Faxbot
- One API, many backends: Phaxio, Documo, Sinch, SignalWire, and more (cloud), or self‑hosted FreeSWTICH, SIP/Asterisk, or anything else you can dream up.
- Ability to mix and match outbound and inbound providers, total freedom, fit to your infrastructure.
- HIPAA‑aligned controls: HMAC webhook verification, short‑TTL tokens, compliant logging.
- AI integration: official MCP servers (Node & Python) for stdio/HTTP/SSE with Webhook support.
- Identical SDKs: Node.js and Python with the same surface.

## Quick start (Docker Compose)
1) Copy `.env` (see `.env.example`). Pick a backend:
- Phaxio (recommended): set `FAX_BACKEND=phaxio` and `PHAXIO_API_KEY/PHAXIO_API_SECRET`.
- Sinch: set `FAX_BACKEND=sinch`, `SINCH_PROJECT_ID/SINCH_API_KEY/SINCH_API_SECRET`.
> Or one of 20 others that we have pre-made manifests for you to quickly load. 
- SIP/Asterisk: set `FAX_BACKEND=sip` and AMI vars (see docs).

2) Start the API (and Admin Console):
```
docker compose up -d --build api
```

3) Open the Admin Console: http://localhost:8080

Health checks:
- API: `curl http://localhost:8080/health`
- Ready: `curl -i http://localhost:8080/health/ready`

Optional MCP servers:
```
docker compose --profile mcp up -d --build faxbot-mcp
docker compose --profile mcp up -d --build faxbot-mcp-sse
```

## iOS App (TestFlight)

The iOS companion lets you send faxes and check status from your phone. Email david@faxbot.net for an invite.

## SDKs
- Python: `pip install faxbot`
- Node.js: `npm install faxbot`
→ [SDK Usage](docs/SDKS.md)

## Architecture highlights
- Traits‑first capabilities: `/admin/providers` and `/admin/config` expose active providers + traits; UI and API gate features by traits.
- Canonical event & error model: normalized inbound/outbound events, status mapping, and standard error codes.
- Provider adapters: clean boundaries for verify_webhook/parse_inbound/send/status/cancel.

Docs:
- [Canonical Events](docs/api/canonical_events.md)
- [MCP Integration](docs/MCP_INTEGRATION.md)
- [API Reference](docs/API_REFERENCE.md)

## Security
- Use `X-API-Key` (multi‑key) for auth.
- Enforce HTTPS and HMAC signature verification for cloud webhooks.
- No PHI in logs; only IDs/metadata are surfaced.

## Contributing
See [CONTRIBUTING.md](CONTRIBUTING.md). Please open issues/PRs; this project is GUI‑first and traits‑first—avoid backend‑name checks in new code.

## Source & license

This open-source MCP server is cataloged on AgentStack and links to its original source — we do not rehost the code.

- **Author:** [DMontgomery40](https://github.com/DMontgomery40)
- **Source:** [DMontgomery40/Faxbot](https://github.com/DMontgomery40/Faxbot)
- **License:** MIT
- **Homepage:** https://faxbot.net/

Install and usage instructions live in the source repository linked above.

## Pricing

- **Free** — Free

## Security capabilities

Automated source analysis of v0.1.0 — what this tool can access:

- **Network access:** yes
- **Filesystem access:** no
- **Shell / process execution:** no
- **Environment & secrets:** yes
- **Dynamic code execution:** no

*"Yes" means the capability is present in the source — more access means more to trust, not that it is unsafe.*


## Versions

- **0.1.0** — security scan: passed — Imported from the upstream source.

## Links

- Listing page: https://agentstack.voostack.com/l/mcp-dmontgomery40-faxbot
- Seller: https://agentstack.voostack.com/s/dmontgomery40
- Browse the marketplace: https://agentstack.voostack.com/browse

---
Listed on AgentStack — the marketplace for AI agent skills and MCP servers. Every listing is security-reviewed. Creators keep 70%.