Flydb AGENTS.md

A repository instruction file for Flydb, a Java database migration and integration project. It explains which documentation to read, how the modules are divided, and which Java versions and rules apply.

In plain words
What is it for?
Use it before changing Flydb CLI behavior, configuration, JDBC integrations, migration code, schemas, MCP adapters, or build and test setup.
Why use it?
It reduces mistakes caused by relying on outdated assumptions about commands, configuration, database integrations, or module boundaries.

Instructions file for CodexOpenCode

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add instructions/zzxcoding/flydb/agents-md
Clone the repo
git clone --depth 1 https://github.com/zzxCoding/Flydb

Made for: Codex, OpenCode.

Per session 1,770 This file is loaded in full into every session.
When invoked 1,770 The same file — it is already loaded in full.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.01770 $0.01770
Opus 5 $0.00885 $0.00885
Sonnet 5 $0.00354 $0.00354
Haiku 4.5 $0.00177 $0.00177

Measured yesterday against content hash a219df2a203a, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

Flydb AGENTS.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured yesterday.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

AGENTS.md · 102 lines

How it starts

The opening of the file, as written. The whole thing — 102 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Flydb 仓库 Agent 指引

本文件适用于整个 Flydb 仓库,记录所有开发 Agent 都必须遵守的稳定约束。 模块专属规则应放在对应子目录的 AGENTS.md;命令参数、配置项和安装步骤应留在 各自的参考文档中,不在本文件重复维护。

1. 开始工作前

  • 先阅读根目录 README.md,再按任务读取相关设计或参考文档。
  • 涉及 Flydb CLI、flydb.confdrivers/、JDBC 迁移或 Schema 变更时,必须先读 flydb-cli/SKILL.md。只有当前 Agent 必须安装 Skill 才能发现它时,才按 flydb-skills/README.md 操作;无法自动发现时直接读取仓库内的 SKILL.md
  • CLI 命令、配置、错误码和 --json 机器输出分别以 commands.mdconfiguration.mderrors.mdjson-output.md 为准。不要凭记忆重构选项、错误语义或输出 schema。
  • 涉及 MCP Adapter(flydb-skills/mcp/mcp.json 或 MCP tools)时,以 mcp-tools.md11-plan-artifact.md 为准;TypeScript 侧不得新增领域逻辑或第二套计划模型。
  • 接入新 JDBC 数据库、厂商数据库或信创数据库前,先读 jdbc-integration.md 及对应数据库指南。
  • 纯文档任务只需读取本文件和相关源文档,不要求安装 Skill,也不要求连接数据库。

2. 仓库结构与版本边界

路径 职责 Java 边界
flydb-core 公共 API、迁移引擎、方言 SPI Java 8,零第三方运行时依赖
flydb-cli picocli CLI 与发行包 Java 8
flydb-spring-boot-2-starter Spring Boot 2.7 自动装配 Java 8
flydb-spring-boot-3-starter Spring Boot 3 自动装配 Java 17
flydb-integration-tests Testcontainers 与数据库契约测试 Java 17
examples Boot 2/3 可运行示例 跟随对应 starter
docs/design 已确认的架构、领域与实现契约 不适用
docs/reference CLI、配置和错误码的事实来源 不适用
flydb-skills 版本匹配的 Agent Skill 与评测 不适用

完整模块关系和依赖边界见 01-modules.md

3. 修改规则

  • docs/design 中标记为“契约”或“决策”的内容不能静默偏离。设计与实现冲突时, 先说明冲突及影响,再决定是修代码还是更新设计。
  • 修改公共 API、CLI 行为、配置键、错误码、驱动加载或数据库支持范围时,必须同步 更新对应测试和源文档;随后检查 flydb-cli/SKILL.md 是否仍保持薄引用而未复制手册。
  • flydb-core 不得新增非 test 作用域依赖。core、CLI、Boot 2 starter 不得使用 Java 9+ 语法或 API;Boot 3 专属代码不得下沉到 Java 8 模块。
  • 优先在公共边界补回归测试,再修改实现。迁移发现、版本选择、状态推导等共享语义 应复用既有领域对象,不能在 CLI、starter 或方言中另写一套规则。
  • 不下载、提交或重新分发厂商 JDBC 驱动。测试依赖和真实数据库验证必须符合厂商 许可证及当前环境授权。
  • 不改动与当前任务无关的用户工作区变更,也不要为了通过检查删除或重写已有产物。

Read the full file on GitHub · 102 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. yesterday First seen · 102 lines · 1,770 tokens per session scan A a219df2a203a

Subscribe to this mod's changes

Flydb AGENTS.md is an instructions file published in the GitHub repository zzxCoding/Flydb (9 stars, last pushed 5d ago), licensed Apache-2.0. It adds 1,770 tokens to every session, about $0.0089 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.