@fox-hound-tools/documind

v3.0.6

Published

4 months ago

Markdownドキュメントをインテリジェントな知識ベースに変換するツールです。Documindは文書をインデックス化し、MCPサーバーを通じてAI搭載の検索機能を提供します。

Downloads

0High
0Medium
0Low

naoyayamamoto

Documind

Documindとは？

Documindはお持ちのMarkdownファイルのコレクションを、AIアシスタントが自然言語で問い合わせできる検索可能な知識ベースに変換します。技術文書、会議録、個人の知識管理ファイルなど、どのような文書でもDocumindが自然言語クエリを通じてアクセス可能にします。

主な利点

スマート検索: キーワードではなく自然言語を使って関連情報を見つけられます
更新が簡単: コマンド一つでドキュメントの変更を簡単に同期できます
あらゆるMCPクライアントで動作: Claude Desktop、Cline、その他MCP対応AIツールと互換性があります
複数のAIプロバイダ対応: OpenAI、Google、Ollama、Localをサポート
ゼロコンフィグで動作: 設定なしですぐに使用開始できます
ローカル＆プライベート: データはあなたのマシンに保持されます

MCPサーバーとしての登録

DocumindはMCP（Model Context Protocol）サーバーとして動作し、Claude DesktopやClineなどのAIツールと統合できます。

Claude Desktopでの登録

Claude Desktopの設定にDocumindを追加する方法：

Claude Desktopの設定を開く
Developer > Model Context Protocolに移動
以下の設定を追加：

{
  "mcpServers": {
    "documind": {
      "command": "npx",
      "args": ["documind", "mcp"]
    }
  }
}

その他のMCPクライアント

# Clineでの登録例
cline mcp add documind -- npx documind mcp

# Claude Codeでの登録例
claude mcp add documind -- npx documind mcp

インストールと基本的な使用方法

前提条件

Node.js 20.9.0 以上
npm、yarn、pnpmなど

グローバルインストール

# Documindをグローバルにインストール
npm install -g @fox-hound-tools/documin

基本的な使用手順

1. ドキュメントのインデックス化

documind index

デフォルトで以下のパターンのファイルがインデックス化されます：

~/.documind/**/*.md (ホームディレクトリのDocumindフォルダ)
./docs/**/*.md (現在のディレクトリのdocsフォルダ)
./README.md (現在のディレクトリのREADME)

2. MCPサーバーの起動

documind start
# または
documind mcp

これで知識ベースがAIツールから利用可能になります。

ゼロコンフィグ動作

Documindは設定ファイルなしでも動作します：

デフォルトプロバイダ: Localプロバイダ（オフライン動作）
デフォルトパス: 一般的なドキュメントディレクトリを自動検索
自動フォールバック: 利用可能なプロバイダを自動検出・切り替え

設定

Documindは3つの方法で設定できます（優先順位順）：

環境変数 - システム環境変数（最優先）
CLIオプション - コマンド実行時の引数
設定ファイル - documind.config.json（最低優先）

設定ファイル (documind.config.json)

プロジェクトルートにdocumind.config.jsonを作成：

{
  "targets": ["./docs/**/*.md", "./README.md", "./guides/**/*.md"],
  "ignore": ["**/node_modules/**", "**/dist/**", "**/.git/**"],
  "ai": {
    "provider": "local",
    "dimensions": 1024,
    "batchSize": 50,
    "enableFallback": true,
    "fallbackProviders": ["ollama", "openai", "google"],
    "timeout": 30000,
    "providers": {
      "local": {
        "embeddingModel": "Xenova/multilingual-e5-large",
        "model": "Xenova/LaMini-Flan-T5-783M"
      },
      "openai": {
        "model": "gpt-4",
        "embeddingModel": "text-embedding-3-small"
      },
      "ollama": {
        "baseUrl": "http://localhost:11434",
        "model": "qwen3:4b",
        "embeddingModel": "mxbai-embed-large"
      }
    }
  },
  "database": "./.documind/store.duckdb",
  "logLevel": "info"
}

環境変数

環境変数で設定を上書きできます：

# 一般設定
export DOCUMIND_LOG_LEVEL="debug"              # debug, info, warn, error
export DOCUMIND_WATCH="true"                   # 自動再インデックス
export DOCUMIND_DEBUG="true"                   # デバッグモード有効化

