# FinancialBot

> This skill should be used when the user asks to "将 FinancialBot 变成 Claude Skill", "启动 FinancialBot", "运行 FinancialBot API", "配置 FinancialBot 存储路径", "配置 FINANCIALBOT_SKILL_HOME", or mentions "skill-home" / "FINANCIALBOT_SKILL_HOME".

- Author: Nie Jie
- Repository: datanger/FinancialBot
- Version: 20260208231335
- Stars: 0
- Forks: 0
- Last Updated: 2026-02-08
- Source: https://github.com/datanger/FinancialBot
- Web: https://mule.run/skillshub/@@datanger/FinancialBot~FinancialBot:20260208231335

---

---
name: FinancialBot
description: This skill should be used when the user asks to "将 FinancialBot 变成 Claude Skill", "启动 FinancialBot", "运行 FinancialBot API", "配置 FinancialBot 存储路径", "配置 FINANCIALBOT_SKILL_HOME", or mentions "skill-home" / "FINANCIALBOT_SKILL_HOME".
version: 0.1.0
---

# FinancialBot (Claude Skill)

## 目标

将 FinancialBot 作为一个可复用的 Claude Skill 来使用，并实现：

- 执行代码（本仓库的 Python 模块）与 Skill 目录解耦
- 运行时短期/长期存储落盘到 Skill 目录（而不是执行代码目录）
- 启动时通过传入 Skill 位置决定存储位置（支持 Skill 在不同路径下复用）

## 核心约定：Skill 目录承载“代码 + 状态 + 文档 + 示例”

本 Skill 为“自包含”目录：包含执行代码 + 文档 + 示例脚本 + 运行时存储。

Skill 目录：`<skill-home>/`（可在任意路径；本仓库内为 `skills/financialbot/`）

默认状态布局（由 `FINANCIALBOT_SKILL_HOME`/`--skill-home` 触发）：

- SQLite（短期记忆 + jobs）：`<skill-home>/_data/financialbot.sqlite3`
- Markdown（长期知识库 laws/strategies/principles）：`<skill-home>/_data/memory/<topic>/<level>.md`

更详细的路径解析规则见：`skills/financialbot/references/paths.md`。

## 启动方式（推荐：从 Skill 目录启动）

1) 安装依赖（执行代码在 Skill 根目录中运行；依赖与原项目一致）

```bash
cd skills/financialbot
python -m pip install -r requirements.txt
```

2) 启动 API（脚本会自动把存储写入 `<skill-home>/_data`）

```bash
python scripts/run_api.py
```

3) 验证

- OpenAPI：`GET /docs`
- Web UI：`GET /`

## API 调用说明（摘要）

核心调用链路（异步 UI/任务模式）：

- `POST /process` -> 返回 `job_id`
- `GET /jobs/{job_id}` -> 查询进度与结果

同步接口：

- `POST /content` -> 直接返回评估结果（更简单）

完整接口与示例代码见：`skills/financialbot/references/api.md`。

## 常见使用方式

- 为不同的业务/客户/策略拆分多个 Skill 目录：分别传入不同的 `--skill-home`，即可获得物理隔离的短期 DB 与长期知识库。
- 在同一份执行代码上，切换不同 Skill 状态：只需变更 `--skill-home`。

## 相关代码位置（Skill 内）

- 服务入口：`skills/financialbot/api/main.py`（FastAPI app）
- 启动封装：`skills/financialbot/scripts/run_api.py`
- 短期存储（SQLite）：`skills/financialbot/storage/database.py`
- 长期存储（Markdown）：`skills/financialbot/storage/markdown_longterm.py`