ツール概要
Linkly AI は MCP(Model Context Protocol)を通じて AI アシスタントに 3 つのツールを公開し、段階的なドキュメントアクセスワークフローを構成します:search
ドキュメントを検索し、関連する結果を取得
outline
ドキュメントのアウトラインを表示し、構造を把握
read
ドキュメントの内容を読み取り、詳細を取得
検索(search)
インデックス済みのローカルドキュメントを検索し、最も関連性の高い結果リストを返します。パラメータ
| パラメータ | 型 | 必須 | デフォルト値 | 説明 |
|---|---|---|---|---|
query | string | はい | — | 検索キーワードまたはフレーズ |
limit | number | いいえ | 20 | 最大返却結果数(1-50) |
doc_types | string[] | いいえ | 全部 | ドキュメントタイプでフィルター、例:["pdf", "md", "docx"] |
output_format | string | いいえ | markdown | json に設定すると構造化 JSON 出力を取得 |
返却フィールド
各検索結果には以下の情報が含まれます:| フィールド | 説明 |
|---|---|
doc_id | ドキュメントの一意識別子。後続の outline/read 呼び出しに使用 |
title | ドキュメントタイトル |
path | ファイルパス |
relevance | 関連度スコア(0-1) |
word_count | ドキュメントの語数 |
total_lines | ドキュメントの総行数 |
has_outline | 利用可能なアウトラインがあるか |
modified_at | 最終更新日時 |
keywords | 抽出されたキーワードリスト |
snippet | マッチした内容のスニペット |
使用例
アウトライン(outline)
1 つまたは複数のドキュメントの構造化されたアウトラインとメタデータを取得し、ドキュメント構造の迅速な把握と対象セクションの特定に役立ちます。パラメータ
| パラメータ | 型 | 必須 | デフォルト値 | 説明 |
|---|---|---|---|---|
doc_ids | string[] | はい | — | ドキュメント ID リスト(検索結果から取得) |
expand | string[] | いいえ | 自動 | 展開するノード ID(例:["2", "3.1"])、省略するとすべての階層を自動表示 |
output_format | string | いいえ | markdown | json に設定すると構造化 JSON 出力を取得 |
アウトラインを使うべきタイミング
| シナリオ | 推奨 |
|---|---|
| 長いドキュメント(> 200 行)でアウトラインあり | まずアウトラインを確認し、対象セクションを読み取る |
| 短いドキュメント(< 100 行) | アウトラインをスキップし、read で全文を直接読む |
has_outline: false のドキュメント | アウトラインをスキップし、read でページごとに閲覧 |
アウトライン機能はブックマーク付きの PDF、Markdown、DOCX
のドキュメントで最も効果的です。大量のドキュメントや書籍を読む際に非常に効率的です。
プレーンテキストやブックマークのない PDF
へのアウトラインサポートは、今後のイテレーションで提供予定です。
使用例
読み取り(read)
ドキュメントの内容を読み取ります。行番号での位置指定とページ分割をサポートし、長いドキュメントの特定部分の読み取りに適しています。Read ツールの動作は Claude AI SDK の動作と一致しているため、各種 Agentic AI モデルで最適な効果が得られます。パラメータ
| パラメータ | 型 | 必須 | デフォルト値 | 説明 |
|---|---|---|---|---|
doc_id | string | はい | — | ドキュメント ID(検索結果から取得) |
offset | number | いいえ | 1 | 開始行番号(1 から開始) |
limit | number | いいえ | 200 | 読み取り行数(最大 500) |
output_format | string | いいえ | markdown | json に設定すると構造化 JSON 出力を取得 |
コンテンツ形式
Read ツールは行番号付きの内容を返し、参照と位置特定が容易です:
ページ分割戦略
長いドキュメントの場合、分割して読み取ることをお勧めします:read でその範囲の内容を正確に読み取れます。
使用例
呼び出し例
完全なワークフロー:CLI 方式
以下の例は、CLI を使って完全なドキュメント検索を行う方法を示しています:完全なワークフロー:MCP 方式
AI アシスタントが MCP プロトコルでツールを呼び出す場合、リクエスト形式は以下の通りです:よくある質問
どのドキュメント形式に対応していますか?
どのドキュメント形式に対応していますか?
Linkly AI は現在、以下の形式に対応しています:
| 形式 | 拡張子 | アウトライン対応 |
|---|---|---|
| Markdown | .md, .mdx | ✅ |
| Word | .docx | ✅ |
.pdf | 部分対応 | |
| プレーンテキスト | .txt | ❌ |
| HTML | .html, .htm | 部分対応 |
アウトラインが利用できない場合はどうすればよいですか?
アウトラインが利用できない場合はどうすればよいですか?
ドキュメントに利用可能なアウトラインがない場合(
has_outline: false)、以下の方法があります:readツールを直接使用して、ドキュメントの内容をページごとに閲覧します- まずドキュメントの冒頭(デフォルト 200 行)を読み取り、大まかな内容を把握してから続きを読むか判断します
長いドキュメントはどのように処理すればよいですか?
長いドキュメントはどのように処理すればよいですか?
推奨フロー:
- まず
outlineでドキュメントの構造を把握します(アウトラインがある場合) - アウトライン内の行範囲に基づいて、
readのoffsetとlimitパラメータで対象セクションを正確に読み取ります - 1 回の読み取りは最大 500 行です。
offsetを調整してページごとに読み取ります
MCP サービスのデフォルトポートは何番ですか?
MCP サービスのデフォルトポートは何番ですか?
デフォルトポートは 60606 です。このポートが使用中の場合、アプリは自動的に他のポートを試行します。Linkly AI Desktop の設定で実際に使用されているポートを確認できます。
検索結果が不正確な場合はどうすればよいですか?
検索結果が不正確な場合はどうすればよいですか?
以下をお試しください:
- より正確なキーワードを使用する
- 自然言語での記述を使用する(ベクトルセマンティックマッチングを活用)
- キーワードと同義語を組み合わせる(例:
"認証 auth ログイン sign-in") --typeで特定のドキュメントタイプをフィルターし、検索範囲を絞り込む

