本文へ移動
cccskills
無料GitHub で公開

docs-notes-retrieval

Builds local-first note vault retrieval for Obsidian, markdown notebooks, and NotebookLM-adjacent exports. Use when packaging notes into LLM-ready context.

インストール方法を見る

含まれるファイル(12)

  • SKILL.md14.7 KB
  • agents/openai.yaml349 B
  • data/sources.json4.0 KB
  • learnings.consolidated.md596 B
  • learnings.md1.5 KB
  • references/ai-curated-wiki-pattern.md7.0 KB
  • references/context-packaging-patterns.md6.9 KB
  • references/obsidian-and-local-vaults.md5.2 KB
  • references/retrieval-anti-patterns.md8.7 KB
  • scripts/build_context_pack.py26.6 KB
  • scripts/scan_vault.py16.0 KB
  • scripts/test_vault_regressions.py4.3 KB

SKILL.md(原文)

インストールする前に、エージェントに与えられる指示の中身を確認できます。

Notes Retrieval

Quick Start — Concrete Commands

Three common scenarios using the scripts in scripts/.

Scenario 1: Vault inventory

Before indexing or packaging, understand what is in the vault.

# Full inventory as JSON — one record per note with title, frontmatter, wikilinks, tags, word count, mtime
python scripts/scan_vault.py inventory /path/to/vault > vault-inventory.json

# Tag summary sorted by note count
python scripts/scan_vault.py tags /path/to/vault

# CSV for spreadsheet review
python scripts/scan_vault.py inventory /path/to/vault --format csv > vault-inventory.csv

Scenario 2: Packaged context for an LLM session

Build a markdown bundle ready to paste into a Claude or GPT session.

# Keyword search — include all notes matching "weekly review", budget 40k chars
python scripts/build_context_pack.py /path/to/vault \
    --query "weekly review" \
    --max-chars 40000 > context-pack.md

# Specific notes with heading-level chunking
python scripts/build_context_pack.py /path/to/vault \
    --notes "Projects/Alpha.md" "Projects/Beta.md" \
    --chunk-strategy heading \
    --max-chars 60000 > project-alpha-pack.md

# Most recent notes first, paragraph chunking, written to file
python scripts/build_context_pack.py /path/to/vault \
    --query "architecture decision" \
    --order-by recency \
    --chunk-strategy paragraph \
    --out session-context.md

# Filter on status before recency: drop superseded and archived notes
python scripts/build_context_pack.py /path/to/vault \
    --query "pricing" --exclude-status superseded archived --order-by recency

The pack keeps conflicting notes side by side under a conflict block (path, status, mtime for each) when they declare conflicts_with: [[Other Note]] in frontmatter or share a title under different paths; a group is included or omitted whole. It does not detect contradictions in prose, so still read for them. The footer lists wikilinks in included notes that resolve to no file.

Both scripts fail (exit 1) on malformed notes: invalid UTF-8, or frontmatter opened with --- and never closed. A note whose status: superseded cannot be parsed would otherwise pass --exclude-status silently. Fix the named files; pass --allow-malformed only to skip them knowingly. scan_vault.py also fails when the vault has no .md files (usually a wrong path), and --notes paths must stay inside the vault.

Scenario 3: Orphan note cleanup

Find and review notes with no inbound or outbound wikilinks — usually stale or misplaced.

# List orphans as JSON
python scripts/scan_vault.py orphans /path/to/vault

# Pipe into jq to see just paths and word counts
python scripts/scan_vault.py orphans /path/to/vault | jq '.[] | {path, word_count}'

# CSV for manual triage
python scripts/scan_vault.py orphans /path/to/vault --format csv > orphans.csv

# Wikilinks that point at no file (fix before any agent cites them)
python scripts/scan_vault.py broken-links /path/to/vault

Orphan cleanup workflow:

  1. Run orphans to get the list.
  2. Review short orphans for stubs; archive only after checking their task and provenance.
  3. For substantial notes with no links, inspect their value and add a wikilink or backlink from a map-of-content note when useful.
  4. Re-run orphans after cleanup to verify the count dropped.

Judgment call before acting on the list: scan_vault.py orphans only detects [[wikilink]] topology. In vaults that organize by folder hierarchy or tags instead of wikilinks (common in Logseq-style or PARA-folder vaults), a genuinely well-connected note can show up as a false-positive orphan. Cross-check folder placement and tags before archiving anything the tool flags — treat the orphan list as a triage queue, not a deletion list.


Use this skill to build or operate local-first retrieval pipelines for note vaults, markdown knowledge bases, and notebook-style exports.

This skill covers:

  • Obsidian-style markdown vaults with frontmatter, wikilinks, tags, and aliases
  • Local notebook exports and source packs prepared for NotebookLM-style workflows
  • Raw ingest folders such as transcript exports that feed a canonical note system
  • Read-only extraction of note text, metadata, backlinks, and neighborhood context
  • Packaging note sets into Markdown or retrieval-ready context for LLMs, agents, and MCP tools
  • Optional write-back routing of summaries, actions, and decisions into canonical notes when the user explicitly wants synchronized notes