# データベース設定
export DOCUMIND_DATABASE="./.documind/store.duckdb"    # データベースファイルパス

# AI一般設定
export DOCUMIND_AI_PROVIDER="local"            # local, openai, google, ollama
export DOCUMIND_AI_DIMENSIONS="1024"           # 埋め込みベクトル次元数
export DOCUMIND_AI_BATCH_SIZE="50"             # バッチサイズ
export DOCUMIND_AI_ENABLE_FALLBACK="true"      # フォールバック有効化
export DOCUMIND_AI_TIMEOUT="30000"             # タイムアウト（ミリ秒）

# 検索設定
export DOCUMIND_SEARCH_LIMIT="5"               # デフォルト検索結果数
export DOCUMIND_SEARCH_THRESHOLD="0.1"         # 類似度閾値
export DOCUMIND_SEARCH_FORMAT="detailed"       # detailed, table, json

# OpenAIプロバイダ設定
export OPENAI_API_KEY="your-key"
export OPENAI_EMBEDDING_MODEL="text-embedding-3-small"
export OPENAI_TIMEOUT="30000"

# Googleプロバイダ設定
export GOOGLE_API_KEY="your-key"
export GOOGLE_EMBEDDING_MODEL="text-embedding-004"
export GOOGLE_TIMEOUT="30000"

# Ollamaプロバイダ設定
export OLLAMA_BASE_URL="http://localhost:11434"
export OLLAMA_EMBEDDING_MODEL="mxbai-embed-large"
export OLLAMA_TIMEOUT="60000"

# Localプロバイダ設定
export LOCAL_EMBEDDING_MODEL="Xenova/multilingual-e5-large"
export LOCAL_MAX_LENGTH="512"
export LOCAL_POOLING="mean"
export LOCAL_NORMALIZE="true"
export LOCAL_TIMEOUT="60000"

対応AIプロバイダ

| プロバイダ | 埋め込みモデル | APIキー要否 | 備考 | | ---------- | ------------------- | ----------- | -------------------------- | | Local | multilingual-e5 | ❌ | オフライン動作、デフォルト | | OpenAI | text-embedding-3-* | ✅ | | | Google | text-embedding-004 | ✅ | | | Ollama | mxbai-embed-large | ❌ | ローカルサーバー必要 |

AIプロバイダの設定例

Option 1: Local (推奨・ゼロコンフィグ)

設定不要。オフラインで動作します。

Option 2: Ollama (ローカル)

# Ollamaのインストールと起動
ollama serve

# 必要なモデルのダウンロード
ollama pull mxbai-embed-large

# 環境変数設定
export DOCUMIND_AI_PROVIDER="ollama"

Option 3: OpenAI

export OPENAI_API_KEY="your-api-key"
export DOCUMIND_AI_PROVIDER="openai"

Option 4: Google AI

export GOOGLE_API_KEY="your-api-key"
export DOCUMIND_AI_PROVIDER="google"

使用例

個人的な知識管理

「先月プロジェクトアーキテクチャについて書いたことを教えて」
「Dockerのベストプラクティスに関するメモを見つけて」
「Q3の会議録を要約して」

技術文書

「認証モジュールの設定方法は？」
「ユーザー管理のAPIエンドポイントは何？」
「コードベースでのエラーハンドリングの例を見せて」

研究・学習

「機械学習について学んだことを教えて」
「分散システムへの全ての参照を見つけて」
「React hooksのメモの要約を作成して」

トラブルシューティング

「ドキュメントが見つかりません」

documind.config.jsonのパスを確認してください
そのパスに.mdファイルが存在することを確認してください
documind indexを実行してインデックスを再構築してください

「APIキーが無効です」

使用するAIプロバイダの環境変数が正しく設定されているか確認してください
APIキーの有効期限と権限を確認してください
.envファイルまたはシステム環境変数で設定されているか確認してください

「Ollamaに接続できません」

Ollamaを起動してください: ollama serve
モデルがインストールされているか確認してください: ollama list
OLLAMA_BASE_URL環境変数が正しく設定されているか確認してください

「検索結果が関係ない」

より具体的なクエリを試してください
ドキュメントを再インデックス化してください
より強力な埋め込みモデルの使用を検討してください

開発・貢献

プロジェクトの改善にご協力いただける場合：

このリポジトリをフォーク
feature branchを作成
変更をcommit
Pull Requestを作成

ライセンス

MIT