Newer
Older
TelosDB / src / backend / src / mcp / usage.md

TelosDB MCP の使い方

TelosDB はローカルで動作するドキュメント検索・インデックスサーバーです。MCP(Model Context Protocol)経由で検索・設定・ファイル書き込みができます。

前提

  • TelosDB アプリを起動し、MCP サーバー(既定では http://127.0.0.1:3001/sse)が有効であること。
  • クライアント(エディタや AI アシスタント)が上記 URL に MCP で接続していること。

配列型の扱い(クライアント向け)

  • settings_getmonitor_paths および watch_extensions は、未設定・空のとき 空配列 [] で返します。クライアントは null ではなく配列として受け取り、長さ 0 のときは空として扱ってください。
  • settings_update では monitor_pathswatch_extensions空配列 [] を渡すことで、監視パスや拡張子を空にできます。ツールの inputSchema では配列要素の型(items)を定義しているため、厳格なバリデーションを行うクライアントでも受理されます。

主なツール

検索

  • search_text
    クエリでドキュメントを検索します。
    引数: content(必須), limit, min_score, category(任意)

ドキュメント一覧・取得

  • list_documents
    登録ドキュメントをページングで一覧します。
    引数: limit, page
  • get_document
    ドキュメント ID で本文を取得します。
  • get_document_count
    登録ドキュメント数を取得します。
  • list_categories
    カテゴリ名の一覧を取得します(search_text の category フィルタに利用)。

設定(プロジェクトごとのルール・ツール監視)

  • settings_get
    現在の設定を取得します。
    返却: monitor_paths, watch_extensions, min_score, limit, run_on_login, standard_folders_enabled, standard_folder_categories(標準フォルダの名前・説明の定義。有効/無効に関係なく常に含まれる)。
  • settings_update
    設定を更新します。
    キー: monitor_paths{ path, category?, description? } の配列), watch_extensions, min_score, limit, run_on_login, standard_folders_enabled(標準フォルダの有効/無効)。
    部分更新可能。標準フォルダを有効にすると、監視パスに「汎用ルール」「汎用スキル」「汎用ツール」「汎用ナレッジ」が自動で追加されます。

ファイル操作(監視フォルダ配下)

  • write_file
    監視フォルダ配下にファイルを書き込みます。
    引数: path(絶対パス), content
    path は設定済みのいずれかの monitor_paths の下である必要があります。
  • delete_file
    監視フォルダ配下のファイルをディスクから削除し、インデックスからも削除します。
    引数: path(絶対パス。ファイルのみ。ディレクトリは指定不可)。
  • rename_file
    監視フォルダ配下のファイルをリネーム(移動)します。
    引数: old_path, new_path(いずれも絶対パスで、監視フォルダ配下であること)。
    移動後に新しいパスで再インデックスされます。

その他

  • add_item_text
    パスと本文を指定してドキュメントを追加・上書きします。
  • get_item_by_id, update_item, delete_item
    チャンク単位の取得・更新・削除。
  • delete_document
    ドキュメントとそのチャンクを削除します。
  • lsa_retrain
    LSA モデルの再学習を手動実行します。

標準フォルダ(standard_folder_categories)

設定で「標準フォルダを有効にする」を ON にすると、次の 4 フォルダが監視対象に追加されます(パスはデータフォルダ直下)。

名前 説明
汎用ルール プロジェクト共通のルール・規約を格納します。
汎用スキル 再利用可能なスキル定義を格納します。
汎用ツール ツールやスクリプトを格納します。ソースコードを含む場合は watch_extensions の設定を確認してください。
汎用ナレッジ 調べものや参照用のナレッジを格納します。

standard_folders_enabled が false でも、settings_getstandard_folder_categories で上記の名前・説明は常に取得できます。MCP クライアントはここで「どのような標準フォルダがあるか」を把握できます。

このドキュメントの取得方法

MCP の resources/listtelos://docs/usage を一覧し、resources/read でこの URI を指定すると、この使い方ドキュメント(Markdown)を取得できます。