Skip to content

docs: AGENTS.md + tdx2db-query skill — 面向 LLM agent 的数据使用指南 - #31

Merged
xbfighting merged 3 commits into
masterfrom
docs-issue-30-agents
Jul 6, 2026
Merged

docs: AGENTS.md + tdx2db-query skill — 面向 LLM agent 的数据使用指南#31
xbfighting merged 3 commits into
masterfrom
docs-issue-30-agents

Conversation

@xbfighting

Copy link
Copy Markdown
Owner

Summary

新增面向 AI agent 的使用文档:仓库根 AGENTS.md(跨工具开放标准)+ Claude Code 项目级 skill tdx2db-query。agent 在本仓库环境下可直接正确同步与查询数据库。

Related Issue

Closes #30

What Changed

  • AGENTS.md:CLI 速查(含 status --json)、schema 与均线列语义、3 种典型查询形态、5 个陷阱(每条有真实事故背书:code 格式静默零匹配、停牌静默错配、name 占位符、不复权、同步不完整算子集)、sync 后验证流程(status + 覆盖度自检 SQL)、数据契约
  • .claude/skills/tdx2db-query/SKILL.md:操作化查询手册——SQL 模板(单票区间/全市场截面/最新交易日/分钟线/周月线聚合/覆盖度自检)、5 条硬规则、同步问题排查表
  • CLAUDE.md 定位为贡献者文档并指向 AGENTS.md;README 提及两者

Why This Approach

  • 数据在 SQL 库里,agent 已有通用 DB 访问能力,缺的是知识而非工具——文档/skill 形态零运行时组件,优于 MCP server(issue 面向 LLM agent 的使用文档:AGENTS.md + Agent Skill #30 的设计决策)
  • 所有查询模板与陷阱均提炼自内部消费项目的真实代码(板块强弱、选股、回测),非理论示例;"ma233 IS NOT NULL 兼作次新股过滤"、"±5% 覆盖度自检"等都是生产流程在用的惯用法

Done Criteria Mapping

  • AGENTS.md 六个板块齐全
  • skill 含 SQL 模板 + 坑位清单 + 排查表
  • CLAUDE.md 指向 AGENTS.md,消费向内容不重复
  • README 提及

How to Test

纯文档改动。在仓库目录下启动 Claude Code,询问"帮我查 600036 最近一个月日线",agent 应使用 6 位纯数字 code 且不查 stock_info。

Risks / Tradeoffs

  • 文档与 schema 演进需同步维护(后续 schema 变更的 PR checklist 应包含 AGENTS.md)

🤖 Generated with Claude Code

xbfighting and others added 2 commits July 6, 2026 13:08
- AGENTS.md:CLI 速查、schema、典型查询形态、五个真实事故背书的陷阱、
  同步后验证流程、数据契约。内容提炼自内部消费项目的真实查询模式
- .claude/skills/tdx2db-query/SKILL.md:可操作查询手册(SQL 模板、
  硬规则、同步问题排查表)
- CLAUDE.md 明确面向贡献者并指向 AGENTS.md;README 提及两者

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
- config/logger 的 load_dotenv 改为 find_dotenv(usecwd=True):
  裸 load_dotenv 从包所在目录向上找,pip 安装用户放在工作目录的
  .env 被静默忽略(pip 环境实测复现)。附子进程回归测试
  (已验证:两处同时还原为裸调用时测试失败)
- AGENTS/README:stock_info.name 占位符实际为 深Asz000001 式
  (reader 用带前缀 code 拼接)
- SKILL 排查表:单票重同步补 --incremental(否则唯一约束冲突报错)

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@xbfighting

Copy link
Copy Markdown
Owner Author

Review 修复已推送:

  1. .env 查找路径(实为功能 bug,已随本 PR 修复):裸 load_dotenv() 从包安装目录向上查找,pip 安装用户放在工作目录的 .env 被静默忽略。pip 环境下用脚本入口实测复现(python -c 会命中 dotenv 交互模式特例、测不出来)。已改为 find_dotenv(usecwd=True) 并添加子进程回归测试,该测试在还原修复后确认失败。注:v0.3.0 受此影响,建议随后发 v0.3.1
  2. stock_info.name 占位符:实际格式为 深Asz000001(带前缀 code 拼接),AGENTS.md/README 已勘误
  3. 单票重同步命令:补 --incremental,避免唯一约束冲突报错

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@xbfighting
xbfighting merged commit a2de4c0 into master Jul 6, 2026
3 checks passed
@xbfighting
xbfighting deleted the docs-issue-30-agents branch July 6, 2026 06:12
xbfighting added a commit that referenced this pull request Jul 6, 2026
0.3.0 补丁:pip 安装场景下工作目录 .env 被静默忽略(load_dotenv
默认从 site-packages 向上查找),已改为 usecwd=True(PR #31)

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

面向 LLM agent 的使用文档:AGENTS.md + Agent Skill

1 participant