使用说明
Firefly III MCP服务器-Cloudflare Worker
此包提供了Cloudflare Workers上Firefly III MCP(模型上下文协议)服务器的实现。借助Cloudflare Workers,您可以轻松地将MCP服务器部署到云端,并从全球边缘网络的性能优势中受益。
特性
- 基于Cloudflare Workers的全球边缘部署
- 低延迟和高可用性服务
- 无需服务器维护
- 与Firefly III API无缝集成
- 通过预设或自定义标签提供工具过滤支持
部署方法
一键部署
最简单的方法是使用“部署到Cloudflare Workers”按钮进行一键部署:
手动部署
-
克隆此存储库:
git clone https://github.com/etnperlong/firefly-iii-mcp.git cd firefly-iii-mcp -
安装依赖项:
npm install -
构建项目:
npm run build -
部署到Cloudflare Workers:
cd packages/cloudflare-worker npm run deploy
配置
部署后,您需要在Cloudflare Workers设置中配置以下环境变量:
必需变量
FIREFLY_III_BASE_URL:您的Firefly III实例URL(例如。,https://firefly.yourdomain.com)FIREFLY_III_PAT:您的Firefly III个人访问令牌
可选变量
FIREFLY_III_PRESET:预设要使用的工具(默认、完整、基本、预算、报告、管理、自动化)FIREFLY_III_TOOLS:以逗号分隔的要启用的工具标记列表(如果同时设置了FIREFLY_III_PRESET,则覆盖FIREFLY_IDESET)
预置模式
default:日常使用的基本工具(账户、账单、类别、标签、交易、搜索、摘要)full:所有可用工具basic:核心财务管理工具budget:以预算为重点的工具reporting:报告和分析工具admin:管理工具automation:自动化相关工具
配置步骤
- 转到Cloudflare仪表板
- 导航到工作人员和页面
- 选择已部署的Worker
- 转到“设置”>“变量”
- 将必需和可选变量添加为机密变量
用法
部署和配置后,您可以通过以下URL访问MCP服务器:
https://your-worker-name.your-account.workers.dev/mcp
您可以将此URL提供给MCP兼容的AI工具,使其能够与您的Firefly III实例进行交互。
自定义域名
如果您想使用自己的域,可以在Cloudflare Workers设置中配置自定义域。具体步骤请参考 Cloudflare文档.
技术细节
此软件包是使用 荣誉 框架,并利用Cloudflare Workers的边缘计算能力。
许可证
该项目根据 MIT许可证.