Mcp Documentation Server

io.github.andrea9293由 GitHub 帳號 andrea9293 發布v1.15.3更新於 Oct 25, 2026

Local-first document management and semantic search for AI coding agents

已驗證STDIO僅桌面檔案與儲存知識與記憶

概覽

AI 產生的概覽

本地優先的文件伺服器,讓 AI 助理儲存文件、處理上傳檔案,並對它們進行混合語意搜尋,內建網頁儀表板。

可以做什麼
在本地知識庫中新增、列出、讀取和刪除文件,支援中繼資料與內容預覽。處理放入 uploads 資料夾的 .txt、.md、.pdf 檔案,進行分塊並產生嵌入,並可查看上傳路徑與檔案清單。在單一文件內做向量語意搜尋,在所有文件間做全文加向量的混合搜尋,並取得符合分塊附近的上下文視窗。設定金鑰後可選用 Gemini 驅動的 AI 搜尋。連接埠 3080 上的網頁儀表板提供同樣的瀏覽、上傳、搜尋和刪除操作,所有工具也以 REST API 形式開放。
適用情境
適合希望助理以本機檔案建立並查詢私有、離線文件或知識庫,而不依賴雲端資料庫或廠商帳號的情境。也適合需要檢索專案文件、筆記或 PDF 並取得周邊上下文的程式開發助理。
執行需求
透過 npx 在本機執行(需要 Node.js)。無需帳號或 API 金鑰,所有環境變數皆為選用。GEMINI_API_KEY 可啟用 AI 搜尋。MCP_BASE_DIR 指定資料目錄,網頁介面預設綁定 127.0.0.1:3080。嵌入模型首次使用時下載(約 80–420 MB)。
安裝前請注意
工具可新增和刪除文件,delete_document 還會移除分塊、資料庫項目及相關檔案,刪除無法復原。網頁介面和 REST API 會在連接埠 3080 自動啟動;將 WEB_HOST 設為 0.0.0.0 會在所有網路介面上暴露它們。使用 AI 搜尋時 GEMINI_API_KEY 會傳送給 Google。更換嵌入模型需要重新加入所有文件。

安裝

在 SourceWeft 中

  1. 開啟 儀表板中的 Mcp Documentation Server,將其新增到工作區。
  2. 為需要使用其工具的對話啟用該服務。

Desktop only,透過 STDIO。 STDIO 服務會啟動本機處理程序,因此需要 SourceWeft 桌面主機。

其他 MCP 客戶端

參照 儲存庫 中的啟動說明。

README

[MCP Registry] [npm version] [GitHub Stars] [License: MIT] [Ask DeepWiki]

[Donate with PayPal] ["Buy Me A Coffee"]

MCP Documentation Server

Local-first document management and semantic search for AI coding agents. No external databases, no cloud APIs, no vendor lock-in.

Unlike other MCP servers that are CLI-only, this one ships with a full web dashboard — browse, search, upload, and manage your knowledge base from your browser. Every MCP tool is also exposed as a REST API, giving AI agents a lean, schema-free interface.

  • 🏠 Runs fully offline — Orama vector DB with local AI embeddings (Transformers.js)
  • 🌐 Built-in Web UI — starts automatically on port 3080 alongside the MCP server
  • 🔍 Hybrid search — full-text + vector similarity with parent-child chunking
  • 🤖 Optional AI search — Google Gemini for advanced document analysis (bring your own key)
  • 📁 Drag & drop uploads — .txt, .md, .pdf support
  • 📦 Published on the MCP Registry — installable via npx, no clone needed

Quick Start

json
{  "mcpServers": {    "documentation": {      "command": "npx",      "args": ["-y", "@andrea9293/mcp-documentation-server"]    }  }}

Open your browser at http://localhost:3080 — the web UI starts automatically.

🤖 Agent Skill (REST API) — recommended for AI agents

Every MCP tool is also accessible via the REST API on http://127.0.0.1:3080/api/. This is the recommended way to interact from AI agents (Claude Code, OpenCode, Gemini CLI, Cursor) because it avoids loading MCP tool schemas into the conversation context — only the response JSON enters.

