diff --git a/document/04_mcp_api_specification.md b/document/04_mcp_api_specification.md index 3388b18..f9b1ff2 100644 --- a/document/04_mcp_api_specification.md +++ b/document/04_mcp_api_specification.md @@ -16,6 +16,15 @@ > [!NOTE] > 現在、`search_text` のみが実装・公開されています。その他のツールは順次実装予定です。 +### 2.1 `add_item_text` (登録) + +文章を自動ベクトル化して登録します。 + +- **引数**: + - `content` (string): 本文 (必須) + - `path` (string): メタデータ (任意) +- **戻り値**: 成功メッセージと ID + ### 2.2 `search_text` (意味検索) 自然言語による検索を実行します。 @@ -25,6 +34,24 @@ - `limit` (number): 取得件数 (デフォルト: 10) - **戻り値**: 類似度順の結果リスト(テキスト形式) +### 2.3 `update_item` (更新) + +既存のアイテムとベクトルを最新の内容で書き換えます。 + +- **引数**: + - `id` (integer): 更新対象の文章番号(ID) (必須) + - `content` (string): 新しい本文 (必須) + - `path` (string): 新しいメタデータ (任意) +- **戻り値**: 更新完了通知 + +### 2.4 `delete_item` (削除) + +指定された文章番号(ID)のデータを削除します。 + +- **引数**: + - `id` (integer): 削除対象の文章番号(ID) (必須) +- **戻り値**: 削除完了通知 + ## 3. レスポンスフロー (SSE) MCP SSE 規格に基づき、リクエストとレスポンスは以下のフローで行われます。