Local RAG

What it does

When your agent uses it

• Tasks that involve Retrieval-augmented generation
• Tasks that involve Embeddings
• Tasks that involve Word documents

Example prompts

• “帮我从这些文件里找到关于XX的规定”
• “对比两份制度的差异”
• “/local-rag”

Requirements

• Python 3
• A credential in SILICONFLOW_API_KEY
• A credential in OPENAI_API_KEY

Workflow steps

3 steps, taken from the first numbered list in SKILL.md.

1. 1环境变量 SILICONFLOW_API_KEY（echo $SILICONFLOW_API_KEY / Windows: echo %SILICONFLOW_API_KEY%）
2. 2配置文件（按平台自动定位）
3. 3如果都没有 → 直接引导用户设置，不要到处搜索

What it can do on your machine

Read from SKILL.md and the folder at commit 6468211. It shows what the files ask for, not the result of running them.

• Tool permissions

  Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

  From allowed-tools in the SKILL.md frontmatter.

• Runs code

  Ships script files (Python), which the agent can run.

  Shell commands in SKILL.md call:

  • pip
  • python3

  From the folder's file list and the shell code blocks in SKILL.md.

• Network

  Links to these hosts (documentation or services it may open):

  • cloud.siliconflow.cn

  From URLs in SKILL.md, links to its own repository left out.

• Credentials

  Names these keys or tokens, usually read from environment variables:

  • SILICONFLOW_API_KEY
  • OPENAI_API_KEY

  From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Local RAG loads about 1.4k tokens when it runs. Until then it costs about 58 tokens; SKILL.md has 343 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it

~58

When it runs · the whole SKILL.md, loaded when a task matches

~1.4k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from nigo81/nigo-skills at commit 6468211, republished under its MIT licence (© nigo81). 343 words, ~1,441 tokens.

name

local-rag

description

本地向量知识库，支持按项目管理文档（docx/doc/pdf/md），语义检索。默认用硅基流动免费 API，零模型安装即可使用。支持多项目隔离、中文制度文档专用切片、Embedding+Rerank 两阶段检索。触发词：知识库、向量检索、RAG、制度检索、文档入库、语义搜索、local rag、搜制度、查条款、文档检索、从文档中搜、语义匹配。即使用户只是说"帮我从这些文件里找到关于XX的规定"或"对比两份制度的差异"，也应使用本 skill。

slug

nigo-local-rag

displayName

本地向量知识库

version

1.0.0

summary

本地向量知识库，支持按项目管理文档（docx/doc/pdf/md），语义检索，默认用硅基流动免费 API，支持中文制度文档专用切片和 Embedding+Rerank 两阶段检索。

license

MIT

# 设置快捷方式（一次性，加到 PATH）
export PATH="$HOME/.claude/skills/local-rag/bin:$PATH"
# 或创建别名：alias local-rag="$HOME/.claude/skills/local-rag/bin/local-rag"

# 首次配置（交互式向导）
local-rag setup

# 项目管理
local-rag create my-project
local-rag delete my-project
local-rag list

# 入库
local-rag ingest my-project /path/to/docs
local-rag ingest my-project /path/to/file.docx --label "财务制度"

# 检索
local-rag search my-project "消防安全管理"
local-rag search my-project "消防安全管理" --rerank --top-k 20

# 工具
local-rag chunk-test /path/to/file.doc
local-rag info

import sys, os
# 添加 skill 目录（根据实际安装位置调整）
sys.path.insert(0, os.path.expanduser("~/.claude/skills/local-rag"))
from src.pipeline import Pipeline

pipeline = Pipeline()

# 项目管理
pipeline.create_project("my-project")
pipeline.list_projects()
pipeline.delete_project("my-project")

# 入库（文件或文件夹）
result = pipeline.ingest("my-project", "/path/to/docs")

# 检索
results = pipeline.search("my-project", "消防安全管理", top_k=15)

# 检索 + Rerank
results = pipeline.search_with_rerank("my-project", "消防安全管理", final_k=10)

# 测试切片
result = pipeline.chunk_test("/path/to/file.doc")

pip install fastmcp
python3 ~/.claude/skills/local-rag/mcp_server.py

© nigo81, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

SKILL.md and 17 other files in local-rag of nigo81/nigo-skills.

• SKILL.md
• .gitignore
• README.md
• bin/local-rag
• config.example.yaml
• mcp_server.py
• requirements.txt
• src/__init__.py
• src/__main__.py
• src/chunker.py
• src/cli.py
• src/config.py
• src/embedding.py
• src/exceptions.py
• src/parser.py
• src/pipeline.py
• src/reranker.py
• src/store.py

Open the folder on GitHubat commit 6468211