メインコンテンツへスキップ

ツール概要

Linkly AI は MCP(Model Context Protocol)を通じて AI アシスタントに 6 つのツールを公開し、段階的なドキュメントアクセスワークフローを構成します:
search → grep or outline → read
さらに 2 つのユーティリティツールが利用可能です:list_libraries(ナレッジライブラリの一覧表示)と explore(ドキュメントコレクションの概要表示)。

search

ドキュメントを検索し、関連する結果を取得

outline

ドキュメントのアウトラインを表示し、構造を把握

grep

正規表現で特定のテキストパターンを検索

read

ドキュメントの内容を読み取り、詳細情報を取得

list_libraries

ナレッジライブラリとそのドキュメント数を一覧表示

explore

ドキュメントコレクションのテーマと構造の概要を表示
これら 6 つのツールを組み合わせることで、AI アシスタントがローカルドキュメントからコンテキスト情報を効率的に取得できます。

検索(search)

インデックス済みのローカルドキュメントを検索し、最も関連性の高い結果リストを返します。

パラメータ

パラメータ必須デフォルト値説明
querystringはい検索キーワードまたはフレーズ
limitnumberいいえ20最大返却結果数(1-50)
doc_typesstring[]いいえ全部ドキュメントタイプでフィルター、例:["pdf", "md", "docx"]
librarystringいいえ特定のライブラリに検索を限定します。list_libraries で利用可能なライブラリを確認できます
path_globstringいいえSQLite GLOB 構文でファイルパスをフィルターします。* は任意の文字列(/ を含む)、? は単一文字にマッチします。常に大文字小文字を区別します
output_formatstringいいえmarkdownjson に設定すると構造化 JSON 出力を取得
ベクトルモデルのダウンロード中でも、検索は自動的にキーワードのみモードにフォールバックし、利用に影響はありません。

返却フィールド

各検索結果には以下の情報が含まれます:
フィールド説明
doc_idドキュメントの一意識別子。後続の outline/read 呼び出しに使用
titleドキュメントタイトル
pathファイルパス
relevance関連度スコア(0-1)
word_countドキュメントの語数
total_linesドキュメントの総行数
has_outline利用可能なアウトラインがあるか
modified_at最終更新日時
keywords抽出されたキーワードリスト
snippetマッチした内容のスニペット

使用例

# CLI 方式
linkly search "project management best practices" --limit 10

# ドキュメントタイプでフィルター
linkly search "quarterly report" --type pdf,docx --json

# 特定のライブラリ内で検索
linkly search "deep learning" --library my-research --limit 10

# ファイルパスでフィルター
linkly search "report" --path-glob "*2024*"

アウトライン(outline)

1 つまたは複数のドキュメントの構造化されたアウトラインとメタデータを取得し、ドキュメント構造の迅速な把握と対象セクションの特定に役立ちます。

パラメータ

パラメータ必須デフォルト値説明
doc_idsstring[]はいドキュメント ID リスト(検索結果から取得)
expandstring[]いいえ自動展開するノード ID(例:["2", "3.1"])、省略するとすべての階層を自動表示
output_formatstringいいえmarkdownjson に設定すると構造化 JSON 出力を取得

アウトラインを使うべきタイミング

シナリオ推奨
50 行超のドキュメントでアウトラインありまずアウトラインを確認し、対象セクションを読み取る
短いドキュメント(50 行未満)アウトラインをスキップし、read で全文を直接読む
has_outline: false のドキュメントgrep でパターンを検索するか、read でページごとに閲覧
アウトライン機能はブックマーク付きの PDFMarkdownDOCX のドキュメントで最も効果的です。長いドキュメントや書籍を読む際に特に有効です。 プレーンテキストやブックマークのない PDF へのアウトラインサポートは、今後のイテレーションで追加予定です。

使用例

# 単一のドキュメントのアウトラインを表示
linkly outline abc123

# 複数のドキュメントを一括表示
linkly outline id1 id2 id3

