andrea9293/mcp-documentation-server

MCP Documentation Server

A TypeScript-based Model Context Protocol (MCP) server that provides local-first document management and semantic search. Documents are stored in an embedded Orama vector database with hybrid search (full-text + vector), intelligent chunking, and local AI embeddings — no external database or cloud service required.

Core capabilities

🌐 Web UI

• Built-in Web Interface: A full-featured web dashboard starts automatically alongside the MCP server — no additional setup required
• Complete Tool Coverage: Every MCP tool is accessible from the browser: add/view/delete documents, semantic search, AI search, file uploads, and context window exploration
• Drag & Drop Uploads: Upload .txt, .md, and .pdf files directly from the browser
• Configurable: Disable with START_WEB_UI=false or change the port with WEB_PORT

🔍 Search & Intelligence

• Hybrid Search: Combined full-text and vector similarity powered by Orama, for both single-document and cross-document queries
• AI-Powered Search 🤖: Advanced document analysis with Google Gemini AI for contextual understanding and intelligent insights (optional, requires API key)
• Context Window Retrieval: Fetch surrounding chunks to provide LLMs with richer context

⚡ Performance & Architecture

• Orama Vector DB: Embedded search engine with zero native dependencies — replaces manual JSON storage and cosine similarity
• LRU Embedding Cache: Avoids recomputing embeddings for repeated content and queries
• Parent-Child Chunking: Documents are split into large context-preserving parent chunks and small precise child chunks for vector search — search results include both the matched fragment and the full surrounding context
• Streaming File Reader: Handles large files without high memory usage
• Automatic Migration: Legacy JSON documents are migrated to Orama on first startup — no manual intervention needed

📁 File Management

• Upload processing: Drop .txt, .md, or .pdf files into the uploads folder and process them with a single tool call
• Copy-based storage: Original files are backed up alongside the database
• Local-only storage: All data resides in ~/.mcp-documentation-server/

Quick Start

Configure an MCP client

Example configuration for an MCP client (e.g., Claude Desktop, VS Code):

Quick Start

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

Advanced with env vars (all vars are optional)

{
  "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_PORT": "3080",
      }
    }
  }
}

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

Web UI

The web interface starts automatically on port 3080 when the MCP server launches. Open your browser at:

http://localhost:3080

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

To run the web UI standalone (without the MCP server):

npm run web          # Development (tsx)
npm run web:build    # Production (compiled)

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.

MCP Tools

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

📄 Document Management

📁 File Processing

🔍 Search

Configuration

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

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:

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

git clone https://github.com/andrea9293/mcp-documentation-server.git
cd mcp-documentation-server
npm install

npm run dev       # FastMCP dev mode with hot reload
npm run build     # TypeScript compilation
npm run inspect   # FastMCP web UI for interactive tool testing
npm 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

Support

• 📖 Documentation
• 🐛 Report Issues
• 💬 MCP Community
• 🤖 Google AI Studio — get a Gemini API key

Star History

Built with FastMCP, Orama, and TypeScript