agentleFS
Sign inStart free
martin0nemartin0ne/claude-skills/skills/kb-rag/SKILL.md

kb-rag

Skill0 starsChanged 5 months agoMITView on GitHub

Use to search a project knowledge base or a set of documents with source citations — retrieval with provenance (file:lines) over a specified document folder, NOT over a separately-indexed personal note vault. Auto-invoke on phrases like „przeszukaj dokumenty", „co mówią dokumenty o X", „znajdź w dokumentacji", „baza wiedzy projektu/klienta", „RAG nad dokumentami", „zaindeksuj folder", „odpowiedz na podstawie dokumentów", „skąd to wiesz — pokaż źródło". Covers the „knowledge bases / RAG for agents" use case — a demonstrable retrieval tool.

The file

Create a free account to mount
Files
SKILL.md

kb-rag

Cel

Odpowiadać na pytania wyłącznie na podstawie wskazanego korpusu dokumentów, z twardym provenance: każde twierdzenie ma cytat plik:linie. To jest wzorzec "retrieval-augmented generation", w którym retrieval robi skrypt (BM25, zero kosztów API), a generację — Claude w bieżącej sesji, ograniczony do zwróconych chunków.

Granica (compose-check — NIE łamać)

  • NIE używać na korpusie, który ma już własny indeks semantyczny (np. osobisty vault notatek obsługiwany przez inne narzędzie retrievalu). Duplikacja = wydmuszka.
  • Cel: dokumenty projektu/klienta — np. docs/ repozytorium, folder dokumentów wdrożeniowych, dokumentacja procesu od klienta, folder plików po klasyfikacji.

Workflow

  1. Zidentyfikuj folder korpusu. Jeśli użytkownik nie wskazał — dopytaj. Nigdy nie zgaduj między kilkoma kandydatami.
  2. Szukaj:
    python3 scripts/kb_search.py search <folder> "zapytanie" -k 5
    Pierwszy run buduje cache .kb-rag-index.json w folderze (auto-odświeżany przy zmianach plików). Pełne chunki: --full; maszynowo: --json; inne rozszerzenia: --ext .md .txt .py.
  3. Syntetyzuj odpowiedź TYLKO z chunków. Zasady twarde:
    • Każde twierdzenie → cytat plik:start-end (klikalne dla użytkownika).
    • Skrypt zwraca NO MATCHES → powiedz wprost "korpus nie zawiera odpowiedzi". ZERO dopowiadania z wiedzy ogólnej bez wyraźnego oznaczenia, że to spoza korpusu.
    • Sprzeczne źródła → pokaż obie wersje z provenance, nie uśredniaj.
  4. Iteruj zapytania (2-3 warianty: synonimy, terminy domenowe — JPK/KSeF/VAT itp.), zanim uznasz, że czegoś nie ma. BM25 jest leksykalny: parafraza pojęciowa wymaga przeformułowania zapytania.
  5. Duże korpusy / wiele pytań: stats pokazuje zasięg indeksu; przy audycie wielu pytań naraz odpalaj --json i przetwarzaj zbiorczo.

Kiedy NIE używać

  • Korpus z własnym indeksem semantycznym (osobny vault notatek) — patrz granica.
  • Pojedynczy znany plik — zwykły Read/Grep wystarczy.
  • Pytania wymagające wiedzy spoza korpusu — odpowiadaj normalnie, bez udawania RAG.

Architektura i decyzje

→ references/architektura.md (dlaczego BM25 a nie embeddingi, prefix-matching dla polskiej fleksji, format indeksu, ograniczenia).

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free