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?session_id={uuid}
      • GET /sse 接続時にサーバーから送られる endpoint イベント内のパスを使用すること。

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

[!NOTE] 現在、search_text のみが実装・公開されています。その他のツールは順次実装予定です。

2.2 search_text (意味検索)

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

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

3. レスポンスフロー (SSE)

MCP SSE 規格に基づき、リクエストとレスポンスは以下のフローで行われます。

  1. 接続: クライアントが GET /sse を開始。
  2. 通知: サーバーが event: endpoint でメッセージ送信先パスを返却。
  3. 送信: クライアントが POST /messages?session_id=... で命令を送信。
  4. 応答: サーバーが SSE ストリーム上で event: message として結果を返却。HTTP 自体は 202 Accepted を返却する。

4. エラー定義

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