Quick Reference

NeedDefault pathNotes
Inspect a vault before indexingreferences/obsidian-and-local-vaults.mdInventory note types, frontmatter conventions, attachments, and private areas first
Run vault inventory from the CLIscripts/scan_vault.py inventoryExtracts path, title, frontmatter, wikilinks, tags, word count, mtime, inbound link count; ignores links and tags inside code
Find orphan notes (no links)scripts/scan_vault.py orphansReturns notes with no inbound or outbound wikilinks
Find broken wikilinksscripts/scan_vault.py broken-linksReturns source note and target for each link that resolves to no file
List all tags with countsscripts/scan_vault.py tagsSorted by note count descending
Package notes for LLM contextscripts/build_context_pack.py + references/context-packaging-patterns.mdKeyword or explicit-note selection; status filter; whole/heading/paragraph chunking; char budget; conflict blocks; unresolved-link footer
Understand chunk strategies and token budgetsreferences/context-packaging-patterns.mdCharacter budget limits, token counting, ordering, attribution format
Avoid retrieval mistakesreferences/retrieval-anti-patterns.md9 anti-patterns with fixes
Structure a vault as durable agent memoryreferences/obsidian-and-local-vaults.mdSeparate session memory, canonical notes, and ingest artifacts instead of one flat note dump
Turn a vault into an operating memory loopreferences/obsidian-and-local-vaults.mdKeep notes canonical and treat transcripts or exports as ingest inputs
Use AI-owned wiki (solo, high-volume capture)references/ai-curated-wiki-pattern.mdFolder layout, invariants, compounding loop, scale heuristic, snapshots
Decide note-vault retrieval vs generic RAG../ai-rag/SKILL.md + this skillUse this skill for note-shape and packaging rules; use ai-rag for retrieval architecture
Turn note access into a repeatable tool../agents-mcp/SKILL.mdBuild an MCP wrapper only after the local note workflow is clear

Supported Inputs

Default support in v1:

  • markdown note vaults
  • Obsidian frontmatter and wikilinks
  • folder-based personal or team knowledge bases
  • NotebookLM-adjacent exported note packs, summaries, and source bundles
  • transcript or export folders that are later summarized into canonical notes
  • read-only local file trees prepared for agent retrieval

Explicitly out of scope in v1:

  • direct NotebookLM API automation
  • mutating or auto-rewriting the source vault by default
  • OCR-heavy attachment pipelines
  • closed-source vendor note apps without an export path

Three-Layer Operating Memory Pattern

For agent workflows, separate these three layers — collapsing them into one pool is the most common vault anti-pattern:

LayerRoleExamples
Session memoryOrients the agent; always loaded, tinyOnboarding notes, repo CLAUDE.md, orientation files
Knowledge graphPersists and connects knowledgeCanonical notes with frontmatter, wikilinks, stable destinations
Ingest pipelineEvidence and raw materialTranscripts, exports, recordings, raw captures

AI-Curated Wiki Variant (Ganim Pattern)

The three-layer default assumes humans curate the canonical layer. A second mode exists where the AI owns the curated layer entirely and the human only appends to a junk-drawer source folder. Use this variant for solo operators capturing source material faster than they can hand-organize it.

Full details, invariants, compounding loop, health check, scale decision, image-aware ingest, and snapshot strategy: references/ai-curated-wiki-pattern.md.

Default Workflow

  1. Identify the source shape: Obsidian vault, markdown folder, notebook export, transcript dump, or mixed notes repo.
  2. Separate canonical notes from raw ingest areas before indexing or packaging.
  3. Inventory note conventions before indexing: frontmatter keys, aliases, tags, task syntax, attachments, private folders.
  4. Extract note text and metadata separately.
  5. Preserve note relationships: wikilinks, backlinks, tags, path hierarchy, and recent edits.
  6. If external transcripts or exports feed the vault, route extracted summaries, decisions, and actions into stable note destinations instead of treating raw dumps as the memory layer.
  7. Only then choose whether the downstream consumer needs direct Markdown bundles, a search index, or an MCP server.

Packaging Rules

RuleWhy it matters
A note ≠ a chunk — preserve whole-note metadata even when chunkingPath, title, aliases, timestamps are retrieval signals
Keep canonical notes and raw ingest artifacts separateA transcript dump is not the operating note system
Prefer note titles that read like claims or decisionsHelps an agent triage relevance before opening the file
Use maps-of-content / home notes for navigationSemantic search alone cannot recover the right abstraction level
Every canonical note has an inbound link from a home or map noteinventory reports inbound_count; a canonical note with 0 is unreachable by navigation even if orphans does not flag it (it may have outbound links). Reachability and hop-depth definitions: foundations-graph-theory
Separate private, shared, and project-specific spaces before retrievalPrevents accidental cross-space leakage
Default to local-first, read-only flowsOnly add write-back when the user explicitly needs it
If notes are one corpus among many, route to ai-ragThis skill covers note-shape; ai-rag covers retrieval architecture

