关于 ictfax-mcp
ictfax-mcp 是用于访问 ICTFax 的 MCP 服务,可查看传真记录;显式启用写入后,还能上传文档并发送传真,适用于通过 ICTCore REST 连接 ICTFax 的 AI 助手。
主要功能
- 01列出传真传输记录
- 02查询单条传真的状态
- 03启用写入后上传 PDF
- 04启用写入后发送传真
适用场景
- 01查看近期传真记录
- 02确认传真是否发送成功
- 03启用写入后上传并传真 PDF
MCP 相关
向 MCP 客户端提供传真列表和状态查询工具。只有设置 ICTFAX_MCP_ALLOW_WRITE=true 后,才会注册文档上传和传真发送工具。
配置
本地服务的配置在各客户端中通用,复制后粘贴到客户端的 MCP 配置文件即可。
npx -y ictfax-mcpICTFAX_BASE_URLICTCore REST base URL of your ICTFax server, normally ending in /api, e.g. https://your-ictfax/api.ICTFAX_USERNAMEAPI account email (ICTCore logs in by email).ICTFAX_PASSWORD密钥Password for the account.ICTFAX_ACCOUNT_IDAccount id to send faxes from. Defaults to 1.ICTFAX_MCP_ALLOW_WRITEUnlocks uploading documents and sending faxes, which dials a real number and can cost money. When false those tools are not registered at all. Leave off unless you mean it.ICTFAX_TIMEOUT_MSPer request timeout in milliseconds. Defaults to 30000.ICTFAX_TLS_INSECURESkip TLS certificate verification. Only for a self-signed test server.本地服务需要在你的电脑上安装运行环境(如 Node.js 18+)。各客户端的配置文件位置不同,请参考客户端文档。
工具
2收录的工具列表 · 更新于 2 天前
此工具无需参数。
详细介绍
ictfax-mcp
一个适用于 ICTFax 的 Model Context Protocol 服务。ICTFax 是由 ICT Innovations 基于 ICTCore 框架构建的开源传真服务。
它允许 AI 助手列出传真传输记录并检查状态;只有在启用写入功能后,才能上传文档并发送传真。
安装
npx -y ictfax-mcp # no install
npm install -g ictfax-mcp
需要 Node.js 18 或更高版本。
配置
| 变量 | 必填 | 默认值 | |
|---|---|---|---|
ICTFAX_BASE_URL | 是 | ICTCore REST 基础 URL,通常以 /api 结尾,例如 https://your-ictfax/api | |
ICTFAX_USERNAME | 是 | API 账户邮箱(ICTCore 使用邮箱登录) | |
ICTFAX_PASSWORD | 是 | 该账户的密码 | |
ICTFAX_ACCOUNT_ID | 否 | 1 | 用于发送传真的账户 ID |
ICTFAX_MCP_ALLOW_WRITE | 否 | false | 解锁上传和发送功能(参见安全性) |
ICTFAX_TIMEOUT_MS | 否 | 30000 | 每个请求的超时时间 |
ICTFAX_TLS_INSECURE | 否 | false | 跳过 TLS 验证——仅用于自签名测试服务 |
Claude Desktop 示例
{
"mcpServers": {
"ictfax": {
"command": "npx",
"args": ["-y", "ictfax-mcp"],
"env": {
"ICTFAX_BASE_URL": "https://your-ictfax/api",
"ICTFAX_USERNAME": "[email protected]",
"ICTFAX_PASSWORD": "your-password"
}
}
}
}
工具
读取工具始终可用:
| 工具 | 功能 |
|---|---|
ictfax_list_faxes | 列出传真传输记录(ID、联系人、状态、方向) |
ictfax_get_fax_status | 按 ID 查询单条传真传输记录的状态 |
仅当 ICTFAX_MCP_ALLOW_WRITE=true 时,才会提供写入工具:
| 工具 | 功能 |
|---|---|
ictfax_upload_document | 将本地 PDF 上传为传真文档;返回一个 document_id |
ictfax_send_fax | 将本地文档作为传真发送至指定号码——会拨打真实号码 |
安全性
该服务默认只读。发送传真会拨打真实号码并可能产生费用,因此除非设置 ICTFAX_MCP_ALLOW_WRITE=true,否则根本不会注册 ictfax_upload_document 和 ictfax_send_fax。
连接方式
ICTFax 运行在 ICTCore 上,通过 POST /authenticate 获取 JWT 进行身份验证(使用邮箱登录),并从 Authorization: Bearer 标头读取 JWT。发送传真需要执行一系列操作,服务会代你完成:上传文档(先上传元数据,再上传原始字节;ICTFax 会将其转换为传真格式)、创建收件人和 sendfax 程序、创建传真传输记录并发送。
关于
由 Tahir Almas 在 ICT Innovations 开发——该团队也是 ICTFax、ICTPBX、ICTContact、ICTDialer 以及这些产品共用的 ICTCore 框架的幕后团队。ICTFax 免费且开源;了解详情,请访问 ictfax.org。
采用 MIT 许可证。欢迎在 github.com/ictinnovations/ictfax-mcp 提交问题和 PR。
评论
一个开放协议,规定了 AI 应用如何以统一方式连接外部工具与数据源。客户端负责与模型对话,MCP 服务负责提供工具、资源和提示模板,两者通过标准消息通信,同一个服务可以被不同客户端复用。