# JSON 形式で出力
linkly outline abc123 --json

Grep

単一のドキュメント内で正規表現パターンにより特定の行を検索します。アウトラインが利用できない has_outline=false のドキュメントに最適です。search の後に使用して、名前、日付、用語、識別子、その他のパターンの正確な位置を特定し、read で offset を指定して前後の文脈を確認します。すべてのドキュメントタイプ(PDF、Markdown、DOCX、TXT、HTML)で動作します。複数のドキュメントを検索する場合は、ドキュメントごとに grep を 1 回呼び出してください。

パラメータ

パラメータ必須デフォルト値説明
patternstringはい検索する正規表現パターン
doc_idstringはい検索対象のドキュメント ID(検索結果から取得)
contextnumberいいえ3各マッチの前後に表示するコンテキスト行数
beforenumberいいえ各マッチの前に表示するコンテキスト行数(context を上書き)
afternumberいいえ各マッチの後に表示するコンテキスト行数(context を上書き)
case_insensitivebooleanいいえfalse大文字小文字を区別しないマッチング
output_modestringいいえcontentcontent(コンテキスト付きマッチ行)または count(マッチ数のみ、先に合計を確認する場合)
limitnumberいいえ20返却するマッチ行の最大数(最大 100)
offsetnumberいいえ0ページネーション用にスキップするマッチ数
output_formatstringいいえmarkdownjson に設定すると構造化 JSON 出力を取得

Grep とアウトラインの使い分け

