Doctree Mcp

io.github.joesaby由 GitHub 账号 joesaby 发布v1.0.1更新于 Oct 24, 2026

BM25 search + tree navigation over markdown docs for AI agents. No embeddings, no LLM calls.

已验证STDIO仅桌面文件与存储知识与记忆

概览

AI 生成的概览

一个本地 MCP 服务器,为助手提供对 markdown、CSV 和 JSONL 文档的 BM25 关键词搜索与树形导航,不使用向量嵌入或 LLM 调用。

可以做什么
对 markdown、CSV 和 JSONL 文件进行 BM25 关键词搜索,支持分面过滤和术语表扩展,并可按精确键查找结构化数据中的行。浏览文档树以查看标题、字数和摘要,然后读取某个章节的全文,或一次读取某章节及其全部子节点。启用写入工具后,可查找近似重复条目、为新 wiki 条目生成建议路径和 frontmatter 草稿,并在校验和试运行后写入。
适用场景
适合助手需要基于本地文档、运维手册或笔记文件夹回答问题,且你希望获得可审计的“先搜索再导航”轨迹而非不透明的相似度分数。也适合在原始素材之上构建由智能体维护的 wiki。
运行要求
通过 stdio 在本地运行,使用 bunx 从 npm 包 doctree-mcp 启动,因此需要 Bun 运行时。需要设置 DOCS_ROOT(或使用 DOCS_ROOTS 配置加权多集合);可选 DOCS_GLOB、GLOSSARY_PATH 和 WIKI_WRITE。未声明任何身份验证。
安装前请注意
写入工具默认关闭,只有设置 WIKI_WRITE 为 1 才启用;启用后会在文档根目录下创建或覆盖文件,请先检查试运行输出和路径限制。服务器会索引 glob 匹配到的所有文件,因此只应指向你愿意让助手访问的文件夹。

安装

在 SourceWeft 中

  1. 打开 控制台中的 Doctree Mcp,将其添加到工作区。
  2. 为需要使用其工具的对话启用该服务。

Desktop only,通过 STDIO。 STDIO 服务会启动本地进程,因此需要 SourceWeft 桌面宿主。

其他 MCP 客户端

参照 仓库 中的启动说明。

README

doctree-mcp

Agentic document retrieval over markdown, CSV, and JSONL. BM25 + tree navigation via MCP — no vector DB, no embeddings, no LLM calls at index time.

The pitch: MCP provides the structural primitives (a navigable tree, BM25, glossary, row lookup). The bundled skills provide the procedural knowledge (how to walk that tree). Together the agent behaves like a trained research librarian — not a one-shot searcher. See The Skill + MCP Pattern.


Quick Start

Have docs already? Point a client at them:

bash
# In your AI tool's MCP config — see docs/CLIENTS.md for per-tool snippets{ "mcpServers": { "doctree": {    "command": "bunx", "args": ["doctree-mcp"],    "env": { "DOCS_ROOT": "./docs", "WIKI_WRITE": "1" }} } }

Restart the tool → ask "search the docs for X" or invoke the doc-read prompt.

Starting fresh? Scaffold a Karpathy-style LLM wiki:

bash
bunx doctree-mcp init          # configure current toolbunx doctree-mcp init --all    # configure every supported clientbunx doctree-mcp init --dry-run

Creates docs/wiki/ (LLM-maintained) + docs/raw-sources/ (your inputs), writes the MCP config, installs a post-write lint hook, appends wiki conventions to CLAUDE.md / AGENTS.md / .cursor/rules/.


Operation Modes

ModeUse whenGuide
stdio (default)Local dev, agent on your machineClient setup
HTTP (Streamable HTTP)Teams, CI, hosted agentsDeployment — Railway · Fly · Render · Cloudflare Containers · Docker
CLIinit, lint, debug-indexOperation modes

Full decision tree: Operation Modes.


How It Works — Retrieve · Curate · Add

Agent: "How does token refresh work?"
→ search_documents("token refresh")  #1  auth/middleware.md § Token Refresh Flow       score: 12.4  #2  auth/oauth.md       § Refresh Token Lifecycle  score: 8.7
→ get_tree("docs:auth:middleware")  [n1] # Auth Middleware    [n4] ## Token Refresh Flow      [n5] ### Automatic Refresh
→ navigate_tree("docs:auth:middleware", "n4")   ← n4 + descendants

Core read tools (always on):

ToolPurpose
search_documentsBM25 keyword search + facet filters + glossary expansion (markdown · CSV · JSONL)
get_treeTable of contents — headings, word counts, summaries
get_node_contentFull text of a specific section by node ID
navigate_treeA section plus all descendants in one call
lookup_rowO(1) exact-key lookup for structured data rows (e.g. PROJ-44)

Wiki write tools (opt-in with WIKI_WRITE=1):

ToolPurpose
find_similarDuplicate detection with overlap ratios
draft_wiki_entryScaffold: suggested path, inferred frontmatter, glossary hits
write_wiki_entryValidated write: path containment, schema, duplicate guards, dry-run

Safety: path containment · frontmatter validation · duplicate detection · dry-run · overwrite protection.

Deprecated aliases (list_documents, find_files, find_symbol) are superseded by search_documents — still functional, no longer recommended.


The Skill + MCP Pattern

