diff --git "a/docs/manual/TelosDB\343\203\236\343\203\213\343\203\245\343\202\242\343\203\253.md" "b/docs/manual/TelosDB\343\203\236\343\203\213\343\203\245\343\202\242\343\203\253.md" new file mode 100644 index 0000000..d158524 --- /dev/null +++ "b/docs/manual/TelosDB\343\203\236\343\203\213\343\203\245\343\202\242\343\203\253.md" @@ -0,0 +1,56 @@ +# TelosDB マニュアル + +## 概要 + +**TelosDB** はローカル専用の意味検索(セマンティック検索)基盤です。文書・ベクトルはすべて端末内に保存され、クラウドへは送信しません。 + +- **Community 版**: LSA によるベクトル化。追加モデル不要。 +- **Pro 版**: 日本語埋め込みモデルで高精度検索。要 embedding モデル配置。 + +## 起動と UI + +- インストール後、システムトレイにアイコンが表示されます。 +- アイコンクリックでメインウィンドウを表示/非表示。 +- メニューから「表示」「終了」を選択できます。 +- ログイン時自動起動は設定パネルで ON/OFF 可能です。 + +## 主な機能 + +- **検索**: ウィンドウの検索欄にキーワードや自然文を入力すると、登録文書から意味的に関連するものを検索します。 +- **文書管理**: 登録済み文書の一覧表示・編集・削除ができます。 +- **設定**: スコア足切り・取得件数・監視フォルダ・標準フォルダ(コアルール・コアスキル・コアツール・コアナレッジ)などを設定できます。 + +## 監視フォルダと標準フォルダ + +- **監視フォルダ**: 指定したフォルダ内のファイル(.md, .txt 等)を自動でインデックスに取り込みます。設定でパスとカテゴリを追加できます。 +- **標準フォルダを有効にする**と、次の 4 フォルダがデータフォルダ直下に作成され、監視対象になります。 + - **コアルール**: エージェント用ルール + - **コアスキル**: スキル定義(SKILL.md 等) + - **コアツール**: ツール・スクリプト + - **コアナレッジ**: 調べもの・参照用ナレッジ(本マニュアルもここに格納されています) + +## MCP 連携 + +- **接続方式**: クライアントの種別により以下のいずれかを使用します。 +- **標準接続 (HTTP/SSE)**: + - 対象: Cursor, Claude Desktop 等 + - URL: `http://127.0.0.1:3001/sse`(TelosDB 起動中のみ有効) +- **ブリッジ接続 (stdio)**: + - 対象: Antigravity, VS Code MCP 拡張等 + - 理由: 一部の IDE 環境では直接の SSE 接続が不安定な場合や、セキュリティ制限があるため、`mcp-remote` 等のブリッジツールを介して標準入出力 (stdio) で通信します。 + - Windows 特有の注意: `npm` や `npx` 経由で実行する際、ノイズ(警告文等)が混入して接続エラー (`Initialize EOF`) が発生することがあります。その場合は、ノイズを除去する専用のラッパー(Node.js スクリプト等)を介して起動することを強く推奨します。 + +### 主なツール + +`search_text`(検索)、`list_documents`(一覧)、`get_document`(取得)、`write_file` / `delete_file` / `rename_file`(監視フォルダ配下のファイル操作)、`settings_get` / `settings_update`(設定)。 + +## データの場所 + +- 設定・DB・監視フォルダの実体は、アプリのデータフォルダ(例: Windows では `%APPDATA%\com.telosdb.app\`)に保存されます。 +- 設定パネルから「データフォルダを開く」で開けます。 + +## トラブルシューティング + +- **検索結果が出ない**: 監視フォルダを設定し、対象拡張子のファイルが存在するか確認してください。保存後しばらく待つと取り込みが完了します。 +- **MCP がつながらない**: TelosDB が起動しているか、ポート 3001 が他アプリに占有されていないか確認してください。 +- **RE-INDEX**: 文書を追加・変更したあと検索に反映されない場合は、設定や UI から RE-INDEX(再インデックス)を実行してください。