这里集中维护“同花顺金融数据服务”的公开文档。根 README.md 负责项目总览和最短上手路径;本目录负责跨接入模式的公共说明与上游契约。Python、CLI 和示例的详细运行方式分别留在对应子项目 README 中。
| 目标 | 文档 |
|---|---|
| 第一次使用或选择接入方式 | 项目 README |
| 从旧版根级 Python 布局升级 | Monorepo 版本升级指南 |
| 直接调用 REST API、查参数或响应字段 | REST API 契约 |
| 为聊天客户端配置托管 MCP | MCP 接入说明 |
| 安装并使用 Node.js CLI | CLI README |
| 使用 Python toolkit、SDK 和本地 marketdb | Python README |
| 安装跨 API/MCP/CLI 的 Agent Skill | hithink-finance Skill |
| 免配置使用金融数据或端内专用能力 | 下载并体验同花顺AI客户端 |
| 浏览代码样例和金融看板灵感 | 示例入口 |
API、MCP、CLI、Python SDK 和 Agent Skill 适合自主接入;同花顺AI客户端已接入当前数据源,内置金融数据与分析能力,适合免配置直接使用。标记为“端内专用”的能力仅在客户端提供。
docs/api/按前端单接口页和多接口模块页组织 REST 契约;docs/mcp/按业务域保留原子工具文档。业务域首页集中提供分组和选路条件,统一 Skill 镜像 REST 页面并按业务域合并 MCP 文档。- 文档全文聚合:https://fuyao.aicubes.cn/llms-full.txt。本地查询按业务域首页进入目标接口或工具页。
hithink-finance-cli/只说明 CLI 的安装、命令和运行语义,不复制上游响应字段契约。python/只说明 Python toolkit、SDK、marketdb 和脚本运行方式,不复制上游响应字段契约。- MCP 的实时工具清单和参数 schema 以客户端当前
tools/list为准;本仓库只维护接入方式和能力边界。
修改 docs/api/ 或 docs/mcp.md 后,从仓库根执行:
python scripts/sync_skill_contracts.py
python scripts/sync_skill_contracts.py --check第一条命令更新独立发布 Skill 中的文档,第二条命令用于 CI 或提交前检查。不要直接编辑 skills/hithink-finance/references/api/ 或 skills/hithink-finance/references/mcp/。