Skip to main content
Glama
xuj1nfan

terminal_kb

by xuj1nfan

Terminal Knowledge Base

一个只面向终端的本地知识库,用于管理 PDF、Markdown 笔记和论文写作证据。它不依赖 Obsidian 或 Zotero,可以直接通过 CLI、脚本和 MCP agent 使用。

特性

  • SQLite FTS5 全文检索,支持中文和英文

  • PDF 按页解析,返回 citekey、页码和原文片段

  • Markdown 笔记递归导入,保留稳定 citekey

  • BibTeX 书目文件和研究草稿目录

  • JSON-RPC over stdio MCP server,可接入 Codex 等终端 agent

  • 可选 LanceDB + Sentence Transformers 向量索引

  • 所有索引和解析结果均为本地可重建文件

Related MCP server: search-docs

环境要求

  • Linux/macOS

  • Python 3.11+

  • pdftotextpdfinfopdftoppm(推荐安装 poppler

基础全文检索不需要额外 Python 依赖。推荐使用 Python 3.12 虚拟环境和 uv

uv python install 3.12
uv venv --python 3.12 .venv
uv pip install --python .venv/bin/python -e .

可选依赖:

# 向量检索(CPU 环境)
uv pip install --python .venv/bin/python lancedb sentence-transformers

# 更复杂的 PDF 版面、表格和公式解析
uv pip install --python .venv/bin/python docling

非N卡:

uv pip install --python .venv/bin/python \
  torch==2.6.0+cpu \
  --index-url https://download.pytorch.org/whl/cpu

快速开始

./kb init
./kb add ~/Books/paper.pdf --title "Paper title" --author "Doe, Jane" --year 2024
./kb add ~/notes/method.md --title "Method notes"
./kb index --all
./kb search "retrieval augmented generation" --limit 5

常用命令:

./kb status
./kb doctor
./kb show <citekey> --page 2
./kb passage --citekey <citekey> --page 2
./kb cite <citekey> --page 2
./kb page-image <citekey> 2 --dpi 150

论文引用格式为:[@citekey, p. 2]

导入现有目录

kb add 可以逐个添加文件。批量导入时可使用 shell:

find ~/Books/final -type f \( -iname '*.pdf' -o -iname '*.md' \) -print0 |
  while IFS= read -r -d '' file; do
    ./kb add "$file"
  done
./kb index --all --force

MCP agent 接入

serve-mcp 使用 stdin/stdout 传输 JSON-RPC,不需要额外 MCP SDK:

[mcp_servers.terminal_kb]
command = "/absolute/path/to/knowledge-base/kb"
args = ["--root", "/absolute/path/to/knowledge-base", "serve-mcp"]

提供的工具包括:

  • search_library:搜索 PDF 和 Markdown 证据

  • get_passage:取得带页码的精确片段

  • get_document:查看文档元数据和状态

  • get_page_image:渲染 PDF 页面核对公式、表格和图形

  • find_evidence:按论断寻找证据

  • index_status:查看索引状态

向量检索

向量索引是可选功能,在 .kb/config.toml 中启用:

enable_vectors = true
embedding_model = "BAAI/bge-small-zh-v1.5"

然后重建:

./kb index --all --force

首次运行会从 Hugging Face 下载模型。

验证

./kb doctor
.venv/bin/python -m unittest discover -s tests -v
Install Server
F
license - not found
B
quality
C
maintenance

Maintenance

Maintainers
Response time
Release cycle
Releases (12mo)
Commit activity

Resources

Unclaimed servers have limited discoverability.

Looking for Admin?

If you are the server author, to access and configure the admin panel.

Related MCP Servers

  • F
    license
    Not graded
    quality
    D
    maintenance
    Enables AI assistants to search and query PDF documents through a local RAG system with vector embeddings. Provides semantic document search capabilities while keeping all data stored locally without external dependencies.
  • A
    license
    A
    quality
    A
    maintenance
    Enables AI agents to search local Markdown documents using natural language, with automatic indexing and section-level retrieval.
    9
    2
    1
    MIT
  • F
    license
    A
    quality
    B
    maintenance
    A local-first document retrieval engine that mounts as an MCP tool for agents to index files, search for relevant passages, and let the agent's own LLM answer.
    4
  • A
    license
    Not graded
    quality
    B
    maintenance
    Enables AI agents to search, read, and traverse a local knowledge base of Markdown files using full-text search and relationship graph, reducing token usage.
    MIT

View all related MCP servers

Related MCP Connectors

  • Search and reason over your Obsidian-style Markdown vault, right from ChatGPT.

  • Token-efficient search for coding agents over public and private documentation.

  • Search arXiv/Semantic Scholar/OpenAlex + medical evidence (PubMed/Europe PMC) + LaTeX/PDF tools.

View all MCP Connectors

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/xuj1nfan/knowledge_base'

If you have feedback or need assistance with the MCP directory API, please join our Discord server