bash
curl -s http://127.0.0.1:3080/api/configcurl -s http://127.0.0.1:3080/api/documentscurl -s -X POST http://127.0.0.1:3080/api/search-all \  -H "Content-Type: application/json" \  -d '{"query": "your search", "limit": 5}'

A ready-to-use skill is included at skills/documentation-server/SKILL.md — it teaches your agent every endpoint with examples. Install it:

bash
npx skills add https://github.com/andrea9293/mcp-documentation-server --skill documentation-server

Basic workflow

  1. Add documents using add_document or place .txt / .md / .pdf files in the uploads folder and call process_uploads.
  2. Search across everything with search_all_documents, or within a single document with search_documents.
  3. Use get_context_window to fetch neighboring chunks and give the LLM broader context.

Web UI

The web interface starts automatically on port 3080 when the MCP server launches. From the web UI you can:

  • 📊 Dashboard — overview of all documents and stats
  • 📄 Documents — browse, view, and delete documents
  • ➕ Add Document — create documents with title, content, and metadata
  • 🔍 Search All — semantic search across all documents
  • 🎯 Search in Doc — search within a specific document
  • 🤖 AI Search — Gemini-powered analysis (if GEMINI_API_KEY is set)
  • 📁 Upload Files — drag & drop files and process them into the knowledge base
  • 🪟 Context Window — explore chunks around a specific index

Configure an MCP client

Minimal
json
{  "mcpServers": {    "documentation": {      "command": "npx",      "args": ["-y", "@andrea9293/mcp-documentation-server"]    }  }}
With environment variables (all optional)
json
{  "mcpServers": {    "documentation": {      "command": "npx",      "args": ["-y", "@andrea9293/mcp-documentation-server"],      "env": {        "MCP_BASE_DIR": "/path/to/workspace",        "GEMINI_API_KEY": "your-api-key-here",        "MCP_EMBEDDING_MODEL": "Xenova/all-MiniLM-L6-v2",        "START_WEB_UI": "true",        "WEB_HOST": "127.0.0.1",        "WEB_PORT": "3080"      }    }  }}

All environment variables are optional. Without GEMINI_API_KEY, only the local embedding-based search tools are available.

MCP Tools

The server registers the following tools (all validated with Zod schemas):

📄 Document Management

ToolDescription
add_documentAdd a document (title, content, optional metadata)
list_documentsList all documents with metadata and content preview
get_documentRetrieve the full content of a document by ID
delete_documentRemove a document, its chunks, database entries, and associated files

📁 File Processing