Most retrieval tools hand the agent a search box and hope for the best. doctree-mcp hands it a tree, and the bundled skills teach it how to walk one.

  • MCP = structural primitives. search_documents, get_tree, navigate_tree, get_node_content, lookup_row return tree positions the agent reasons over — not finished answers.
  • Skills = procedural knowledge. /doc-read, /doc-write, /doc-lint encode breadcrumb drill-down: search → outline → navigate → retrieve. The agent learns the policy, not just the API.

That pairing doesn't exist cleanly elsewhere:

ApproachPrimitiveSkill teachesGap
Managed hybrid RAG (Cloudflare AI Search, Nia)Flat chunks + similarity—Black-box score, no audit trail
Tool-returns-answer (Context7)2 tools returning answersQuery shapeAgent can't reason about skipped content
Skill-over-CLI (QMD)CLI over flat searchQuery expansionNo tree to navigate
doctree-mcp + /doc-readNavigable treeBreadcrumbs, multi-instance routing, wiki compilation—

Why iterative retrieval wins:

  • Context rot. Stuffing a 1M-token window with chunks degrades output. Breadcrumb navigation keeps working memory small.
  • Auditability. search_documents → get_tree → navigate_tree → get_node_content is a replayable trail. A cosine score is not. Regulated domains can ship the former.
  • Progressive disclosure. Fewer navigable primitives beat tool sprawl (cf. Cloudflare Code Mode).

Multi-instance = client-side federation. Register several doctree servers under different names; the /doc-read skill encodes the routing policy. Add or remove instances without touching the skill. See Client setup → Multi-instance routing.


The LLM Wiki Pattern

┌─────────────────┐     ┌─────────────────┐     ┌─────────────────┐│  Raw Sources    │     │  The Wiki        │     │  The Schema     ││  (immutable)    │ ──→ │  (LLM-maintained)│ ←── │  (you define)   ││  notes · logs   │     │  runbooks · refs │     │  CLAUDE.md rules │└─────────────────┘     └─────────────────┘     └─────────────────┘

Inspired by Karpathy's LLM Wiki. Full walkthrough: docs/LLM-WIKI-GUIDE.md.


Configuration (summary)

yaml
---title: "Descriptive Title"description: "One-line summary — boosts ranking"tags: [relevant, terms]type: runbook          # runbook | guide | reference | tutorial | architecture | adrcategory: auth---

All non-reserved frontmatter fields become filter facets:

search_documents("auth", filters: { type: "runbook", tags: ["production"] })

Common env vars:

VariableDefaultDescription
DOCS_ROOT./docsDocs folder
DOCS_GLOB**/*.mdComma-separated globs (**/*.md,**/*.csv,**/*.jsonl)
DOCS_ROOTS—Weighted multi-collection (./wiki:1.0,./rfcs:0.5)
PORT3100HTTP mode port
WIKI_WRITE(unset)1 enables write tools
GLOSSARY_PATH$DOCS_ROOT/glossary.jsonQuery-expansion glossary

Full reference: docs/CONFIGURATION.md.

Glossary — place glossary.json in docs root for bidirectional query expansion:

json
{ "CLI": ["command line interface"], "K8s": ["kubernetes"] }

Acronym definitions like "TLS (Transport Layer Security)" are also auto-extracted.

Structured data — CSV/JSONL files become documents where each row is a tree node. Column roles (id, title, description, facets, URL) are auto-detected from headers. See docs/STRUCTURED-DATA.md.


Running from Source

bash
git clone https://github.com/joesaby/doctree-mcp.gitcd doctree-mcp && bun install
DOCS_ROOT=./docs bun run serve          # stdioDOCS_ROOT=./docs bun run serve:http     # HTTP (port 3100)DOCS_ROOT=./docs bun run index          # CLI: inspect indexed outputbun test

Performance

OperationTimeToken cost
Full index (900 docs)2–5s0
Incremental re-index~50ms0
Search5–30ms~300–1K tokens
Tree outline<1ms~200–800 tokens

Docs

Setup & operation

  • Operation Modes — stdio · HTTP · CLI
  • Client Setup — Claude Code · Cursor · Windsurf · Codex · OpenCode · Claude Desktop
  • Deployment — Railway · Fly.io · Render · Cloudflare Containers · Docker
  • Configuration — env vars, frontmatter, ranking tuning

Patterns & concepts

Source


Standing on Shoulders

License

MIT

来源:README.md,提交 1755742

工具

0
SourceWeft 尚未在沙箱中启动过该软件包,因此其工具未知。

版本历史

1
  1. v1.0.1最新Sep 16, 2026

评分

已满足适用检查项的 50%

该评分衡量此收录条目的完整程度,依据注册中心条目、端点与公开来源计算得出。它不是对服务器本身的评价,也不表示服务器安全或当前可用:可连通性是带日期的检查结果,评分也不包含安装量或用户评价。

  • 近 30 天内可连通25 分

    请保持端点能够响应 MCP 握手;SourceWeft 每 30 天探测一次。

  • 已声明认证方式10 分

    请在注册中心条目中声明凭据请求头,或保持端点能够响应探测,以便判定其认证方式。

  • 已列出工具15 分

    请让服务器在无凭据时响应 tools/list,或发布可在沙箱中无凭据启动的软件包。

  • 描述必需15 分
  • 图标10 分
  • 文档15 分
  • 许可证10 分