本文へ移動
hs-sql-agent
2.0.2
ドキュメント 2.0.2
ドキュメント はじめに

クイックスタート

セットアップ方法を選び、hs-sql-agent を起動して、最初の MCP クライアントを接続します。

Docker Compose

  1. 環境設定ファイルを作成

    管理しやすいよう、リポジトリに含まれるサンプルをコピーして明示的に設定します。

    cp .env.example .env
  2. 署名用シークレットを変更

    HMAC_KEY と JWT_KEY には、それぞれ異なる 32 バイト以上の値を設定します。

    .env.example の値はサンプルです。そのまま本番環境へ配置しないでください。

  3. サービスを起動

    標準の単一インスタンス構成を起動します。

    docker compose up -d
  4. 管理画面を開く

    標準ではポート 8080 で待ち受けます。

    ローカル環境では http://localhost:8080 を開き、最初の管理者設定を完了します。

最初の MCP キーを発行

  1. Runtime → MCP Keys を開く

    MCP キーはクライアントの識別と認可の境界になります。

  2. データベースとツールの権限範囲を選ぶ

    キーを 1 つの Database Management 設定へ結び付け、クライアントが必要とするツールだけを公開します。

  3. 平文のキーをコピー

    発行直後のダイアログに表示されるシークレットをコピーし、クライアント側の安全な保管場所へ保存します。

  4. 生成されたクライアント設定を使う

    または Streamable HTTP エンドポイントへの要求に X-MCP-Server-Key ヘッダーを付けます。

標準の MCP エンドポイントは /mcp です。別の端末から接続する場合は、MCP_PUBLIC_ENDPOINT に外部から到達できる HTTP または HTTPS の絶対 URL を /mcp まで含めて設定してください。

次に読むドキュメント