ToolDescription
process_uploadsProcess all files in the uploads folder (chunking + embeddings)
get_uploads_pathReturns the absolute path to the uploads folder
list_uploads_filesLists files in the uploads folder with size and format info
get_ui_urlReturns the Web UI URL (e.g. http://localhost:3080) — useful to open the dashboard or to locate the uploads folder from the browser

🔍 Search

ToolDescription
search_documentsSemantic vector search within a specific document
search_all_documentsHybrid (full-text + vector) cross-document search
get_context_windowReturns a window of chunks around a given chunk index
search_documents_with_ai🤖 AI-powered search using Gemini (requires GEMINI_API_KEY)

Configuration

Configure via environment variables or a .env file in the project root:

VariableDefaultDescription
MCP_BASE_DIR~/.mcp-documentation-serverBase directory for data storage
MCP_EMBEDDING_MODELXenova/all-MiniLM-L6-v2Embedding model name
GEMINI_API_KEY—Google Gemini API key (enables search_documents_with_ai)
MCP_CACHE_ENABLEDtrueEnable/disable LRU embedding cache
START_WEB_UItrueSet to false to disable the built-in web interface
WEB_HOST127.0.0.1Bind address for the web UI (use 0.0.0.0 to expose on all interfaces)
WEB_PORT3080Port for the web UI
MCP_STREAMING_ENABLEDtrueEnable streaming reads for large files
MCP_STREAM_CHUNK_SIZE65536Streaming buffer size in bytes (64KB)
MCP_STREAM_FILE_SIZE_LIMIT10485760Threshold to switch to streaming (10MB)

Storage layout

~/.mcp-documentation-server/     # Or custom path via MCP_BASE_DIR├── data/│   ├── orama-chunks.msp         # Orama vector DB (child chunks + embeddings)│   ├── orama-docs.msp           # Orama document DB (full content + metadata)│   ├── orama-parents.msp        # Orama parent chunks DB (context sections)│   ├── migration-complete.flag   # Written after legacy JSON migration│   └── *.md                     # Markdown copies of documents└── uploads/                     # Drop .txt, .md, .pdf files here

Embedding Models

Set via MCP_EMBEDDING_MODEL:

ModelDimensionsNotes
Xenova/all-MiniLM-L6-v2384Default — fast, good quality
Xenova/paraphrase-multilingual-mpnet-base-v2768Recommended — best quality, multilingual

Models are downloaded on first use (~80–420 MB). The vector dimension is determined automatically from the provider.

⚠️ Important: Changing the embedding model requires re-adding all documents — embeddings from different models are incompatible. The Orama database is recreated automatically when the dimension changes.

Architecture

Server (FastMCP, stdio)  ├─ Web UI (Express, port 3080)  │    └─ REST API → DocumentManager  └─ MCP Tools       └─ DocumentManager            ├─ OramaStore          — Orama vector DB (chunks DB + docs DB + parents DB), persistence, migration            ├─ IntelligentChunker  — Parent-child chunking (code, markdown, text, PDF)            ├─ EmbeddingProvider   — Local embeddings via @xenova/transformers            │    └─ EmbeddingCache — LRU in-memory cache            └─ GeminiSearchService — Optional AI search via Google Gemini
  • OramaStore manages three Orama instances: one for document metadata/content, one for child chunks with vector embeddings, and one for parent chunks (context sections). All are persisted to binary files on disk and restored on startup.
  • IntelligentChunker implements the Parent-Child Chunking pattern: documents are first split into large parent chunks that preserve full context (sections, paragraphs), then each parent is further split into small child chunks for precise vector search. At query time, results are deduplicated by parent so that the LLM receives both the matched fragment and the broader context.
  • EmbeddingProvider lazily loads a Transformers.js model for local inference — no API calls needed.

Development

bash
git clone https://github.com/andrea9293/mcp-documentation-server.gitcd mcp-documentation-servernpm install
bash
npm run dev       # FastMCP dev mode with hot reloadnpm run build     # TypeScript compilationnpm run inspect   # FastMCP web UI for interactive tool testingnpm start         # Direct tsx execution (MCP server + web UI)npm run web       # Run only the web UI (development)npm run web:build # Run only the web UI (compiled)

Contributing

  1. Fork the repository
  2. Create a feature branch: git checkout -b feature/name
  3. Follow Conventional Commits for messages
  4. Open a pull request

License

MIT — see LICENSE

Support


Star History

[Star History Chart]

Built with FastMCP, Orama, and TypeScript

來源:README.md,提交 9a75899

工具

0
SourceWeft 尚未在沙箱中啟動過該軟體包,因此其工具未知。

版本歷史

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

評分

已滿足適用檢查項的 50%

該評分衡量此收錄條目的完整程度,依據註冊中心條目、端點與公開來源計算得出。它不是對伺服器本身的評價,也不表示伺服器安全或目前可用:可連通性是帶日期的檢查結果,評分也不包含安裝量或使用者評價。

  • 近 30 天內可連通25 分

    請保持端點能夠回應 MCP 握手;SourceWeft 每 30 天探測一次。

  • 已宣告認證方式10 分

    請在註冊中心條目中宣告憑證請求標頭,或保持端點能夠回應探測,以便判定其認證方式。

  • 已列出工具15 分

    請讓伺服器在無憑證時回應 tools/list,或發布可在沙箱中無憑證啟動的軟體包。

  • 描述必需15 分
  • 圖示10 分
  • 文件15 分
  • 授權條款10 分