Newer
Older
TelosDB / document / 04_mcp_api_specification.md

MCP・APIインターフェース仕様書 (MCP & API Specification)

1. プロトコル定義

本システムは Model Context Protocol (MCP) に準拠し、外部エージェントに対してデータベース操作インターフェースを公開します。

  • プロトコルバージョン: 2024-11-05 (最新安定版)
  • トランスポート: SSE (Server-Sent Events)
  • エンドポイント:
    • Connection: GET /sse
    • Message: POST /messages

2. 提供ツール定義 (Tools)

2.1 add_item_text (登録)

文章を自動ベクトル化して登録します。

  • 引数:
    • content (string): 本文 (必須)
    • path (string): メタデータ (任意)
  • 戻り値: 成功メッセージと ID

2.2 search_text (意味検索)

自然言語による検索を実行します。

  • 引数:
    • content (string): 検索クエリ (必須)
    • limit (number): 取得件数 (デフォルト: 10)
  • 戻り値: 類似度順の結果リスト(id, content, distance 等)

2.3 update_item (更新)

既存のアイテムとベクトルを最新の内容で書き換えます。

  • 引数:
    • id (number): 対象 ID (必須)
    • content (string): 新しい本文 (必須)
    • path (string): 新しいメタデータ (任意)
  • 戻り値: 更新完了通知

2.4 delete_item (削除)

指定 ID のデータを物理削除します。

  • 引数:
    • id (number): 対象 ID (必須)
  • 戻り値: 削除完了通知

2.5 llm_generate (生成)

内蔵 LLM を使用したテキスト生成。

  • 引数:
    • prompt (string): プロンプト (必須)
    • n_predict (number): 最大トークン数 (任意)
  • 戻り値: 生成文章

3. レスポンスフォーマット

すべてのレスポンスは以下の形式に準拠します。

{
  "jsonrpc": "2.0",
  "result": {
    "content": [
      {
        "type": "text",
        "text": "..."
      }
    ]
  },
  "id": "..."
}

4. エラー定義

コード 分類 原因例
-32700 Parse error 不正な JSON フォーマット
-32601 Method not found 未定義ツールの呼び出し
-32000 Internal error Sidecar 不通, DB 権限エラー等