简体中文 | English
quantskills 组织的公开资产目录与展示层:每晚只读扫描全组织
skill-*/agent-*仓库,跑完 8 项确定性健康检查后,自动生成机器索引、人类目录、LLM 发现索引和 Claude Code marketplace feed —— 隔离项与审计细节一律不进公开层。
Creator / Maintainer: abgyjaguo
quantskills/registry 是 QUANTSKILLS 生态的公开展示层。它回答五个问题:
- 目前有哪些公开的 skill / agent?
- 每个资产适合解决什么问题?
- 它属于哪个分类,有哪些 tags?
- 它声明支持哪些 agent 平台?
- 它的公开验证等级是什么?
它不是内部问题清单:详细审计、health_items、人工复核记录只存在于维护者本地的审计产物中,公开层一概过滤。quarantined(被隔离)的仓库不会出现在任何公开产物里。
flowchart LR
A["🏢 quantskills 组织<br/>skill-* / agent-* 仓库"] --> B["🌙 nightly-scan<br/>每晚 00:30 北京时间<br/>all-or-nothing closed inventory"]
B --> C["📥 只读浅克隆<br/>QS_READ_TOKEN(仅 Metadata/Contents 读)"]
C --> D["🩺 validate_skill.py<br/>8 项确定性健康检查"]
D --> E{"健康分级"}
E -->|"healthy / warning"| F["📦 生成目录产物<br/>catalog.snapshot.json · registry.json<br/>INDEX.md · llms.txt · marketplace.json"]
E -->|"quarantined"| G["🚧 过滤出公开层<br/>细节仅留维护者本地审计"]
F --> H["🌐 quantskills.ai · LLM agents<br/>Claude Code 插件市场 · 用户"]
style A fill:#e3f2fd,stroke:#1976d2
style D fill:#fff3e0,stroke:#ef6c00
style G fill:#ffebee,stroke:#c62828
style H fill:#e8f5e9,stroke:#388e3c
流水线由 .github/workflows/nightly-scan.yml 驱动(UTC 16:30 = 北京时间 00:30;手动 --full 仅为兼容开关,每次扫描本来都读取完整库存),产物以 qs-registry-auditor 身份提交回本仓库 —— 这是整条流水线唯一的写操作。
| 文件 | 给谁用 | 稳定 URL |
|---|---|---|
registry.json |
网站、工具、自动化系统 | https://raw.githubusercontent.com/quantskills/registry/main/registry.json |
catalog.snapshot.json |
完整目录契约;首次 enforce-clean 发布后可用(first enforce-clean publication) | 首次 enforce-clean 发布后提供 raw URL |
INDEX.md |
人类,按 类型/分类 分组浏览 | 本仓库直接看 |
llms.txt |
LLM / AI agent 发现 | 部署为 https://quantskills.ai/llms.txt |
.claude-plugin/marketplace.json |
Claude Code 插件市场 | /plugin marketplace add quantskills/registry |
这些生成产物由 build_registry.py 管理,请勿手工编辑。首次 enforce-clean 发布后,catalog.snapshot.json 是完整目录,registry.json 是向后兼容的数组投影。每次构建均读取 all-or-nothing closed inventory。修改声明前请阅读双语目录契约(中文)与Catalog Contract (English)。
scripts/validate_skill.py 只做事实判断;语义判断(标签准确性、敏感内容、文档漂移)交给 AGENTS.md 定义的只读复核 agent,且只写建议、不改仓库。
| 检查 | 级别 | 内容 |
|---|---|---|
required-files |
fail | 声明文件(SKILL.md/AGENTS.md)、README.md、LICENSE 缺一即隔离 |
frontmatter |
fail / warn | YAML frontmatter 可解析、name 必填为 fail;description ≥60 字符且含 "Use when"、quantSkills 必填字段与枚举为 warn |
path-refs |
fail / warn | Markdown 链接指向的仓库内文件必须存在(死链 fail);反引号提及路径缺失、引用仓库外路径为 warn |
git-hygiene |
fail / warn | 单文件 >10MB 隔离;>2MB 的数据文件(csv/parquet/json/db/zip 等)warn |
secrets |
fail | 轻量正则扫 AWS Key、GitHub PAT、sk- 形态密钥、Slack token |
quant-risk-disclosures |
fail / warn | 因子、策略、回测、信号、执行和交易类资产须具备恰当的研究风险披露 |
python-syntax |
fail | 仓库内所有 .py 必须通过 py_compile |
requires |
warn | requires 声明的依赖仓库必须真实存在于组织中 |
健康分级:出现任何 fail → quarantined(不进公开层);只有 warn → warning;否则 healthy。脚本退出码对应 0 / 1 / 2。
skill-*仓库用SKILL.md声明,agent-*仓库用AGENTS.md声明;- 元数据写在声明文件的
quantSkillsfrontmatter 中,完整 JSON Schema 见schema/frontmatter.schema.json; - 公开注册表条目结构见
schema/registry.schema.json。
quantSkills 必填字段遵循 Catalog Contract v2(schema_version: 2.0.0):
| 字段 | 约束 |
|---|---|
catalog / workflow |
一个分类/子分类及有效的主阶段/工作流阶段;见目录契约 |
tags |
1–10 个,kebab-case |
platforms |
cursor claude-code codex hermes openclaw |
status |
draft / active / stable / deprecated |
validation_level |
见下方三级验证体系 |
maintainer_type |
official / community |
summary_zh / summary_en |
中文 8–120 字符 / 英文 8–200 字符,网站卡片一句话简介 |
三级验证体系:
| 级别 | 含义 | 门槛 |
|---|---|---|
🥉 L1 listed |
已收录 | 默认级别 |
🥈 L2 runnable |
可运行 | 需安装说明 + 示例输入输出 |
🥇 L3 verified |
已验证 | 需数据来源、无前视检查、回测证据、风险说明 |
Catalog snapshot: sha256:ecb9a3d03c6df06f3d5ca7961766ad2927ab3d370ee64e80343c0dd6946567a7; public assets: 158.
此快照会随每夜扫描变化,实时清单以 INDEX.md / registry.json 为准。
| 你是谁 | 入口 |
|---|---|
| 👤 普通用户 | 直接浏览 INDEX.md,按分类挑 skill |
| 🤖 Claude Code 用户 | /plugin marketplace add quantskills/registry 添加插件市场 |
| 🌐 网站 / 工具开发者 | 拉取 registry.json 的 raw URL,字段语义见 docs/SITE_INTEGRATION_zh.md |
| 🧠 LLM / agent | 读 llms.txt 做轻量发现 |
| ✍️ 资产作者 | 按 schema/frontmatter.schema.json 写好 frontmatter,本地预检:python scripts/validate_skill.py /path/to/your-repo |
| 🔧 维护者 | 见 docs/MAINTAINER_GUIDE.md 与 docs/SECURITY_SETUP_zh.md |
维护者本地全量构建:
pip install -r requirements-dev.txt
python scripts/validate_skill.py /path/to/skill-or-agent-repo # 单仓库预检
GITHUB_TOKEN=xxx python scripts/build_registry.py --full # 兼容开关;每次扫描本来都是完整库存GITHUB_TOKEN 只需读权限;纯公开仓库扫描可不带 token,但会受 GitHub API 限速。
整条流水线对 skill / agent 仓库只读:
- 扫描用
QS_READ_TOKEN(Fine-grained PAT,仅 Metadata: Read + Contents: Read); - 不开 PR、不 push 分支、不改 topics / description / homepage、不动 issue、不触发其他仓库、不跑 AI 自动修复;
- 唯一写操作是把生成的公开产物提交回本仓库(Actions 内置
GITHUB_TOKEN,contents: write只在本仓库生效); - 配套的只读复核 agent 边界见
AGENTS.md:只汇总、只建议,疑似泄密只报路径不复述内容。
字段稳定性约定:registry.json 的字段只增不改不删(向后兼容);破坏性变更会提前在本仓库 issue 公告。注册表每晚北京时间约 00:30–01:00 自动更新,网站侧推荐拉取模式消费。
registry/
├── README.md / README.en.md # 本文档(中文 / 英文)
├── AGENTS.md # 只读复核 agent 的职责与硬边界
├── INDEX.md # 🤖 自动生成:人类可读目录
├── registry.json # 🤖 自动生成:公开机器索引
├── llms.txt # 🤖 自动生成:LLM/agent 发现索引
├── .claude-plugin/marketplace.json # 🤖 自动生成:Claude Code 插件市场 feed
├── .github/workflows/nightly-scan.yml # 每夜只读扫描流水线
├── schema/
│ ├── frontmatter.schema.json # SKILL.md / AGENTS.md frontmatter 契约
│ └── registry.schema.json # registry.json 条目结构
├── scripts/
│ ├── build_registry.py # 扫描组织 → 校验 → 生成全部产物
│ └── validate_skill.py # 单仓库 8 项确定性健康检查
└── docs/
├── MAINTAINER_GUIDE.md # 维护者指南
├── SECURITY_SETUP_zh.md # 最小权限配置清单
├── SITE_INTEGRATION_zh.md # quantskills.ai 对接说明
└── templates/disclaimer_zh_en.md # trader-research 标准免责声明文案
本项目采用 GNU General Public License v3.0(GPL-3.0)发布,完整文本见 LICENSE。
当前目录契约使用 schema_version: 2.0.0:10 个一级分类、61 个二级分类、14 个阶段,以及五个工作流展示组。首次 enforce-clean 发布后,catalog.snapshot.json 是完整目录,registry.json 是向后兼容的数组投影;两者均由构建器生成,禁止手工编辑。旧的 14 类枚举说明已不再是当前契约。
声明、迁移和发布规则请阅读双语目录契约(中文)与Catalog Contract (English)。
