knowledge-base AGENTS.md

Repository instructions for a Chinese knowledge-base project containing a VitePress documentation site and a Python service that searches the documents.

In plain words
What is it for?
Use them when editing documentation, changing the search service, building the site, refreshing its index, or preparing commits and pull requests.
Why use it?
They explain the project layout, writing conventions, build checks, and how to keep the document search index up to date.

Instructions file for CodexOpenCode

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add instructions/caitao-ct/knowledge-base/agents-md
Clone the repo
git clone --depth 1 https://github.com/caitao-ct/knowledge-base

Made for: Codex, OpenCode.

Per session 600 This file is loaded in full into every session.
When invoked 600 The same file — it is already loaded in full.
Security scan A 0 findings. Scan, not verified.
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.

ModelPer sessionOnce invoked
Fable 5 $0.00600 $0.00600
Opus 5 $0.00300 $0.00300
Sonnet 5 $0.00120 $0.00120
Haiku 4.5 $0.00060 $0.00060

Measured 2d ago against content hash 43b237ce944b, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

knowledge-base 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 2d 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.

AGENTS.md · 37 lines

What it actually says

仓库规范

项目结构

  • docs/ 存放知识库 Markdown 原文,也是 VitePress 站点内容来源。
  • docs/.vitepress/config.js 定义导航和侧边栏。
  • mcp-server/ 存放 Python MCP RAG 服务,核心文件是 server.py,索引数据在 .chroma/
  • bin/knowledge-mcp 是 MCP 服务启动脚本。

构建与运行

  • npm run docs:dev 本地启动 VitePress 文档站。
  • npm run docs:build 构建静态站点到 docs/.vitepress/dist/
  • npm run docs:preview 预览构建后的站点。
  • cd mcp-server && python server.py 直接启动 MCP 服务。
  • bin/knowledge-mcp 使用仓库默认配置启动 MCP 服务。

编写规范

  • 文档请使用 Markdown,并尽量用清晰的 ## 作为二级分段;MCP 索引会按二级标题切片。
  • 新文件路径请保持与现有分类一致,例如 docs/UI组件/Button.mddocs/业务场景/订单流程.md
  • 标题建议简短、明确,优先使用中文。
  • Python 代码风格保持和 server.py 一致:标准库优先导入、函数短小、路径处理明确。

验证方式

  • 本仓库没有完整的自动化测试套件。
  • 修改文档后,至少运行 npm run docs:build 检查是否能正常构建。
  • 修改 MCP 相关代码后,启动 bin/knowledge-mcp,确认可以正常索引 docs/,且没有报错。
  • 调整知识文档时,注意 ## 分段是否仍然清晰可切。

提交与 PR

  • 当前工作区没有可用的本地 git 历史,因此没有固定的仓库专属提交模板可参考。
  • 提交信息建议简短、祈使式,例如 docs: update payment rulesmcp: fix index refresh
  • PR 说明应写清楚改了哪些内容、影响哪些路径、做了哪些验证。
  • 只有 VitePress 界面变化时才需要附截图,纯文档修改通常只需文字说明。

Agent 说明

  • 修改 docs/ 下的文件后,记得重启服务或调用 refresh_index 让索引同步。
  • 不要直接修改 docs/.vitepress/dist/mcp-server/.chroma/ 这类生成产物,应该通过构建或索引流程重新生成。
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.

  1. 2d ago First seen · 37 lines · 600 tokens per session scan A 43b237ce944b

Subscribe to this mod's changes

knowledge-base AGENTS.md is an instructions file published in the GitHub repository caitao-ct/knowledge-base (2 stars, last pushed 3mo ago), licensed ISC. It adds 600 tokens to every session, about $0.0030 per session on Opus 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.