シナリオ推奨
特定の用語、名前、日付を検索したいパターンを指定して grep を使用
ドキュメント全体の構造を把握したいoutline を使用
アウトラインがないドキュメント(has_outline: falsegrep でコンテンツを検索
パターンの検索(メール、ID、数値など)正規表現で grep を使用

使用例

# ドキュメント内で特定の用語を検索
linkly grep "quarterly revenue" 456

# 大文字小文字を区別しない検索(コンテキスト付き)
linkly grep "error|warning" 1044 -C 3 -i

# 読み取り前にマッチ数を確認
linkly grep "TODO" 591 --mode count

読み取り(read)

ドキュメントの内容を行番号での位置指定とページネーションで読み取ります。長いドキュメントの特定部分の読み取りに適しています。Read ツールは Claude AI SDK と一貫した動作をするため、各種 Agentic AI モデルで最適な結果が得られます。

パラメータ

パラメータ必須デフォルト値説明
doc_idstringはいドキュメント ID(検索結果から取得)
offsetnumberいいえ1開始行番号(1 から開始)
limitnumberいいえ200読み取り行数(最大 500)
output_formatstringいいえmarkdownjson に設定すると構造化 JSON 出力を取得

コンテンツ形式

Read ツールは行番号付きの内容を返し、参照と位置特定が容易です:
  1	# Project Requirements Document
  2
  3	## 1. Project Background
  4
  5	This project aims to build an efficient knowledge management system...
  6	Target users are enterprise R&D teams and individual knowledge workers.

ページネーション戦略

長いドキュメントの場合、分割して読み取ることをお勧めします:
# 第 1 ページ:第 1-200 行
linkly read <DOC_ID> --offset 1 --limit 200

# 第 2 ページ:第 201-400 行
linkly read <DOC_ID> --offset 201 --limit 200

# 第 3 ページ:第 401-600 行
linkly read <DOC_ID> --offset 401 --limit 200
アウトラインとの併用がより効果的です。アウトラインで対象セクションの行範囲を特定し、read でその範囲の内容を正確に読み取れます。

使用例

# ドキュメントの冒頭を読み取り
linkly read abc123

# 特定の範囲を読み取り
linkly read abc123 --offset 120 --limit 80

# JSON 形式(プログラム処理に適しています)
linkly read abc123 --json

ライブラリ一覧(list_libraries)

ユーザーが設定したすべてのナレッジライブラリを、説明とドキュメント数とともに一覧表示します。

パラメータ

パラメータは不要です。

ユースケース

  • ユーザーが「どんなライブラリがありますか?」と質問した場合
  • searchlibrary パラメータを使用する前に、ライブラリ名を確認する場合
linkly list-libraries

探索(explore)

インデックス済みの全ドキュメントまたは特定のライブラリの鳥瞰的な概要を取得します。ドキュメントタイプの分布、ディレクトリ構造(ファイル数と語数の中央値付き)、上位キーワード(出典の帰属付き)を返します。

パラメータ

パラメータ必須デフォルト値説明
librarystringいいえ特定のライブラリに限定します。省略するとすべてのドキュメントを探索します

ユースケース

  • ユーザーがナレッジベースやドキュメントコレクションの内容を知りたい場合
  • ユーザーに特定の検索トピックがなく、利用可能なテーマや方向性を発見したい場合
  • AI アシスタントが効果的な検索戦略を策定するために、規模とトピック分布を把握する必要がある場合
探索後は、出力のキーワードやディレクトリ名を手がかりとして、後続の search クエリに活用します。
# すべてのドキュメントを探索
linkly explore

# 特定のライブラリを探索
linkly explore --library my-research

ワークフロー例

完全なワークフロー:CLI 方式

以下の例は、CLI を使って完全なドキュメント検索を行う方法を示しています:
# ステップ 1:関連ドキュメントを検索
linkly search "microservice architecture design" --limit 5

# ステップ 2:対象ドキュメントのアウトラインを表示(doc_id が abc123 の場合)
linkly outline abc123

# ステップ 3:関心のあるセクションを読み取り(対象が第 80-150 行の場合)
linkly read abc123 --offset 80 --limit 70

完全なワークフロー:MCP 方式

AI アシスタントが MCP プロトコルでツールを呼び出す場合、リクエスト形式は以下の通りです:
// ステップ 1:検索
{
  "method": "tools/call",
  "params": {
    "name": "search",
    "arguments": {
      "query": "microservice architecture design",
      "limit": 5
    }
  }
}

// ステップ 2:アウトラインを表示
{
  "method": "tools/call",
  "params": {
    "name": "outline",
    "arguments": {
      "doc_ids": ["abc123"]
    }
  }
}

// ステップ 3:内容を読み取り
{
  "method": "tools/call",
  "params": {
    "name": "read",
    "arguments": {
      "doc_id": "abc123",
      "offset": 80,
      "limit": 70
    }
  }
}

よくある質問

Linkly AI は現在、以下の形式に対応しています:
形式拡張子アウトライン対応
Markdown.md, .mdxYes
Word.docxYes
PDF.pdfPartial
プレーンテキスト.txtNo
HTML.html, .htmPartial
画像(OCR).png, .jpg, .jpeg, .bmp, .webpNo
ドキュメントに利用可能なアウトラインがない場合(has_outline: false)、以下の方法があります:
  1. read ツールを直接使用して、ドキュメントの内容をページごとに閲覧します
  2. まずドキュメントの冒頭(デフォルト 200 行)を読み取り、大まかな内容を把握してから続きを読むか判断します
推奨フロー:
  1. まず outline でドキュメントの構造を把握します(アウトラインがある場合)
  2. アウトライン内の行範囲に基づいて、readoffsetlimit パラメータで対象セクションを正確に読み取ります
  3. 1 回の読み取りは最大 500 行です。offset を調整してページごとに読み取ります
デフォルトポートは 60606 です。このポートが使用中の場合、アプリは自動的に他のポートを試行します。Linkly AI Desktop の設定で実際に使用されているポートを確認できます。
以下をお試しください:
  • より正確なキーワードを使用する
  • 自然言語での記述を使用する(ベクトルセマンティックマッチングを活用)
  • キーワードと同義語を組み合わせる(例:"authentication auth login sign-in"
  • --type で特定のドキュメントタイプをフィルターし、検索範囲を絞り込む