Preserve disagreement and provenance

Do not merge contradictory notes into one confident summary. For each retrieved claim, retain the note path, heading or chunk identifier, note modification time, and enough quoted context to distinguish a decision from brainstorming or a later reversal. Recency is evidence of freshness, not authority; a newer scratch note does not automatically override a canonical decision record.

When sources disagree, package both claims in a conflict block with their provenance and state what authority or verification would resolve them. Deduplicate exact or near-exact copies only after preserving the canonical source and alias paths. A context pack is complete when every material assertion can be traced back to a source chunk and unresolved conflicts remain visible to the consumer.

Judgment Calls

These are the calls a non-expert tends to get wrong. Full detail and the anti-pattern behind each is in references/retrieval-anti-patterns.md.

  • Start with full-text, tags, and paths. Exact titles, project names, dates, and quotations need lexical retrieval. Add semantic search when a test set shows these methods miss conceptual queries; measure whether the index improves recall before adding its maintenance cost.
  • Citation integrity is non-negotiable. Never let a downstream agent cite a note without a resolvable path + mtime. If a wikilink target does not resolve to an actual file, that is a stop-and-fix signal — flag it in the pack footer, do not silently drop it or silently invent a path.
  • An orphan is a triage signal, not a verdict. See the vault-hygiene note in Scenario 3 above — orphan detection is topology-specific (wikilinks only) and produces false positives in folder- or tag-organized vaults.
  • Status metadata beats recency for trust, not just freshness. A note edited yesterday but marked status: draft is less trustworthy than a status: active note from three months ago. Filter on status before recency, not instead of it.

When To Use This Skill

Use this skill when the user asks:

  • "Search my Obsidian vault."
  • "Prepare my notes for an LLM."
  • "Package markdown notebooks into retrieval-ready context."
  • "How should I structure note metadata, links, and summaries for AI?"
  • "I want Claude to keep my Obsidian vault up to date from transcripts or exports."
  • "I have NotebookLM-style exports or source packs and want a reusable local workflow."

Navigation

Scripts

  • scripts/scan_vault.py - vault scanner: inventory, tags, orphans, broken-links subcommands; JSON/CSV output
  • scripts/build_context_pack.py - context pack builder: keyword/path selection, status filter, chunk strategies, char budget, conflict blocks, unresolved-link footer

References

Related Skills

Learnings Loop

When prior decisions or pitfalls are relevant, consult learnings.consolidated.md if present; use learnings.md only for needed history or as the available fallback. Otherwise skip both.

After applying it, if you encountered a pattern worth remembering, a mistake worth preventing, or a domain fact that surprised you, append one dated bullet to learnings.md via agents-skills-feedback-loop/scripts/append_learning.py. Do not modify SKILL.md itself.

レビュー

まだレビューはありません。使ってみた感想をお寄せください。

同じリポジトリのスキル

概要と使いどころ

Configures Claude Code hooks and Codex hooks.json/notify. Use when adding PreToolUse guards, Stop hooks, managed hooks, format-on-save, preflight, audits, or worktree/budget hooks.

日本語の概要は準備中です。原文の説明を表示しています。

vasilyu1983/AI-Agents-public912026年10月5日 更新

Configures and hardens Claude Code and Codex MCP servers. Use when connecting databases, APIs, SaaS, building servers, or serving a clearance-filtered knowledge base.

日本語の概要は準備中です。原文の説明を表示しています。

vasilyu1983/AI-Agents-public912026年10月5日 更新

Owns instruction files: AGENTS.md, CLAUDE.md, personal and repo rules. Use when writing, pruning, auditing them, sharing rules across Claude and Codex, or fixing ignored rules.

日本語の概要は準備中です。原文の説明を表示しています。

vasilyu1983/AI-Agents-public912026年10月5日 更新

Creates and audits agent skills: SKILL.md, references, scripts, runtime metadata. Use when writing, validating, or security-reviewing a skill, or fixing truncated skill listings.

日本語の概要は準備中です。原文の説明を表示しています。

vasilyu1983/AI-Agents-public912026年10月5日 更新

Adds per-skill learnings loops for dated patterns, mistakes, and domain facts. Use when wiring skill memory, consolidation, or drift audits.

日本語の概要は準備中です。原文の説明を表示しています。

vasilyu1983/AI-Agents-public912026年10月5日 更新

Chooses subagent, team, workflow, or debate and launches it on Claude Code or Codex. Use when delegating, running agent review boards, or installing shared agents.

日本語の概要は準備中です。原文の説明を表示しています。

vasilyu1983/AI-Agents-public912026年10月5日 更新

vasilyu1983 のスキルをすべて見る

このスキルの問題を報告する