verifying-modules

A completeness check for software modules that scans their folders and compares their code with required documentation. It checks for files such as README.md, DESIGN.md, tests, and, where relevant, Python package initialisation files.

In plain words
What is it for?
Use it after creating or restructuring a module, when reviewing a module from another person, or before submitting changes that add modules. It can also produce detailed or JSON results for CI systems.
Why use it?
It prevents newly created or substantially changed modules from being handed over without enough information for users and maintainers to understand them. Missing required documents can block delivery, while some cases receive warnings or exemptions.

Skill for Claude CodeCodex

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 skills/telagod/code-abyss/verifying-modules
Any agent
npx skills add telagod/code-abyss --skill verifying-modules
Clone the repo
git clone --depth 1 https://github.com/telagod/code-abyss

Made for: Claude Code, Codex.

Per session 41 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 783 The whole file, excluding the scripts and references it only reads on demand.
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.00041 $0.00783
Opus 5 $0.00020 $0.00392
Sonnet 5 $0.00008 $0.00157
Haiku 4.5 $0.00004 $0.00078

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

Security

Grade A, and why

verifying-modules 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.

The scan reads SKILL.md. This mod also ships 1 executable file (scripts/module_scanner.js), listed below but not scanned — reading those needs a real analyzer, not pattern matching.

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.

skills/verifying-modules/SKILL.md · 74 lines

What it actually says

模块完整性校验关卡

文档不齐不算交付。模块是否能被外人独立理解,是「完成」的最低门槛。

何时使用

场景 理由
新建模块 ✅ 必跑 阻断「无文档落地」
模块重构(边界变化) 文档随边界更新
接收他人模块 检查可理解性
提交前(涉及模块新增) 最后闸
仅函数级修改 analyzing-changes 即可

必备文件

文件 缺失后果 备注
README.md 阻断交付 用户视角
DESIGN.md 阻断交付 维护者视角
tests/ 警告 单文件模块或纯类型声明可豁免
__init__.py 提示(仅 Python) 视项目布局而定

文档要求

README(外部视角,回答「这是什么、怎么用」)

  • 模块名与定位
  • 存在理由(解决什么问题,不是列功能清单)
  • 核心职责(一句话)
  • 依赖关系(上游:依赖什么;下游:被谁依赖)
  • 快速使用示例(5 分钟跑通)

DESIGN(内部视角,回答「为什么这样设计」)

  • 设计目标(含非目标)
  • 方案选择与理由(对比 ≥2 选项)
  • 关键决策(含权衡)
  • 已知限制
  • 变更历史(重大设计调整)

何时豁免

  • 生成代码模块(protobuf、OpenAPI client 等)→ 顶级 README 提一句即可,无需 DESIGN
  • 配置/数据模块(fixtures、seed data)→ README 说明用途与字段含义即可
  • 私有 utility_internal/internal/)→ README 简化,DESIGN 可缺

与其他 skill 联动

使用

node scripts/module_scanner.js <模块路径>
node scripts/module_scanner.js <模块路径> -v       # 详细
node scripts/module_scanner.js <模块路径> --json   # CI 用

收口

阻断项必修。警告项可在 DESIGN 留「不写测试的理由」(如纯接口声明、纯常量)。「以后补」不算理由。

Files

What ships with it

2 files beside SKILL.md in the same directory: the scripts, references and assets a skill reads on demand. Not counted in the per-session cost; read them before you install if any of them is executable.

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 · 74 lines · 41 tokens per session scan A 0f798ce59534

Subscribe to this mod's changes

verifying-modules is a skill published in the GitHub repository telagod/code-abyss (240 stars, last pushed 1mo ago), licensed MIT. It adds 41 tokens to every session and 783 once invoked, about $0.0002 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.

Related

Other skills, from other repositories

codexkit-a-b-test-planner

Design rigorous A/B test plans with hypothesis, sample size calculation, Minimum Detectable Effect (MDE), randomization strategy, and decision rules. Includes guardrail metrics and rollout playbook. Use when planning product experiments, conversion optimization, or data-driven feature decisions.

hoavdc/CodexKit · 62 tokens

codexkit-api-design-reviewer

Review REST and GraphQL API designs for consistency, usability, and best practices. Covers naming conventions, versioning strategy, error format, pagination, authentication patterns, and breaking change detection. Use when reviewing API specs, designing new APIs, or auditing existing endpoints.

hoavdc/CodexKit · 60 tokens

codexkit-architecture-decision-writer

Write Architecture Decision Records (ADRs) following the Michael Nygard format. Captures context, options considered, decision rationale, and consequences. Use when making technology choices, framework selections, or any architectural decision that future developers need to understand.

hoavdc/CodexKit · 59 tokens

codexkit-audit-readiness-checker

Assess organizational readiness for financial audits (internal or external). Map assertions to account balances, check evidence completeness, score readiness using a Red/Amber/Green framework, and generate a remediation timeline. Aligned with SOX, IFRS, and GAAP audit standards. Use before scheduled audits or when…

hoavdc/CodexKit · 75 tokens

codexkit-business-case-writer

Write structured business cases with problem framing, options analysis, financial modeling (NPV/ROI/Payback), risk assessment, and implementation roadmap. Follows HBR business case structure. Use when seeking budget approval, proposing new initiatives, or justifying investment decisions.

hoavdc/CodexKit · 61 tokens

codexkit-campaign-brief-writer

Write agency-standard creative briefs for marketing campaigns. Structure Background, Objective (SMART), Target Audience persona, Key Message, Mandatories, KPIs, Timeline, and Budget Allocation. Use when briefing agencies, creative teams, or internal marketing on a new campaign.

hoavdc/CodexKit · 61 tokens