# nbrag - Doramagic AI Context Pack > 定位：安装前体验与判断资产。它帮助宿主 AI 有一个好的开始，但不代表已经安装、执行或验证目标项目。 ## 充分原则 - **充分原则，不是压缩原则**：AI Context Pack 应该充分到让宿主 AI 在开工前理解项目价值、能力边界、使用入口、风险和证据来源；它可以分层组织，但不以最短摘要为目标。 - **压缩策略**：只压缩噪声和重复内容，不压缩会影响判断和开工质量的上下文。 ## 给宿主 AI 的使用方式 你正在读取 Doramagic 为 nbrag 编译的 AI Context Pack。请把它当作开工前上下文：帮助用户理解适合谁、能做什么、如何开始、哪些必须安装后验证、风险在哪里。不要声称你已经安装、运行或执行了目标项目。 ## Claim 消费规则 - **事实来源**：Repo Evidence + Claim/Evidence Graph；Human Wiki 只提供显著性、术语和叙事结构。 - **事实最低状态**：`supported` - `supported`：可以作为项目事实使用，但回答中必须引用 claim_id 和证据路径。 - `weak`：只能作为低置信度线索，必须要求用户继续核实。 - `inferred`：只能用于风险提示或待确认问题，不能包装成项目事实。 - `unverified`：不得作为事实使用，应明确说证据不足。 - `contradicted`：必须展示冲突来源，不得替用户强行选择一个版本。 ## 它最适合谁 - **希望把专业流程带进宿主 AI 的用户**：仓库包含 Skill 文档。 证据：`.agents/skills/nbrag-performance-check/SKILL.md`, `.agents/skills/nbrag-retrieval-quality-check/SKILL.md`, `.agents/skills/restart_process/SKILL.md`, `.agents/skills/restart-nbrag-mcp/SKILL.md` 等 Claim：`clm_0003` supported 0.86 ## 它能做什么 - **AI Skill / Agent 指令资产库**（可做安装前预览）：项目包含可被宿主 AI 读取的 Skill 或 Agent 指令文件，可用于把专业流程带入 Claude、Codex、Cursor 等宿主。 证据：`.agents/skills/nbrag-performance-check/SKILL.md`, `.agents/skills/nbrag-retrieval-quality-check/SKILL.md`, `.agents/skills/restart_process/SKILL.md`, `.agents/skills/restart-nbrag-mcp/SKILL.md` 等 Claim：`clm_0001` supported 0.86 - **命令行启动或安装流程**（需要安装后验证）：项目文档中存在可执行命令，真实使用需要在本地或宿主环境中运行这些命令。 证据：`README.md` Claim：`clm_0002` supported 0.86 ## 怎么开始 - `pip install nbrag` 证据：`README.md` Claim：`clm_0004` supported 0.86 - `git clone https://github.com/ydf0509/nbrag.git` 证据：`README.md` Claim：`clm_0005` supported 0.86 - `pip install -e ".[dev]"` 证据：`README.md` Claim：`clm_0006` supported 0.86 ## 继续前判断卡 - **当前建议**：需要管理员/安全审批 - **为什么**：继续前可能涉及密钥、账号、外部服务或敏感上下文，建议先经过管理员或安全审批。 ### 30 秒判断 - **现在怎么做**：需要管理员/安全审批 - **最小安全下一步**：先跑 Prompt Preview；若涉及凭证或企业环境，先审批再试装 - **先别相信**：工具权限边界不能在安装前相信。 - **继续会触碰**：命令执行、宿主 AI 配置、本地环境或项目文件 ### 现在可以相信 - **适合人群线索：希望把专业流程带进宿主 AI 的用户**（supported）：有 supported claim 或项目证据支撑，但仍不等于真实安装效果。 证据：`.agents/skills/nbrag-performance-check/SKILL.md`, `.agents/skills/nbrag-retrieval-quality-check/SKILL.md`, `.agents/skills/restart_process/SKILL.md`, `.agents/skills/restart-nbrag-mcp/SKILL.md` 等 Claim：`clm_0003` supported 0.86 - **能力存在：AI Skill / Agent 指令资产库**（supported）：可以相信项目包含这类能力线索；是否适合你的具体任务仍要试用或安装后验证。 证据：`.agents/skills/nbrag-performance-check/SKILL.md`, `.agents/skills/nbrag-retrieval-quality-check/SKILL.md`, `.agents/skills/restart_process/SKILL.md`, `.agents/skills/restart-nbrag-mcp/SKILL.md` 等 Claim：`clm_0001` supported 0.86 - **能力存在：命令行启动或安装流程**（supported）：可以相信项目包含这类能力线索；是否适合你的具体任务仍要试用或安装后验证。 证据：`README.md` Claim：`clm_0002` supported 0.86 - **存在 Quick Start / 安装命令线索**（supported）：可以相信项目文档出现过启动或安装入口；不要因此直接在主力环境运行。 证据：`README.md` Claim：`clm_0004` supported 0.86 ### 现在还不能相信 - **工具权限边界不能在安装前相信。**（unverified）：MCP/tool 类项目通常会触碰文件、网络、浏览器或外部 API，必须真实检查权限和日志。 - **真实输出质量不能在安装前相信。**（unverified）：Prompt Preview 只能展示引导方式，不能证明真实项目中的结果质量。 - **宿主 AI 版本兼容性不能在安装前相信。**（unverified）：Claude、Cursor、Codex、Gemini 等宿主加载规则和版本差异必须在真实环境验证。 - **不会污染现有宿主 AI 行为，不能直接相信。**（inferred）：Skill、plugin、AGENTS/CLAUDE/GEMINI 指令可能改变宿主 AI 的默认行为。 证据：`.agents/skills/nbrag-performance-check/SKILL.md`, `.agents/skills/nbrag-retrieval-quality-check/SKILL.md`, `.agents/skills/restart-nbrag-mcp/SKILL.md`, `.agents/skills/restart_process/SKILL.md` 等 - **可安全回滚不能默认相信。**（unverified）：除非项目明确提供卸载和恢复说明，否则必须先在隔离环境验证。 - **真实安装后是否与用户当前宿主 AI 版本兼容？**（unverified）：兼容性只能通过实际宿主环境验证。 - **项目输出质量是否满足用户具体任务？**（unverified）：安装前预览只能展示流程和边界，不能替代真实评测。 - **安装命令是否需要网络、权限或全局写入？**（unverified）：这影响企业环境和个人环境的安装风险。 证据：`README.md` ### 继续会触碰什么 - **命令执行**：包管理器、网络下载、本地插件目录、项目配置或用户主目录。 原因：运行第一条命令就可能产生环境改动；必须先判断是否值得跑。 证据：`README.md` - **宿主 AI 配置**：Claude/Codex/Cursor/Gemini/OpenCode 等宿主的 plugin、Skill 或规则加载配置。 原因：宿主配置会改变 AI 后续工作方式，可能和用户已有规则冲突。 证据：`.agents/skills/nbrag-performance-check/SKILL.md`, `.agents/skills/nbrag-retrieval-quality-check/SKILL.md`, `.agents/skills/restart-nbrag-mcp/SKILL.md`, `.agents/skills/restart_process/SKILL.md` 等 - **本地环境或项目文件**：安装结果、插件缓存、项目配置或本地依赖目录。 原因：安装前无法证明写入范围和回滚方式，需要隔离验证。 证据：`README.md` - **环境变量 / API Key**：项目入口文档明确出现 API key、token、secret 或账号凭证配置。 原因：如果真实安装需要凭证，应先使用测试凭证并经过权限/合规判断。 证据：`README.md`, `README.zh-CN.md` - **宿主 AI 上下文**：AI Context Pack、Prompt Preview、Skill 路由、风险规则和项目事实。 原因：导入上下文会影响宿主 AI 后续判断，必须避免把未验证项包装成事实。 ### 最小安全下一步 - **先跑 Prompt Preview**：用安装前交互式试用判断工作方式是否匹配，不需要授权或改环境。（适用：任何项目都适用，尤其是输出质量未知时。） - **只在隔离目录或测试账号试装**：避免安装命令污染主力宿主 AI、真实项目或用户主目录。（适用：存在命令执行、插件配置或本地写入线索时。） - **先备份宿主 AI 配置**：Skill、plugin、规则文件可能改变 Claude/Cursor/Codex 的默认行为。（适用：存在插件 manifest、Skill 或宿主规则入口时。） - **不要使用真实生产凭证**：环境变量/API key 一旦进入宿主或工具链，可能产生账号和合规风险。（适用：出现 API、TOKEN、KEY、SECRET 等环境线索时。） - **安装后只验证一个最小任务**：先验证加载、兼容、输出质量和回滚，再决定是否深用。（适用：准备从试用进入真实工作流时。） ### 退出方式 - **保留安装前状态**：记录原始宿主配置和项目状态，后续才能判断是否可恢复。 - **准备移除宿主 plugin / Skill / 规则入口**：如果试装后行为异常，可以把宿主 AI 恢复到试装前状态。 - **记录安装命令和写入路径**：没有明确卸载说明时，至少要知道哪些目录或配置需要手动清理。 - **准备撤销测试 API key 或 token**：测试凭证泄露或误用时，可以快速止损。 - **如果没有回滚路径，不进入主力环境**：不可回滚是继续前阻断项，不应靠信任或运气继续。 ## 哪些只能预览 - 解释项目适合谁和能做什么 - 基于项目文档演示典型对话流程 - 帮助用户判断是否值得安装或继续研究 ## 哪些必须安装后验证 - 真实安装 Skill、插件或 CLI - 执行脚本、修改本地文件或访问外部服务 - 验证真实输出质量、性能和兼容性 ## 边界与风险判断卡 - **把安装前预览误认为真实运行**：用户可能高估项目已经完成的配置、权限和兼容性验证。 处理方式：明确区分 prompt_preview_can_do 与 runtime_required。 Claim：`clm_0007` inferred 0.45 - **命令执行会修改本地环境**：安装命令可能写入用户主目录、宿主插件目录或项目配置。 处理方式：先在隔离环境或测试账号中运行。 证据：`README.md` Claim：`clm_0008` supported 0.86 - **待确认**：真实安装后是否与用户当前宿主 AI 版本兼容？。原因：兼容性只能通过实际宿主环境验证。 - **待确认**：项目输出质量是否满足用户具体任务？。原因：安装前预览只能展示流程和边界，不能替代真实评测。 - **待确认**：安装命令是否需要网络、权限或全局写入？。原因：这影响企业环境和个人环境的安装风险。 ## 开工前工作上下文 ### 加载顺序 - 先读取 how_to_use.host_ai_instruction，建立安装前判断资产的边界。 - 读取 claim_graph_summary，确认事实来自 Claim/Evidence Graph，而不是 Human Wiki 叙事。 - 再读取 intended_users、capabilities 和 quick_start_candidates，判断用户是否匹配。 - 需要执行具体任务时，优先查 role_skill_index，再查 evidence_index。 - 遇到真实安装、文件修改、网络访问、性能或兼容性问题时，转入 risk_card 和 boundaries.runtime_required。 ### 任务路由 - **AI Skill / Agent 指令资产库**：先基于 role_skill_index / evidence_index 帮用户挑选可用角色、Skill 或工作流。 边界：可做安装前 Prompt 体验。 证据：`.agents/skills/nbrag-performance-check/SKILL.md`, `.agents/skills/nbrag-retrieval-quality-check/SKILL.md`, `.agents/skills/restart_process/SKILL.md`, `.agents/skills/restart-nbrag-mcp/SKILL.md` 等 Claim：`clm_0001` supported 0.86 - **命令行启动或安装流程**：先说明这是安装后验证能力，再给出安装前检查清单。 边界：必须真实安装或运行后验证。 证据：`README.md` Claim：`clm_0002` supported 0.86 ### 上下文规模 - 文件总数：639 - 重要文件覆盖：40/639 - 证据索引条目：78 - 角色 / Skill 条目：5 ### 证据不足时的处理 - **missing_evidence**：说明证据不足，要求用户提供目标文件、README 段落或安装后验证记录；不要补全事实。 - **out_of_scope_request**：说明该任务超出当前 AI Context Pack 证据范围，并建议用户先查看 Human Manual 或真实安装后验证。 - **runtime_request**：给出安装前检查清单和命令来源，但不要替用户执行命令或声称已执行。 - **source_conflict**：同时展示冲突来源，标记为待核实，不要强行选择一个版本。 ## Prompt Recipes ### 适配判断 - 目标：判断这个项目是否适合用户当前任务。 - 预期输出：适配结论、关键理由、证据引用、安装前可预览内容、必须安装后验证内容、下一步建议。 ```text 请基于 nbrag 的 AI Context Pack，先问我 3 个必要问题，然后判断它是否适合我的任务。回答必须包含：适合谁、能做什么、不能做什么、是否值得安装、证据来自哪里。所有项目事实必须引用 evidence_refs、source_paths 或 claim_id。 ``` ### 安装前体验 - 目标：让用户在安装前感受核心工作流，同时避免把预览包装成真实能力或营销承诺。 - 预期输出：一段带边界标签的体验剧本、安装后验证清单和谨慎建议；不含真实运行承诺或强营销表述。 ```text 请把 nbrag 当作安装前体验资产，而不是已安装工具或真实运行环境。 请严格输出四段： 1. 先问我 3 个必要问题。 2. 给出一段“体验剧本”：用 [安装前可预览]、[必须安装后验证]、[证据不足] 三种标签展示它可能如何引导工作流。 3. 给出安装后验证清单：列出哪些能力只有真实安装、真实宿主加载、真实项目运行后才能确认。 4. 给出谨慎建议：只能说“值得继续研究/试装”“先补充信息后再判断”或“不建议继续”，不得替项目背书。 硬性边界： - 不要声称已经安装、运行、执行测试、修改文件或产生真实结果。 - 不要写“自动适配”“确保通过”“完美适配”“强烈建议安装”等承诺性表达。 - 如果描述安装后的工作方式，必须使用“如果安装成功且宿主正确加载 Skill，它可能会……”这种条件句。 - 体验剧本只能写成“示例台词/假设流程”：使用“可能会询问/可能会建议/可能会展示”，不要写“已写入、已生成、已通过、正在运行、正在生成”。 - Prompt Preview 不负责给安装命令；如用户准备试装，只能提示先阅读 Quick Start 和 Risk Card，并在隔离环境验证。 - 所有项目事实必须来自 supported claim、evidence_refs 或 source_paths；inferred/unverified 只能作风险或待确认项。 ``` ### 角色 / Skill 选择 - 目标：从项目里的角色或 Skill 中挑选最匹配的资产。 - 预期输出：候选角色或 Skill 列表，每项包含适用场景、证据路径、风险边界和是否需要安装后验证。 ```text 请读取 role_skill_index，根据我的目标任务推荐 3-5 个最相关的角色或 Skill。每个推荐都要说明适用场景、可能输出、风险边界和 evidence_refs。 ``` ### 风险预检 - 目标：安装或引入前识别环境、权限、规则冲突和质量风险。 - 预期输出：环境、权限、依赖、许可、宿主冲突、质量风险和未知项的检查清单。 ```text 请基于 risk_card、boundaries 和 quick_start_candidates，给我一份安装前风险预检清单。不要替我执行命令，只说明我应该检查什么、为什么检查、失败会有什么影响。 ``` ### 宿主 AI 开工指令 - 目标：把项目上下文转成一次对话开始前的宿主 AI 指令。 - 预期输出：一段边界明确、证据引用明确、适合复制给宿主 AI 的开工前指令。 ```text 请基于 nbrag 的 AI Context Pack，生成一段我可以粘贴给宿主 AI 的开工前指令。这段指令必须遵守 not_runtime=true，不能声称项目已经安装、运行或产生真实结果。 ``` ## 角色 / Skill 索引 - 共索引 5 个角色 / Skill / 项目文档条目。 - **nbrag-performance-check**（skill）：Use when changing retrieval, caching, Chroma query flow, grep, find files, or raw file reading and you need to verify whether nbrag MCP tool latency got faster or slower with tests/ai codes/benchmark.py. 激活提示：当用户任务与“nbrag-performance-check”描述的流程高度相关时，先用它做安装前体验，再决定是否安装。 证据：`.agents/skills/nbrag-performance-check/SKILL.md` - **nbrag-retrieval-quality-check**（skill）：当需要验证mcp服务的检索质量时使用。 激活提示：当用户任务与“nbrag-retrieval-quality-check”描述的流程高度相关时，先用它做安装前体验，再决定是否安装。 证据：`.agents/skills/nbrag-retrieval-quality-check/SKILL.md` - **restart-nbrag-mcp**（skill）：Use when nbrag MCP server code, tool docstrings, skills, ingestion, search behavior, or configuration changed and port 9101 must serve the latest local code before MCP validation. 激活提示：当用户任务与“restart-nbrag-mcp”描述的流程高度相关时，先用它做安装前体验，再决定是否安装。 证据：`.agents/skills/restart-nbrag-mcp/SKILL.md` - **restart-process**（skill）：Restart any running Python script by its absolute path — kills the old process tree including children and relaunches with a specified interpreter. Invoke when user asks to restart/kill a script that may have been started from any working directory, or when a long-running process needs a clean restart after code changes. 激活提示：当用户任务与“restart-process”描述的流程高度相关时，先用它做安装前体验，再决定是否安装。 证据：`.agents/skills/restart_process/SKILL.md` - **nbrag-workflow**（skill）：Use when the user asks a question that requires searching imported knowledge bases 激活提示：当用户任务与“nbrag-workflow”描述的流程高度相关时，先用它做安装前体验，再决定是否安装。 证据：`nbrag/skills/nbrag-workflow/SKILL.md` ## 证据索引 - 共索引 78 条证据。 - **nbrag**（documentation）：English README.md 简体中文 README.zh-CN.md 证据：`README.md` - **Readme**（documentation）：你把这个文件夹，复制到你自己项目下的被第三方工具认可扫描的skills文件夹下 证据：`nbrag/skills/readme.md` - **nbrag — AI Agent 指令**（documentation）：通用知识库 Agentic RAG MCP Server — 不限于编程，支持代码、文档、法律条文、医学指南、技术手册等任何文本。 证据：`AGENTS.md` - **nbrag Performance Check**（skill_instruction）：用这个 skill 验证 nbrag MCP 工具的 性能变化 ，尤其是检索、grep、文件发现、原文读取这几类调用是否变快或变慢。 证据：`.agents/skills/nbrag-performance-check/SKILL.md` - **nbrag Retrieval Quality Check**（skill_instruction）：运行 D:\codes\nbrag\tests\retrieval quality check 里面的脚本，检查每一个mcp函数的返回是否准确和完美 证据：`.agents/skills/nbrag-retrieval-quality-check/SKILL.md` - **Restart nbrag MCP**（skill_instruction）：Use this skill after changing D:/codes/nbrag MCP behavior and before validating through MCP tools. The goal is to make sure http://127.0.0.1:9101/mcp is served by the latest local code. 证据：`.agents/skills/restart-nbrag-mcp/SKILL.md` - **Restart Process**（skill_instruction）：Restart any running Python script by absolute path. Handles scripts started from any working directory relative path, partial path, or absolute path . 证据：`.agents/skills/restart_process/SKILL.md` - **nbrag agentic RAG 工作流**（skill_instruction）：注意 ：本文档中的函数名是 nbrag MCP 自身的函数名。当 nbrag 被接入其他 Agent 框架时， 实际暴露的 function 名称可能带前缀（例如 xxx nbrag search 或 mcp xxx nbrag search ），AI 应以实际接收到的 function 名称为准。 证据：`nbrag/skills/nbrag-workflow/SKILL.md` - **License**（source_file）：Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files the "Software" , to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: 证据：`LICENSE` - **nbrag**（documentation）：English README.md 简体中文 README.zh-CN.md 证据：`README.zh-CN.md` - **Runtime Cache Refresh Design**（documentation）：Prevent long-running HTTP MCP processes from holding stale Chroma/BM25/doc-id/symbol runtime caches after a rare external ingest rebuilds a prepared collection in rag db . 证据：`docs/superpowers/specs/2026-06-17-runtime-cache-refresh-design.md` - **nbrag grep Wording Cleanup Design**（documentation）：Tighten the nbrag grep wording so AI agents understand exactly when to use it and what it actually does, without changing any implementation logic. 证据：`docs/superpowers/specs/2026-06-20-nbrag-grep-wording-design.md` - **Config.Example**（source_file）：embedding: api key: ${NBRAG API KEY} base url: https://api.siliconflow.cn/v1 model: BAAI/bge-m3 rerank: model: BAAI/bge-reranker-v2-m3 storage: db path: ./rag db raw files path: "" chunking: chunk size: 1000 chunk overlap: 150 证据：`config.example.yaml` - **My Load Config**（source_file）：SILICONFLOW API KEY = os.environ "SILICONFLOW API KEY" 证据：`my_load_config.py` - **Bm25 Index**（source_file）：CAMEL SPLIT RE = re.compile r" a-z A-Z " CAMEL UPPER RE = re.compile r" A-Z + A-Z a-z " 证据：`nbrag/bm25_index.py` - **─── 行号计算 ─────────────────────────────────────────────**（source_file）：TEXT EXTENSIONS = { EXT TO LANG = { ⋮---- """根据文件类型自动选择最优切分策略（不含头部注入）。 代码文件按 class/function 边界切分；Markdown 按标题切分；通用文本按段落切分。 """ text = text.strip ⋮---- lang = EXT TO LANG.get file ext.lower ⋮---- splitter = RecursiveCharacterTextSplitter.from language ⋮---- splitter = RecursiveCharacterTextSplitter ⋮---- ─── 行号计算 ───────────────────────────────────────────── def build line offsets text ⋮---- """构建行号偏移表: line offsets i = 第 i+1 行的起始字符位置。""" offsets = 0 ⋮---- def compute line ranges full text, chunks, overlap=DEFAULT CHUNK OVERLAP ⋮---- """为每个 chunk 计算它在原文中的行号范围 1-based 。 使用顺序搜索 + 重叠偏移，确保每个 chunk 匹配到正确位置。 Returns: start line, end line , ... """ line offsets = build line offsets full text ranges… 证据：`nbrag/chunker.py` - **Config**（source_file）：PROJECT ROOT = os.path.dirname os.path.dirname os.path.abspath file DEFAULT DB PATH = os.path.join PROJECT ROOT, "rag db" ⋮---- @dataclass class EmbeddingConfig ⋮---- api key: str = "" base url: str = "https://api.siliconflow.cn/v1" model: str = "BAAI/bge-m3" ⋮---- @dataclass class RerankConfig ⋮---- model: str = "BAAI/bge-reranker-v2-m3" ⋮---- @dataclass class StorageConfig ⋮---- db path: str = DEFAULT DB PATH raw files path: str = "" 默认 db path/raw files ⋮---- @dataclass class ChunkingConfig ⋮---- chunk size: int = DEFAULT CHUNK SIZE chunk overlap: int = DEFAULT CHUNK OVERLAP ⋮---- @dataclass class RagConfig ⋮---- embedding: EmbeddingConfig = field default factory=EmbeddingConfig rerank:… 证据：`nbrag/config.py` - **Defaults**（source_file）：DEFAULT CHUNK SIZE = 1000 DEFAULT CHUNK OVERLAP = 150 DEFAULT FETCH CONTEXT CHARS = 4000 DEFAULT MATCH CONTEXT CHARS = 2000 证据：`nbrag/defaults.py` - **Embeddings**（source_file）：EMBEDDING BATCH SIZE = 32 def cfg def get http client def embed texts, max retries=10, sleep interval=0.0, verbose=False ⋮---- cfg = cfg api key = cfg.embedding.api key ⋮---- client = get http client all embeddings = total chunks = len texts num batches = total chunks + EMBEDDING BATCH SIZE - 1 // EMBEDDING BATCH SIZE ⋮---- batch = texts i:i + EMBEDDING BATCH SIZE ⋮---- processed = min i + EMBEDDING BATCH SIZE, total chunks ⋮---- resp = client.post ⋮---- data = resp.json sorted data = sorted data "data" , key=lambda x: x "index" ⋮---- def rerank query, documents, top n=5, max retries=3 ⋮---- """调用 Rerank API，返回 indices, scores 。""" ⋮---- n = min top n, len documents ⋮---- indices = r "index… 证据：`nbrag/embeddings.py` - **Ingest**（source_file）：CHROMA UPSERT BATCH = 5000 ⋮---- text = f.read ⋮---- file ext = os.path.splitext file path 1 abs path = normalize path file path file mtime = os.path.getmtime file path raw chunks = chunk text text, chunk size, chunk overlap, file ext=file ext ⋮---- filename = os.path.basename file path doc id = hashlib.md5 abs path.encode .hexdigest :12 ⋮---- def batch embed prepared prepared list, sleep interval=0.0, verbose=False ⋮---- all chunks = chunk refs = ⋮---- all embeddings = embed all chunks, sleep interval=sleep interval, verbose=verbose ⋮---- p = prepared list file idx ⋮---- prepared = prepare file no embed file path, chunk size, chunk overlap ⋮---- @ runtime guarded def check file cache file… 证据：`nbrag/ingest.py` - **Loggers**（source_file）：logger = logging.getLogger "nbrag" 证据：`nbrag/loggers.py` - **Mcp Tools**（source_file）：def strip markdown frontmatter text: str - str ⋮---- text = text.lstrip "\ufeff" ⋮---- lines = text.splitlines ⋮---- def load workflow skill text - str ⋮---- skill path = os.path.join os.path.dirname file , "skills", "nbrag-workflow", "SKILL.md" ⋮---- def is absolute file path path: str - bool ⋮---- """Return True only for full absolute file paths.""" ⋮---- p = str path .strip ⋮---- def str param value, default: str = "" - str ⋮---- """Normalize Field ... defaults when MCP wrappers are called directly in tests.""" ⋮---- def int param value, default: int - int def bool param value, default: bool - bool def build line char index content: str - tuple list str , list int ⋮---- """Return raw lin… 证据：`nbrag/mcp_tools.py` - **Retrieval**（source_file）：STATS CACHE TTL SECONDS = 300.0 DOCUMENT LIST CACHE TTL SECONDS = 300.0 RAW TEXT CACHE TTL SECONDS = 300.0 def cfg def build line char index content: str - tuple list str , list int ⋮---- lines = content.splitlines keepends=True offsets = 0 ⋮---- def char window to line range offsets: list int , line count: int, char start: int, char end: int - tuple int, int ⋮---- start line = max 1, min line count, bisect.bisect right offsets, max 0, char start end line = max start line, min line count, bisect.bisect left offsets, max char start, char end ⋮---- def load all raw texts cached ⋮---- now = time.time ⋮---- root = raw files dir collections = {} ⋮---- collection dir = os.path.join root, collecti… 证据：`nbrag/retrieval.py` - **Server**（source_file）：mcp = FastMCP "nbrag" ⋮---- @mcp.tool def nbrag help - str ⋮---- class FuncFields ⋮---- query: str = Field description="Natural-language semantic query for vector retrieval and reranking. Use the user's wording, clarified from conversation context when needed; keep it a question or statement, not a keyword list. For lexical BM25 anchors, use bm25 query separately." collection name: str = Field description="Knowledge base name = collection name = 知识库名字 call nbrag stats first if unknown " top k: int = Field default=5, description="Number of ranked hits to return" filter file path: str = Field default="", description="Optional exact full absolute file path returned by nbrag tools. Basename or… 证据：`nbrag/server.py` - **Storage**（source_file）：CHROMA GET BATCH = 500 def cfg def ensure dirs ⋮---- cfg = cfg ⋮---- def get chroma def batch get col, include, ids=None, where=None ⋮---- kwargs = {"include": list include } ⋮---- ids list = list ids ⋮---- result = {"ids": , "documents": , "metadatas": } ⋮---- batch = col.get ids=ids list i:i + CHROMA GET BATCH , include=list include ⋮---- id only = col.get include= all ids = id only.get "ids", ⋮---- batch = col.get ids=all ids i:i + CHROMA GET BATCH , include=list include ⋮---- def normalize path path ⋮---- p = os.path.abspath path .replace "\\", "/" ⋮---- p = p 0 .upper + p 1: ⋮---- def is absolute path path ⋮---- """判断入参是否是完整绝对路径，避免 basename/相对路径造成歧义。""" ⋮---- p = str path .strip ⋮----… 证据：`nbrag/storage.py` - **Symbol Index**（source_file）：def cfg def symbol index dir collection name def build symbol index collection name ⋮---- raw dir = os.path.join raw files dir , collection name ⋮---- doc id to info = get doc id map collection name index = {} ⋮---- doc id = os.path.splitext fname 0 info = doc id to info.get doc id, {} fpath = os.path.join raw dir, fname ⋮---- content = f.read ⋮---- tree = ast.parse content ⋮---- def walk node, parent chain="" ⋮---- name = child.name qualified = f"{parent chain}.{name}" if parent chain else name start = child.lineno end = child.end lineno if hasattr child, "end lineno" and child.end lineno else start sym type = "class" if isinstance child, ast.ClassDef else "function" sig = extract signatur… 证据：`nbrag/symbol_index.py` - **Start Http Rag Mcp**（source_file）：PORT = 9101 证据：`scripts/start_http_rag_mcp.py` - **第一编 总则**（documentation）：中华人民共和国民法典 （2020年5月28日第十三届全国人民代表大会第三次会议通过） 自2021年1月1日起施行。 证据：`scripts/ingest_ex1/01_总则.md` - **第二编 物权**（documentation）：中华人民共和国民法典 （2020年5月28日第十三届全国人民代表大会第三次会议通过） 自2021年1月1日起施行。 证据：`scripts/ingest_ex1/02_物权.md` - **第三编 合同**（documentation）：中华人民共和国民法典 （2020年5月28日第十三届全国人民代表大会第三次会议通过） 自2021年1月1日起施行。 证据：`scripts/ingest_ex1/03_合同.md` - **第四编 人格权**（documentation）：中华人民共和国民法典 （2020年5月28日第十三届全国人民代表大会第三次会议通过） 自2021年1月1日起施行。 证据：`scripts/ingest_ex1/04_人格权.md` - **第五编 婚姻家庭**（documentation）：中华人民共和国民法典 （2020年5月28日第十三届全国人民代表大会第三次会议通过） 自2021年1月1日起施行。 证据：`scripts/ingest_ex1/05_婚姻家庭.md` - **第六编 继承**（documentation）：中华人民共和国民法典 （2020年5月28日第十三届全国人民代表大会第三次会议通过） 自2021年1月1日起施行。 证据：`scripts/ingest_ex1/06_继承.md` - **第七编 侵权责任**（documentation）：中华人民共和国民法典 （2020年5月28日第十三届全国人民代表大会第三次会议通过） 自2021年1月1日起施行。 证据：`scripts/ingest_ex1/07_侵权责任.md` - **民法典 全文**（documentation）：中华人民共和国民法典 （2020年5月28日第十三届全国人民代表大会第三次会议通过） 自2021年1月1日起施行。 证据：`scripts/ingest_ex1/民法典_全文.md` - **最高人民法院关于适用《中华人民共和国民法典》婚姻家庭编的解释（一）**（documentation）：法释〔2020〕22号 2020年12月25日审判委员会第1825次会议通过，自2021年1月1日起施行。 证据：`scripts/ingest_ex2_marriage_law/司法解释_一_婚姻家庭编.md` - **最高人民法院关于适用《中华人民共和国民法典》婚姻家庭编的解释（二）**（documentation）：法释〔2025〕1号 2024年11月25日审判委员会第1933次会议通过，自2025年2月1日起施行。 证据：`scripts/ingest_ex2_marriage_law/司法解释_二_婚姻家庭编.md` - **第五编 婚姻家庭**（documentation）：中华人民共和国民法典 （2020年5月28日第十三届全国人民代表大会第三次会议通过） 自2021年1月1日起施行。 证据：`scripts/ingest_ex2_marriage_law/民法典_第五编_婚姻家庭.md` - **婚姻家庭编司法解释（二）—— 新闻发布会介绍**（documentation）：近年来，随着我国经济社会发展，城乡家庭的结构和生活方式发生了新变化，婚姻家庭矛盾呈现出新特点，家事纠纷案件数量高位运行。近三年来，全国法院审结一审婚姻家庭继承纠纷案件每年大约200万件，占全部一审民事案件的12%左右。其中，离婚纠纷案件每年大约150万件，占所有家事案件的近80%。离婚纠纷中，财产分割成为焦点。涉案标的额增大、财产类型多样化，婚姻家庭与财产领域问题交织，疑难复杂案件增多，法律适用标准亟待统一。 证据：`scripts/ingest_ex2_marriage_law/解释二_发布会背景介绍.md` - **婚姻家庭编司法解释（二）—— 记者问答与典型案例**（documentation）：2025年1月15日，最高人民法院举行新闻发布会，发布《最高人民法院关于适用〈中华人民共和国民法典〉婚姻家庭编的解释（二）》及典型案例。最高人民法院民一庭庭长陈宜芳，最高人民法院民一庭副庭长吴景丽，最高人民法院民一庭二级高级法官王丹出席发布会并回答了记者提问。 证据：`scripts/ingest_ex2_marriage_law/解释二_记者问答与典型案例.md` - **个人所得税专项附加扣除暂行办法**（documentation）：第一条 根据《中华人民共和国个人所得税法》（以下简称个人所得税法）规定，制定本办法。 证据：`scripts/ingest_ex3_worker_rights/专项附加扣除暂行办法.md` - **中华人民共和国个人所得税法**（documentation）：（1980年9月10日第五届全国人民代表大会第三次会议通过 根据1993年10月31日第八届全国人民代表大会常务委员会第四次会议《关于修改〈中华人民共和国个人所得税法〉的决定》第一次修正 根据1999年8月30日第九届全国人民代表大会常务委员会第十一次会议《关于修改〈中华人民共和国个人所得税法〉的决定》第二次修正 根据2005年10月27日第十届全国人民代表大会常务委员会第十八次会议《关于修改〈中华人民共和国个人所得税法〉的决定》第三次修正 根据2007年6月29日第十届全国人民代表大会常务委员会第二十八次会议《关于修改〈中华人民共和国个人所得税法〉的决定》第四次修正 根据2007年12月29日第十届全国人民代表大会常务委员会第三十一次会议《关于修改〈中华人民共和国个人所得税法〉的决定》第五次修正 根据2011年6月30日第十一届全国人民代表大会常务委员会第二十一次会议《关于修改〈中华人民共和国个人所得税法〉的决定》第六次修正 根据2018年8月31日第十三届全国人民代表大会常务委员会第五次会议《关于修改〈中华人民共和国个人所得税法〉的决定》第七次修正） 证据：`scripts/ingest_ex3_worker_rights/个人所得税法.md` - **中华人民共和国个人所得税法实施条例**（documentation）：（1994年1月28日中华人民共和国国务院令第142号发布 根据2005年12月19日《国务院关于修改〈中华人民共和国个人所得税法实施条例〉的决定》第一次修订 根据2008年2月18日《国务院关于修改〈中华人民共和国个人所得税法实施条例〉的决定》第二次修订 根据2011年7月19日《国务院关于修改〈中华人民共和国个人所得税法实施条例〉的决定》第三次修订 2018年12月18日中华人民共和国国务院令第707号第四次修订） 证据：`scripts/ingest_ex3_worker_rights/个人所得税法实施条例.md` - **住房公积金管理条例**（documentation）：1999年4月3日中华人民共和国国务院令第262号发布 根据2002年3月24日《国务院关于修改〈住房公积金管理条例〉的决定》第一次修订 根据2019年3月24日《国务院关于修改部分行政法规的决定》第二次修订 证据：`scripts/ingest_ex3_worker_rights/住房公积金管理条例.md` - **最高人民法院关于审理劳动争议案件适用法律问题的解释（一）**（documentation）：《最高人民法院关于审理劳动争议案件适用法律问题的解释（一）》已于2020年12月25日由最高人民法院审判委员会第1825次会议通过，现予公布，自2021年1月1日起施行。 证据：`scripts/ingest_ex3_worker_rights/劳动争议司法解释一.md` - **中华人民共和国劳动争议调解仲裁法**（documentation）：《中华人民共和国劳动争议调解仲裁法》已由中华人民共和国第十届全国人民代表大会常务委员会第三十一次会议于2007年12月29日通过，现予公布，自2008年5月1日起施行。 证据：`scripts/ingest_ex3_worker_rights/劳动争议调解仲裁法.md` - **劳动保障监察条例**（documentation）：（2004年10月26日国务院第68次常务会议通过 2004年11月1日中华人民共和国国务院令第423号公布 自2004年12月1日起施行） 证据：`scripts/ingest_ex3_worker_rights/劳动保障监察条例.md` - **中华人民共和国劳动合同法**（documentation）：（2007年6月29日第十届全国人民代表大会常务委员会第二十八次会议通过 根据2012年12月28日第十一届全国人民代表大会常务委员会第三十次会议《关于修改 的决定》修正） 证据：`scripts/ingest_ex3_worker_rights/劳动合同法.md` - **中华人民共和国劳动合同法实施条例**（documentation）：《中华人民共和国劳动合同法实施条例》已经2008年9月3日国务院第25次常务会议通过，现予公布，自公布之日起施行。 证据：`scripts/ingest_ex3_worker_rights/劳动合同法实施条例.md` - **中华人民共和国劳动法**（documentation）：（1994年7月5日第八届全国人民代表大会常务委员会第八次会议通过 根据2009年8月27日第十一届全国人民代表大会常务委员会第十次会议《关于修改部分法律的决定》第一次修正 根据2018年12月29日第十三届全国人民代表大会常务委员会第七次会议《关于修改〈中华人民共和国劳动法〉等七部法律的决定》第二次修正） 证据：`scripts/ingest_ex3_worker_rights/劳动法.md` - **失业保险条例**（documentation）：1998年12月26日国务院第11次常务会议通过，1999年1月22日国务院令第258号发布，自发布之日起施行。 证据：`scripts/ingest_ex3_worker_rights/失业保险条例.md` - **女职工劳动保护特别规定**（documentation）：《女职工劳动保护特别规定》已经2012年4月18日国务院第200次常务会议通过，现予公布，自公布之日起施行。 证据：`scripts/ingest_ex3_worker_rights/女职工劳动保护特别规定.md` - **工伤保险条例**（documentation）：2003年4月27日中华人民共和国国务院令第375号公布 根据2010年12月20日《国务院关于修改〈工伤保险条例〉的决定》修订 证据：`scripts/ingest_ex3_worker_rights/工伤保险条例.md` - **工资支付暂行规定**（documentation）：（1994年12月6日劳部发〔1994〕489号公布 自1995年1月1日起施行） 证据：`scripts/ingest_ex3_worker_rights/工资支付暂行规定.md` - **企业职工带薪年休假实施办法**（documentation）：（2008年9月18日人力资源社会保障部令第1号公布 自公布之日起施行） 证据：`scripts/ingest_ex3_worker_rights/带薪年休假实施办法.md` - **职工带薪年休假条例**（documentation）：（2007年12月7日国务院第198次常务会议通过 2007年12月14日中华人民共和国国务院令第514号公布 自2008年1月1日起施行） 证据：`scripts/ingest_ex3_worker_rights/带薪年休假条例.md` - **中华人民共和国社会保险法**（documentation）：2010年10月28日第十一届全国人民代表大会常务委员会第十七次会议通过 根据2018年12月29日第十三届全国人民代表大会常务委员会第七次会议《关于修改〈中华人民共和国社会保险法〉的决定》修正 证据：`scripts/ingest_ex3_worker_rights/社会保险法.md` - **中华人民共和国职业病防治法**（documentation）：（2001年10月27日第九届全国人民代表大会常务委员会第二十四次会议通过 根据2011年12月31日第十一届全国人民代表大会常务委员会第二十四次会议《关于修改〈中华人民共和国职业病防治法〉的决定》第一次修正 根据2016年7月2日第十二届全国人民代表大会常务委员会第二十一次会议《关于修改〈中华人民共和国节约能源法〉等六部法律的决定》第二次修正 根据2017年11月4日第十二届全国人民代表大会常务委员会第三十次会议《关于修改〈中华人民共和国会计法〉等十一部法律的决定》第三次修正 根据2018年12月29日第十三届全国人民代表大会常务委员会第七次会议《关于修改〈中华人民共和国劳动法〉等七部法律的决定》第四次修正） 证据：`scripts/ingest_ex3_worker_rights/职业病防治法.md` - **手把手教你读财报财报是用来排除企业的 唐朝 Z-Library**（documentation）：Source: 手把手教你读财报财报是用来排除企业的 唐朝 Z-Library .pdf 证据：`scripts/ingest_finance/手把手教你读财报财报是用来排除企业的 (唐朝) (Z-Library).md` - **方正中期能源产业链周度策略20260615**（documentation）：期货研究院 能源产业链周度策略 Energy Industry Weekly Trading Strategy 能源化工团队 摘要 作者： 隋晓影 【行情复盘】 上周五夜盘国内能源类品种整体走跌，沥青表现偏强。 从业资格证号： F0284756 【重要资讯】 投资咨询证号： Z0010956 联系方式： 010-68578690 原油：1、据伊朗媒体12日报道，伊朗外长阿拉格齐表示，一旦伊 美完成最后阶段的谈判，谅解备忘录将立即签署并公布。第一阶段 投资咨询业务资格：京证监许可【2012】75号 将以远程电子方式签署，“这可能在未来几天内发生”。 2、据阿拉伯阿拉比亚电视台：高级消息人士表示，美伊协议的签 成文时间：2026年06月13日星期六 署将以远程方式进行，日内瓦的会议将暂时推迟。 3、据伊朗媒体12日报道，伊朗外长阿拉格齐当天在谈及伊美谅解 备忘录草案时表示，霍尔木兹海峡相关服务将收取费用。 4、当地时间6月11日，美国总统特朗普就伊朗问题表示“达成了极 好的协议”，并称相关文件已进入最后定稿阶段，未来几天内有望 最终敲定，并即将签署。他还表示，协议可能在欧洲签署，时间可 能在本周末，美国副总统万斯将出席。特朗普称，一旦伊朗方面签 署协议，霍尔木兹海峡就会开放。伊朗方面对此暂无回应。当地时 间12日，伊朗外交部发言人巴加埃表示，目前伊美双方已经在大多 数问题上达成谅解，伊朗内部正在对谅解备忘录文本进行最后阶段 的汇总。 5、据伊朗伊斯兰共和国通讯社（IRNA）：伊朗外交部发言人表示 更多精彩内容请关注方正中期官方微信 ，双方已就谈判中的大部分问题达成共识，目前我们正… 证据：`scripts/ingest_finance/方正中期能源产业链周度策略20260615.md` - 其余 18 条证据见 `AI_CONTEXT_PACK.json` 或 `EVIDENCE_INDEX.json`。 ## 宿主 AI 必须遵守的规则 - **把本资产当作开工前上下文，而不是运行环境。**：AI Context Pack 只包含证据化项目理解，不包含目标项目的可执行状态。 证据：`README.md`, `nbrag/skills/readme.md`, `AGENTS.md` - **回答用户时区分可预览内容与必须安装后才能验证的内容。**：安装前体验的消费者价值来自降低误装和误判，而不是伪装成真实运行。 证据：`README.md`, `nbrag/skills/readme.md`, `AGENTS.md` ## 用户开工前应该回答的问题 - 你准备在哪个宿主 AI 或本地环境中使用它？ - 你只是想先体验工作流，还是准备真实安装？ - 你最在意的是安装成本、输出质量、还是和现有规则的冲突？ ## 验收标准 - 所有能力声明都能回指到 evidence_refs 中的文件路径。 - AI_CONTEXT_PACK.md 没有把预览包装成真实运行。 - 用户能在 3 分钟内看懂适合谁、能做什么、如何开始和风险边界。 --- ## Doramagic Context Augmentation 下面内容用于强化 Repomix/AI Context Pack 主体。Human Manual 只提供阅读骨架；踩坑日志会被转成宿主 AI 必须遵守的工作约束。 ## Human Manual 骨架 使用规则：这里只是项目阅读路线和显著性信号，不是事实权威。具体事实仍必须回到 repo evidence / Claim Graph。 宿主 AI 硬性规则： - 不得把页标题、章节顺序、摘要或 importance 当作项目事实证据。 - 解释 Human Manual 骨架时，必须明确说它只是阅读路线/显著性信号。 - 能力、安装、兼容性、运行状态和风险判断必须引用 repo evidence、source path 或 Claim Graph。 - **项目概览与系统架构**：importance `high` - source_paths: README.md, README.zh-CN.md, nbrag/__init__.py, nbrag/__main__.py, nbrag/server.py - **数据接入、切片与索引管线**：importance `high` - source_paths: nbrag/ingest.py, nbrag/chunker.py, nbrag/embeddings.py, nbrag/bm25_index.py, nbrag/symbol_index.py - **检索能力与 MCP 工具集**：importance `high` - source_paths: nbrag/mcp_tools.py, nbrag/retrieval.py, nbrag/server.py, nbrag/loggers.py, nbrag/defaults.py - **配置、部署与扩展**：importance `medium` - source_paths: nbrag/config.py, nbrag/defaults.py, config.example.yaml, scripts/start_http_rag_mcp.py, scripts/start_local_rag_mcp.py ## Repo Inspection Evidence / 源码检查证据 - repo_clone_verified: true - repo_inspection_verified: true - repo_commit: `875e0b9bd3e6e1352b6ca1f31716518082381468` - inspected_files: `README.md`, `pyproject.toml`, `docs/superpowers/specs/2026-06-17-runtime-cache-refresh-design.md`, `docs/superpowers/specs/2026-06-20-nbrag-grep-wording-design.md` 宿主 AI 硬性规则： - 没有 repo_clone_verified=true 时，不得声称已经读过源码。 - 没有 repo_inspection_verified=true 时，不得把 README/docs/package 文件判断写成事实。 - 没有 quick_start_verified=true 时，不得声称 Quick Start 已跑通。 ## Doramagic Pitfall Constraints / 踩坑约束 这些规则来自 Doramagic 发现、验证或编译过程中的项目专属坑点。宿主 AI 必须把它们当作工作约束，而不是普通说明文字。 ### Constraint 1: 能力判断依赖假设 - Trigger: README/documentation is current enough for a first validation pass. - Host AI rule: 将假设转成下游验证清单。 - Why it matters: 假设不成立时，用户拿不到承诺的能力。 - Evidence: capability.assumptions | https://github.com/ydf0509/nbrag | README/documentation is current enough for a first validation pass. - Hard boundary: 不要把这个坑点包装成已解决、已验证或可忽略，除非后续验证证据明确证明它已经关闭。 ### Constraint 2: 维护活跃度未知 - Trigger: 未记录 last_activity_observed。 - Host AI rule: 补 GitHub 最近 commit、release、issue/PR 响应信号。 - Why it matters: 新项目、停更项目和活跃项目会被混在一起，推荐信任度下降。 - Evidence: evidence.maintainer_signals | https://github.com/ydf0509/nbrag | last_activity_observed missing - Hard boundary: 不要把这个坑点包装成已解决、已验证或可忽略，除非后续验证证据明确证明它已经关闭。 - Trigger: no_demo - Evidence: downstream_validation.risk_items | https://github.com/ydf0509/nbrag | no_demo; severity=medium - Hard boundary: 不要把这个坑点包装成已解决、已验证或可忽略，除非后续验证证据明确证明它已经关闭。 ### Constraint 4: 存在评分风险 - Trigger: no_demo - Why it matters: 风险会影响是否适合普通用户安装。 - Evidence: risks.scoring_risks | https://github.com/ydf0509/nbrag | no_demo; severity=medium - Hard boundary: 不要把这个坑点包装成已解决、已验证或可忽略，除非后续验证证据明确证明它已经关闭。 ### Constraint 5: issue/PR 响应质量未知 - Trigger: issue_or_pr_quality=unknown。 - Host AI rule: 抽样最近 issue/PR，判断是否长期无人处理。 - Why it matters: 用户无法判断遇到问题后是否有人维护。 - Evidence: evidence.maintainer_signals | https://github.com/ydf0509/nbrag | issue_or_pr_quality=unknown - Hard boundary: 不要把这个坑点包装成已解决、已验证或可忽略，除非后续验证证据明确证明它已经关闭。 ### Constraint 6: 发布节奏不明确 - Trigger: release_recency=unknown。 - Host AI rule: 确认最近 release/tag 和 README 安装命令是否一致。 - Why it matters: 安装命令和文档可能落后于代码，用户踩坑概率升高。 - Evidence: evidence.maintainer_signals | https://github.com/ydf0509/nbrag | release_recency=unknown - Hard boundary: 不要把这个坑点包装成已解决、已验证或可忽略，除非后续验证证据明确证明它已经关闭。