# ashare-mcp

[![CI](https://github.com/yli769227-jpg/ashare-mcp/actions/workflows/ci.yml/badge.svg)](https://github.com/yli769227-jpg/ashare-mcp/actions/workflows/ci.yml)
[![Python](https://img.shields.io/badge/python-3.10%20%7C%203.11%20%7C%203.12-blue.svg)](https://www.python.org/)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](./LICENSE)

> **Turn Chinese A-share (沪深京) financial statements into tools your LLM can call.**
> 把 A 股财报变成 LLM 可调的工具 —— 一句"平安银行 2024 年报怎么样?"直接拿到结构化三大表。

<p align="center">
  <img src="assets/demo.gif" width="720" alt="Ask Claude about Ping An Bank's 2024 financials via ashare-mcp, get a structured table back">
</p>

让 Claude(或任何 MCP 客户端)用一句"平安银行 2024 年报怎么样?"直接拿到结构化的资产负债表 / 利润表 / 现金流量表,字段经过精选、单位明确、缓存友好。

数据来源东方财富,通过 [akshare](https://github.com/akfamily/akshare),全部免费、无需 token。

---

## 为什么再做一个

GitHub 上"金融 LLM"项目大多卷在 **trading agent** 和 **SEC 10-K RAG**——前者同质化严重,后者只服务美股。**A 股 + 中文 + MCP 协议层** 的组合几乎空白。

`ashare-mcp` 的定位很窄:**做 A 股财报这一件事,做到能被任何 LLM 客户端十秒接入**。它不预测股价、不写研报、不替你做决策——它只把数据从东方财富搬到 LLM 的工具调用里,字段干净、单位清楚、错误明确。

## 快速开始

```bash
git clone https://github.com/yli769227-jpg/ashare-mcp.git
cd ashare-mcp
python3 -m venv .venv && source .venv/bin/activate
pip install -e .
```

跑一次冒烟测试:

```bash
python -c "from ashare_mcp.data_source import get_annual_statements; \
  r = get_annual_statements('SZ000001', 2024); \
  print(r['company_name'], r['balance_sheet']['TOTAL_ASSETS'])"
# -> 平安银行 5769270000000.0
```

## 接入 Claude Desktop

编辑 `~/Library/Application Support/Claude/claude_desktop_config.json`(Mac):

```json
{
  "mcpServers": {
    "ashare": {
      "command": "/absolute/path/to/ashare-mcp/.venv/bin/python",
      "args": ["-m", "ashare_mcp.server"]
    }
  }
}
```

重启 Claude Desktop,就能直接问:

> 帮我看一下平安银行 2024 年报,总资产、总负债、净利润、经营性现金流分别多少?

## 工具列表

| 工具 | 输入 | 输出 |
|---|---|---|
| `get_three_statements` | `stock_code`, `year` | 年报三大表(精选 ~150 字段)|
| `cross_check_balance` | `stock_code`, `year` | 4 条勾稽校验(3 条通用 + 1 条行业感知)+ 误差 |
| `compare_peers` | `stock_codes[]`, `year`, `metrics?` | 同业 N 家横向对比 + 排名 / max-min-avg-std + ROE |
| `track_company_history` | `stock_code`, `years`, `metrics?` | 跨年时间序列 + YoY / CAGR / trend / anomalies |
| `parse_document` *(需 `[pdf]` extra)* | `file_path`, `output_format?`, `lang?` | PDF / DOCX / PPTX / 图片 → LLM-ready markdown(MinerU)|

代码归一化支持 `000001` / `SZ000001` / `sz.000001` / `000001.SZ` 多种格式。

`cross_check_balance` 当前包含 4 条勾稽(前 3 条行业通用,第 4 条行业感知):

1. **资产负债平衡** — `TOTAL_ASSETS = TOTAL_LIABILITIES + TOTAL_EQUITY`
2. **现金流恒等式** — `NETCASH_OPERATE + NETCASH_INVEST + NETCASH_FINANCE + RATE_CHANGE_EFFECT = CCE_ADD`
3. **期末/期初现金对账** — `END_CCE − BEGIN_CCE = CCE_ADD`
4. **营业利润分解(行业感知)**
   - **银行**:`OPERATE_PROFIT = OPERATE_INCOME − OPERATE_EXPENSE`
   - **工商企业**:`OPERATE_PROFIT = TOTAL_OPERATE_INCOME − TOTAL_OPERATE_COST + OTHER_INCOME + INVEST_INCOME + FAIRVALUE_CHANGE_INCOME + ASSET_IMPAIRMENT_INCOME + CREDIT_IMPAIRMENT_INCOME + ASSET_DISPOSAL_INCOME [+ EXCHANGE_INCOME]`
   - **行业自动识别**:有 `ACCEPT_DEPOSIT > 10 亿` 走银行公式,有 `TOTAL_OPERATE_INCOME` + `TOTAL_OPERATE_COST` 走工商公式,否则 `skipped`(保险等暂不支持)

容忍度:前 3 条 1 万元(单项舍入),第 4 条 1000 万元(多项加总舍入累积)。字段缺失或行业无法识别时该条 `skipped`,不影响其它校验。实测 3 行业(银行 / 白酒 / 电池)4 家公司 2024 年报全过 4/4。

走 lru cache 联动:**先调 `get_three_statements` 后调 `cross_check_balance`,后者 < 1ms 秒回**(同一只股票数据已在内存)。

`compare_peers` 默认 metrics:`TOTAL_ASSETS / TOTAL_OPERATE_INCOME / PARENT_NETPROFIT / NETCASH_OPERATE / TOTAL_EQUITY`,自动派生 **`ROE = PARENT_NETPROFIT / 平均权益`**(本年期末权益 + 去年期末权益的均值,去年数据走 lru cache 几乎无成本;去年数据缺失时降级为期末权益,在 `roe_method` 字段标 `ending_equity_fallback`)。**自动 fallback**:银行业 `TOTAL_OPERATE_INCOME` 缺失时退到 `OPERATE_INCOME` 并在 `fallbacks` 字段标注。**并发实现**:ThreadPoolExecutor(max_workers=8),N 家公司并行拉(单家失败不挂整体,记入 `errors`)。实测 4 大银行 2024 年报对比 ~38s 跑完;招行 ROE 12.85%(零售之王长期领跑)。

## HTTP API 模式

除了 MCP stdio 协议,项目还提供一个 FastAPI HTTP wrapper,**供 Web 前端、curl、Postman 等任意 HTTP 客户端调用**——这是给 Web demo 用的:

```bash
pip install -e .
ashare-mcp-http
# Uvicorn running on http://0.0.0.0:8000
```

5 个 endpoint(完整 schema 见 `/docs` FastAPI 自动生成的 OpenAPI 页面):

| 方法 | 路径 | 对应 MCP tool |
|---|---|---|
| `GET` | `/healthz` | (健康检查 + 版本号)|
| `GET` | `/api/statements?stock_code&year` | `get_three_statements` |
| `GET` | `/api/cross-check?stock_code&year` | `cross_check_balance` |
| `POST` | `/api/compare-peers`(body JSON) | `compare_peers` |
| `GET` | `/api/history?stock_code&years` | `track_company_history` |

错误统一格式:`{"error": "...", "code": "INVALID_INPUT" | "UPSTREAM_ERROR"}`(HTTP 422 / 502)。CORS 默认 `*`,生产部署前应收紧到具体域名。`/api/compare-peers` 单次最多 20 个代码(防请求放大);公开部署建议在反向代理层(Nginx / Cloudflare 等)再加限流。

冒烟测试:

```bash
curl 'http://localhost:8000/api/statements?stock_code=000001&year=2024' | jq '.company_name, .balance_sheet.TOTAL_ASSETS'
# "平安银行"
# 5769270000000
```

## Web 前端 demo

`web/` 子目录是一个 React + Vite + TypeScript + Tailwind 写的 4-tab 前端,直接调上面的 HTTP API,**给非技术用户也能用浏览器试一下**:

```bash
cd web
npm install
cp .env.example .env.local  # 默认 VITE_API_BASE=http://localhost:8000
npm run dev           # 开发预览 → http://localhost:5173
npm run build         # 生产构建到 dist/
```

4 个 tab 对应 4 个核心工具:**三大报表 / 勾稽校验 / 同业对比 / 历史趋势**。需要后端 `ashare-mcp-http` 同时跑在 :8000。详见 [`web/README.md`](./web/README.md)。

## PDF 文档解析(可选)

`parse_document` 工具用 [opendatalab/MinerU](https://github.com/opendatalab/MinerU) 把 PDF / DOCX / PPTX / 图片(招股书、研报、年报扫描件等)解析成 LLM-ready 的 markdown。由于 MinerU pipeline 后端需要 torch + transformers 等几 GB 依赖,**单独走 extra 安装**:

```bash
pip install -e ".[pdf]"        # 装 mineru
# 若要解析 PDF / 图片,还需 pipeline extras:
pip install "mineru[pipeline]"
```

不装也不影响其它 4 个工具——只是调用 `parse_document` 时会以 `RuntimeError("mineru not installed")` 友好失败。

## 架构

```mermaid
flowchart LR
    LLM[Claude / 任意 MCP 客户端] -->|JSON-RPC over stdio| Server[ashare-mcp<br/>FastMCP server]
    Web[Web 前端<br/>React + Vite] -->|HTTP / JSON| HTTP[ashare-mcp-http<br/>FastAPI wrapper]
    Curl[curl / Postman / 其它] -->|HTTP / JSON| HTTP
    Server -->|共享业务层| Core[业务模块<br/>checks / peer_compare / history]
    HTTP -->|共享业务层| Core
    Core -->|代码归一化| Norm[股票代码归一化<br/>SZ/SH/BJ 自动判断]
    Core -->|拉取三表| DS[数据源封装<br/>akshare 包装层]
    DS -->|缓存命中| Cache[(进程内存缓存<br/>lru_cache)]
    DS -->|缓存未命中| YearlyEM[akshare<br/>by_yearly_em]
    YearlyEM -->|HTTP| EM[东方财富<br/>财报数据接口]
    DS -->|字段过滤| Filter[剔除元数据列<br/>剔除同比列<br/>剔除空/零字段]
```

**关键设计**:

- **字段名保留东方财富原始英文**(`TOTAL_ASSETS` / `LOAN_ADVANCE` / `NETPROFIT`)。LLM 直接能理解,且银行 / 工商企业 / 保险等不同行业字段都在同一份字典里,无需做行业判断。
- **进程内存缓存**让"同一公司多年份对比"几乎零成本——冷启动一次拉全量,后续年份切换 < 1ms。
- **日志走 stderr**,不污染 MCP stdio 协议通道。

## 部署

仓库已内置三份部署配置,前后端分开部署:

| 文件 | 平台 | 部署对象 | 关键配置 |
|---|---|---|---|
| `railway.json` + `nixpacks.toml` | [Railway](https://railway.app/) | 后端 `ashare-mcp-http` | Nixpacks 构建(Python 3.11),启动 `ashare-mcp-http`,健康检查 `/healthz`,失败重启最多 3 次 |
| `vercel.json` | [Vercel](https://vercel.com/) | 前端 `web/`(Vite 静态站) | 构建 `cd web && npm run build`,产物 `web/dist`,SPA rewrites 到 `index.html` |

**后端(Railway)**:连接仓库后 Railway 自动读 `nixpacks.toml` 构建(锁 Python 3.11,不装 `[pdf]` extra),`$PORT` 由平台注入(见 `http_app.py`)。健康检查打 `/healthz`。

**前端(Vercel)**:框架识别为 Vite,构建 `web/` 子目录输出到 `web/dist`。部署前在 Vercel 环境变量里设置 `VITE_API_BASE` 指向你的 Railway 后端地址。

> 公开部署提醒:`http_app.py` 的 CORS 默认 `*`,生产应收紧到具体前端域名;`/api/compare-peers` 单请求上限 20 个代码,建议反向代理层再加限流。

## 路线图

| 版本 | 工具 | 状态 |
|---|---|---|
| v0 | `get_three_statements` | ✅ |
| v1 | `cross_check_balance`(3 条行业通用勾稽) | ✅ |
| v1 | `compare_peers`(同业横向对比 + ROE 派生) | ✅ |
| v1.5 | `cross_check_balance` + 营业利润分解(行业感知:银行 / 工商企业) | ✅ |
| v1.5 | `compare_peers` 升级到 ROE_avg(平均权益) | ✅ |
| v2 | 跨年趋势工具 `track_company_history`(单公司多年 + CAGR) | ✅ |
| v2 | `parse_document` PDF/DOCX → markdown(MinerU,optional) | ✅ |
| v2(当前) | FastAPI HTTP wrapper + Web 前端 demo + pytest + CI | ✅ |
| v3 | 季度数据 + 同比/环比派生指标 | 待定 |
| v3 | 公开 demo 站部署配置(Vercel 前端 + Railway 后端) | ✅(`railway.json` / `nixpacks.toml` / `vercel.json` 已落仓,见「部署」一节)|
| v3 | MCP 官方 registry 发布 | 待定 |

## 本地开发

```bash
# 装 dev 依赖(包含 pytest / httpx)
pip install -e ".[dev]"

# 跑测试套件(全部离线,akshare 走 mock,~1.5s)
pytest tests/ -v

# 增量验证(每次改完跑一遍)
python -c "from ashare_mcp.server import mcp; \
  import asyncio; print([t.name for t in asyncio.run(mcp.list_tools())])"

# 起 HTTP server 本地预览
ashare-mcp-http
# 另一终端:
curl http://localhost:8000/healthz
```

### CI

`.github/workflows/ci.yml` 跑两个 job:

- **Backend** matrix:Python 3.10 / 3.11 / 3.12 — `pip install -e ".[dev]"` + `pytest tests/ -v` + 验证 MCP & HTTP 入口都能 import
- **Frontend**(Node 20)— `cd web && npm ci` + `tsc --noEmit` + `npm run build`

PDF 路径(`parse_document`)默认 skip(mineru 是 optional);要本地跑这部分:`pip install -e ".[dev,pdf]" && pytest tests/test_parse_document.py -v`。

## 数据声明

- 数据源:东方财富,通过 [akshare](https://github.com/akfamily/akshare)。
- 数据延迟、口径、准确性以东方财富为准,**不构成投资建议**。
- 仅用于教育与研究目的。

## License

MIT — see [LICENSE](./LICENSE).