article
README
🚀 RentSmart MCP
RentSmart 是一款由人工智能驱动的 WhatsApp 聊天机器人,可即时生成租赁协议和收据。本仓库包含了 RentSmart 的一个最小化多通道插件(MCP)服务。
🚀 快速开始
python -m venv .venv
source .venv/bin/activate # 若使用 Windows 系统,请使用 .venv\Scripts\activate
pip install -r requirements.txt
uvicorn app.main:app --reload --port 8000
访问 http://localhost:8000/health 以验证服务器是否正常运行。
✨ 主要特性
- /validate:执行简单的令牌检查,并返回一个虚拟电话号码。你可以在
app/main.py中更新令牌,以确保部署的安全性。 - /tool/generate_agreement:接收租赁协议的详细信息,填充文本模板,将其转换为 PDF 文件,并通过
/files/agreements下的公共链接提供下载。 - /tool/generate_rent_receipt:根据指定的详细信息创建 PDF 租金收据,并在
/files/receipts下提供访问。 - /tool/stamp_duty_info:返回特定州的印花税信息,方便快速参考。示例中提供了一组默认值,可轻松扩展以涵盖所有印度邦。
- /health:一个简单的心跳检查端点,返回
{"status":"ok"}。
📦 安装指南
- 创建并激活虚拟环境:
python -m venv .venv source .venv/bin/activate # 若使用 Windows 系统,请使用 .venv\Scripts\activate - 安装依赖:
pip install -r requirements.txt - 启动服务:
uvicorn app.main:app --reload --port 8000
📚 详细文档
目录结构
rentsmart_mcp/
├── app/
│ ├── __init__.py
│ ├── main.py # FastAPI 应用程序
│ └── templates/
│ ├── agreement_template.txt
│ └── receipt_template.txt
├── files/ # 生成的 PDF 文件将保存于此
├── requirements.txt # Python 依赖项
└── README.md
部署
你可以将该服务部署在任何支持 FastAPI 的平台上,如 Render、Railway、Vercel 或你自己的服务器。为了与 Puch AI 兼容,请确保通过 HTTPS 公开服务。
Puch AI 集成
部署完成后,在你的 WhatsApp 聊天中使用 /mcp connect 命令将 MCP 服务连接到 Puch AI。请将以下 URL 和令牌替换为你自己的部署信息:
/mcp connect https://YOUR-DEPLOYED-URL your_test_token
连接成功后,你将看到可用的工具(generate_agreement、generate_rent_receipt 和 stamp_duty_info)。
自定义
- 模板:编辑
app/templates中的文件,以自定义生成的协议和收据的布局和措辞。花括号中的占位符(例如{landlord}、{rent})将被 JSON 请求中提供的值替换。 - 印花税数据:修改
app/main.py中的STAMP_DUTY_DATA字典,以反映准确的各州印花税费用和链接。本示例仅包含几个邦作为演示。 - 令牌验证:更改
app/main.py中的VALID_TOKEN常量,以实施你自己的令牌验证。在生产环境中,你应该实现适当的身份验证机制。
📄 许可证
本项目作为开源项目提供,可用于黑客马拉松或教育用途。你可以根据自己的需求自由修改和扩展。
微信扫一扫