docs

A set of project instructions for writing documentation and changelogs in the Alibaba Hooks codebase. It defines emoji labels for change types and asks for clear Chinese and English documentation, version notes, examples, TypeScript definitions, and FAQs.

In plain words
What is it for?
Use it when adding or updating hook documentation, API descriptions, examples, or changelog entries. It also guides descriptions of new properties, breaking changes, tests, accessibility work, and other project changes.
Why use it?
It reduces inconsistent release notes and incomplete documentation. It also reminds contributors to keep both language versions and explain breaking changes.

Cursor rule for Cursor

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 rules/alibaba/hooks/docs
Clone the repo
git clone --depth 1 https://github.com/alibaba/hooks

Made for: Cursor.

Per session 0 Nothing until a file matches its globs; then the whole rule loads.
When invoked 354 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin unknown 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.00000 $0.00354
Opus 5 $0.00000 $0.00177
Sonnet 5 $0.00000 $0.00071
Haiku 4.5 $0.00000 $0.00035

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

Security

Grade A, and why

docs 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 today.

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.

.cursor/rules/docs.mdc · 39 lines

What it actually says

Changelog Emoji 规范

  • 🐞 Bug 修复
  • 💄 样式更新或 token 更新
  • 🆕 新增特性,新增属性
  • 🔥 极其值得关注的新增特性
  • 🇺🇸🇨🇳🇬🇧 国际化改动
  • 📖 📝 文档或网站改进
  • ✅ 新增或更新测试用例
  • 🛎 更新警告/提示信息
  • ⌨️ ♿ 可访问性增强
  • 🗑 废弃或移除
  • 🛠 重构或工具链优化
  • ⚡️ 性能提升

文档规范

  • 提供中英文两个版本
  • 新属性需声明可用的版本号
  • 属性命名符合 API 命名规则
  • hook 文档包含:使用场景、基础用法、API 说明
  • 文档示例应简洁明了
  • 属性的描述应清晰易懂
  • 对复杂功能提供详细说明
  • 加入 TypeScript 定义
  • 提供常见问题解答
  • 更新文档时同步更新中英文版本

其他要求

  • 新增属性时,建议用易于理解的语言描述用户可以感知的变化
  • 存在破坏性改动时,尽量给出原始的 PR 链接,社区提交的 PR 改动加上提交者的链接
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. today First seen · 39 lines · 0 tokens per session scan A fc29390d80fa

Subscribe to this mod's changes

docs is a cursor rule published in the GitHub repository alibaba/hooks (14,977 stars, last pushed today), licensed MIT. It costs nothing until one of its globs matches a file; then it loads 354 tokens. 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-09-01.