ZTools AGENTS.md

Project instructions for ZTools covering JavaScript documentation comments and end-to-end testing in Electron, a desktop app framework.

In plain words
What is it for?
Use them when changing ZTools, writing Playwright Electron tests, checking plugins, or adding platform support without using production data.
Why use it?
They define how modified code should be documented and how tests should use isolated data and the development application.

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/ztoolscenter/ztools/agents-md
Clone the repo
git clone --depth 1 https://github.com/ZToolsCenter/ZTools

Made for: Codex, OpenCode.

Per session 542 This file is loaded in full into every session.
When invoked 542 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.00542 $0.00542
Opus 5 $0.00271 $0.00271
Sonnet 5 $0.00108 $0.00108
Haiku 4.5 $0.00054 $0.00054

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

Security

Grade A, and why

ZTools 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 2d ago.

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 · 24 lines

What it actually says

AGENTS.md

注释规范

  • 新增或实质修改的方法、函数,必须在声明正上方使用多行 JSDoc,简要说明职责。
  • JSDoc 必须为每个参数提供 @param,并提供 @returns;方法可能主动抛错时补充 @throws
  • voidPromise<void> 方法也需要写明 @returns,例如“无返回值”或“操作完成后结束的 Promise”。
  • 方法内部应在准备、校验、状态切换、资源发布、回滚、清理等关键步骤前添加单行注释。
  • 单行注释应解释步骤目的、约束或失败边界,不要逐行复述代码行为。
  • 修改实现时同步更新相关注释,禁止保留与当前行为不一致的旧注释。

E2E 验证

  • 使用 Playwright Electron 运行端到端测试:pnpm test:e2e
  • 修改 ZTools 后必须直接使用开发方式进行 E2E,不要为了 E2E 打包应用,不要执行 electron-builderpnpm build:unpack 或使用 dist/*.app
  • 命令会先构建可供源码 Electron 启动的 ZTools 主程序,再由 Playwright 自动启动设置插件开发服务器(127.0.0.1:15177)和隔离的 Electron 测试实例;这不属于应用打包,无需手动启动服务。
  • 专项 E2E 同样使用源码项目作为 Electron 启动参数,并通过 ZTOOLS_SETTING_DEV_SERVER_URL=http://127.0.0.1:15177 加载设置插件开发页面。
  • E2E 使用临时数据目录,不得读写真实的 ~/.ztools;新增用例必须继续传入隔离的数据与旧数据目录。
  • 排查插件界面时直接截取插件 WebContentsView,不要与宿主窗口截图拼接。
  • 默认只截取当前可见区域;只有测试明确要求时才增加全页面或滚动截图逻辑。
  • 截图前必须等待页面正文中的稳定特征出现,不能只等待侧栏、标题等可能提前渲染的内容。
  • 测试截图和 trace 输出到 test-results/playwright,该目录不提交版本库。
  • Electron E2E 使用 Electron 自带的 Chromium,不需要执行 playwright install chromium
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. 2d ago First seen · 24 lines · 542 tokens per session scan A b63a4527a26e

Subscribe to this mod's changes

ZTools AGENTS.md is an instructions file published in the GitHub repository ZToolsCenter/ZTools (3,694 stars, last pushed 4d ago), licensed MIT. It adds 542 tokens to every session, about $0.0027 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-30.