MCP・API 仕様 (MCP & API Specification)
1. トランスポート
- 方式: Model Context Protocol に準拠。SSE (Server-Sent Events) で接続維持・イベント配信。
- ポート: 3001（固定）
- エンドポイント:
GET /sse — 接続確立・通知受信POST /messages?session_id={uuid} — JSON-RPC リクエスト送信
2. 提供ツール一覧
| ツール名 |
役割 |
search_text |
意味・全文ハイブリッド検索。結果は文書単位で結合可能。 |
add_item_text |
テキストをチャンクとして登録。ベクトル化はエディションに応じて LSA または埋め込み。 |
update_item |
指定 ID のチャンクを更新。ベクトル再計算。 |
delete_item |
指定 ID のチャンクを削除。 |
get_item_by_id |
指定 ID のメタデータ・本文を取得。 |
get_document_count |
文書（documents）の総件数。 |
lsa_retrain |
RE-INDEX。FTS/ベクトルを再構築（Community: LSA 再学習、Pro: vec_items 再投入・HNSW 再構築）。 |
3. search_text パラメータ
| パラメータ |
型 |
必須 |
既定値 |
説明 |
content |
string |
○ |
— |
検索クエリ。短い語句・自然文どちらも可。 |
limit |
integer |
— |
10 |
返却最大件数（1〜100）。 |
min_score |
number |
— |
0.3 |
類似度の足切り（0〜1）。 |
group_by_document |
boolean |
— |
true |
true のとき文書単位で結合して返す。 |
- 結果の
similarity は 0〜1。ベクトルと FTS のスコアの大きい方を採用。
4. HTTP API（補助）
| メソッド |
パス |
説明 |
| GET |
/edition |
起動中エディション（community / pro）。 |
| GET |
/version |
アプリバージョン（例: {"version":"0.3.2"}）。 |
| GET |
/heal |
FTS 同期実行。{"synced": n}。 |
| GET |
/model_name |
Pro 時は埋め込みモデル名等。 |
5. レスポンス形式
ツール呼び出しは JSON-RPC 2.0。結果は MCP の content 配列（type: "text", text に JSON 文字列）で返します。
エラー時は -32000 等。LSA/埋め込みの初期化失敗時はログでエンジン状態を確認してください。
