What is vault-inspector AGENTS.md?

Repository-specific instructions for Vault Inspector, an Obsidian plugin that scans a note vault for maintenance problems. Obsidian is a note-taking application, and the plugin is designed to inspect files without changing them except when exporting reports.

Use them when developing, testing, building, linting, or reviewing the Vault Inspector Obsidian plugin.

They explain the plugin's structure, commands, supported Obsidian version, and read-only rules so changes follow the repository's expectations.

How rogerdigital/vault-inspector configures Codex and OpenCode

Reuse

Borrowing it

Nothing to install: this file belongs to rogerdigital/vault-inspector. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.

Copy the file

curl -O https://raw.githubusercontent.com/rogerdigital/vault-inspector/main/AGENTS.md

Clone the repo

git clone --depth 1 https://github.com/rogerdigital/vault-inspector

Made for: Codex, OpenCode.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

README.md

[![agentmods](https://agentmods.dev/badge/instructions/rogerdigital/vault-inspector/agents-md/github.svg)](https://agentmods.dev/instructions/rogerdigital/vault-inspector/agents-md)

Your own site

<a href="https://agentmods.dev/instructions/rogerdigital/vault-inspector/agents-md"><img src="https://agentmods.dev/badge/instructions/rogerdigital/vault-inspector/agents-md/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

Your own site · 80×15

<a href="https://agentmods.dev/instructions/rogerdigital/vault-inspector/agents-md"><img src="https://agentmods.dev/badge/instructions/rogerdigital/vault-inspector/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>

Per session 1,205 This file is loaded in full into every session.

When invoked 1,205 The same file — it is already loaded in full.

Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.

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.

Model	Per session	Once invoked
Fable 5.1	$0.01205	$0.01205
Opus 5.5	$0.00482	$0.00482
Sonnet 5.5	$0.00241	$0.00241
Haiku 4.5	$0.00120	$0.00120

Measured 8d ago against content hash 778b550d3edb, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

vault-inspector 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 8d 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.

Origin

Copies of this mod

1 near-identical copy found in the catalogue:

vault-inspector CLAUDE.md — 100% identical, 0 lines differ

AGENTS.md · 94 lines

How it starts

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

Vault Inspector

Obsidian plugin that scans a vault for maintenance problems. Read-only by design — no file mutation except exported reports.

Plugin ID: vault-inspector
Current version: 1.1.0
Min Obsidian version: 1.7.2

Commands

npm run dev          # watch mode
npm run lint         # eslint
npm run lint:obsidian-warnings # Obsidian review warning checks
npm run build        # tsc + esbuild production
npm test             # vitest run
npm run test:watch   # vitest watch
npm run test:coverage # vitest with v8 coverage
npm pack --dry-run   # inspect npm package contents before publishing

Always run npm run lint && npm run lint:obsidian-warnings && npm run build && npm test before committing. CI enforces this.

Architecture

src/
  main.ts                  Plugin entry, registers scanners/views/commands
  settings/
    settings.ts            InspectorSettings type + defaults
    settings-tab.ts        Obsidian PluginSettingTab UI
  scanner/
    Issue.ts               Issue, ScanResult, ScannerId, FixAction types
    ScanContext.ts          Read-only snapshot passed to scanners
    ScanRunner.ts           Orchestrates enabled scanners
    issue-fingerprint.ts    Deterministic issue IDs
    scanners/               One file per scanner, pure logic
      broken-links.ts       Broken link detection
      duplicate-files.ts    Duplicate file detection
      empty-notes.ts        Empty note detection
      external-links.ts     External URL validation
      frontmatter-types.ts  Frontmatter type consistency
      large-files.ts        Large file detection
      orphan-attachments.ts Unreferenced attachments
      tag-usage.ts          Tag usage monitoring
  report/
    InspectorView.ts        ItemView — dashboard + interactions
    ReportModel.ts          View state management
    render-summary.ts       Summary stats
    render-issues.ts        Issue list with actions
    markdown-export.ts      Report → Markdown
  fix/
    confirm-modal.ts        Fix confirmation modal
    fix-executor.ts         Executes fix actions (trash-file, remove-link-text)
  utils/                    Shared helpers (paths, file-types, format, hash, frontmatter-type)
  tests/                    Unit tests per scanner + utils
cli/                        Standalone Node CLI (outside src/ so Obsidian review rules don't flag Node APIs)
  bin.ts                    CLI process entrypoint
  cli.ts                    CLI argument/config handling and JSON/Markdown output
    local-vault.ts            Local filesystem adapter for scanner reuse

Read the full file on GitHub · 94 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.

8d ago Changed 778b550d3edb
1mo ago Changed 48c7feddf1a7
2mo ago Changed fcaa755abc3a
2mo ago Changed 8eb8cdb7e182
2mo ago First seen · 94 lines · 1,205 tokens per session scan A 626af46a4273

Subscribe to this mod's changes

vault-inspector AGENTS.md is an instructions file published in the GitHub repository rogerdigital/vault-inspector (10 stars, last pushed 6d ago), licensed MIT. It adds 1,205 tokens to every session, about $0.0048 per session on Opus 5.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.

agent-skills

vault-inspector AGENTS.md next to 6 instructions from other repositories
Mod	Type	Stars	Last push	Licence	Scan	Tokens	Works with
vault-inspector AGENTS.mdrogerdigital/vault-inspector	Instructions file	10	6d ago	MIT	A	1,205	Codex, OpenCode
vscode buildNext.instructions.mdmicrosoft/vscode	Instructions file	195k	yesterday	MIT	A	9,719	GitHub Copilot
next.js AGENTS.mdvercel/next.js	Instructions file	143k	yesterday	MIT	A	7,461	Codex, OpenCode
vscode oss-third-party-notices.instructions.mdmicrosoft/vscode	Instructions file	195k	yesterday	MIT	A	5,516	GitHub Copilot
langchain AGENTS.mdlangchain-ai/langchain	Instructions file	149k	yesterday	MIT	A	4,680	Codex, OpenCode
vscode copilot-instructions.mdmicrosoft/vscode	Instructions file	195k	yesterday	MIT	A	3,093	GitHub Copilot
vscode ai-customization.instructions.mdmicrosoft/vscode	Instructions file	195k	yesterday	MIT	A	1,907	GitHub Copilot

vault-inspector: Instructions file for Codex