Stackql

プロジェクトについて

StackQL は、Golang で構築されたオープンソースプロジェクトです。SQL のセマンティクスを使用して、さまざまなローカルおよびリモートインターフェースを介し、サービスやリソースの状態を作成、変更、クエリできます。このようなインターフェースには通常、クラウドや SaaS プロバイダー（Google、AWS、Azure、Okta、GitHub など）が含まれますが、これらに限定されません。

仕組み

StackQL はスタンドアロンアプリケーションです。クライアントモード（exec または shell 経由）で使用するか、Postgres ワイヤープロトコルクライアント（psycopg2 など）を使用してサーバーモード（srv）でアクセスできます。

StackQL は SQL ステートメントを解析し、（クラウド）リソースプロバイダーへの API リクエストに変換します。API 呼び出しが実行され、その結果がユーザーに返されます。

StackQL プロバイダーインターフェースは通常、プロバイダー仕様の OpenAPI 拡張として定義されています。これらの定義を使用して、SQL スキーマと API クライアントを生成します。プロバイダー定義のソースはStackQL Registryに保存されています。プロバイダーとのやり取りのセマンティクスは、私たちの any-sdk ライブラリで定義されています。内部の詳細については、ローカルの AGENTS.md ファイルとany-sdk の AGENTS.mdを参照してください。

flowchart LR
  subgraph StackQL
    direction BT
    subgraph ProviderDefs
        Registry[Provider Registry Docs]    
    end
    subgraph App
        Proc[$ stackql exec\n$ stackql shell\n$ stackql srv]
        style Proc fill:#000,stroke:#000,color:#fff,text-align:left;

        %% ,font-family:'Courier New', Courier, monospace
    end
  end
  User((User)) <--> StackQL <--> Provider[Cloud Provider API]
  ProviderDefs --> App

MCP サーバー

StackQL はMCPサーバーです。40 以上のクラウドおよび SaaS プロバイダーに対して、AI エージェントが SQL を使用できます。MCP 対応クライアント（Claude、VS Code、Cursor など）を StackQL に接続すると、SQL を使用してクラウドリソースをクエリおよびプロビジョニングできます。

stdio 経由で実行します。

stackql mcp --mcp.server.type=stdio

StackQL MCP は公式 MCP レジストリに io.github.stackql/stackql-mcp として公開されており、npm、PyPI、Docker、GitHub Action、.mcpb バンドルを通じて配布されています。インストール方法を選び、対応するブロックを MCP クライアントの設定に追加してください。

{
  "mcpServers": {
    "stackql": {
      "command": "npx",
      "args": ["-y", "@stackql/mcp-server"]
    }
  }
}

{
  "mcpServers": {
    "stackql": {
      "command": "uvx",
      "args": ["stackql-mcp-server"]
    }
  }
}

{
  "mcpServers": {
    "stackql": {
      "command": "docker",
      "args": ["run", "-i", "--rm", "stackql/stackql-mcp"]
    }
  }
}

- uses: stackql/setup-stackql-mcp@v1
  with:
    mode: read_only

クライアントごとのセットアップ、認証、サーバーモードについては、MCP のインストールと使い方に関する完全なドキュメントを参照してください。

インストール

StackQL は Windows、MacOS、Linux、Docker、GitHub Actions などで利用できます。お使いのプラットフォームに応じたインストール手順を以下でご確認ください。

docker pull stackql/stackql

使い方

StackQL は、対話型の REPL シェル、exec コマンド、または Postgres ワイヤプロトコルを使ったサーバーとして利用できます。

ℹ️ StackQL はデータベースを必要とせず、インストールもしません。

• 対話型シェル

  # run interactive stackql queries
  stackql shell --auth="${AUTH}"
  

• ステートメントまたはファイルを実行

  stackql exec --auth="${AUTH}" -i myscript.iql --iqldata vars.jsonnet --output json
  
  # or
  
  stackql exec --auth="${AUTH}" "SELECT id, status FROM aws.ec2.instances WHERE region = 'us-east-1'"
  

  ℹ️ exec コマンドでは、--output フラグを使って json、csv、table、text の出力形式を指定できます。

  ℹ️ StackQL は jsonnet または json を使ったパラメーターの受け渡しに対応しています。詳しくは変数の使用をご覧ください。

• サーバー

  # serve client requests over the Postgres wire protocol (psycopg2, etc.) 
  # clients are not authenticated unless mTLS is configured via --pgsrv.tls, so keep the listener on loopback otherwise
  stackql srv --pgsrv.address=127.0.0.1 --auth="${AUTH}"
  

その他の例については、ブログをご覧ください。

コントリビューション

コントリビューションを歓迎し、奨励しています。コントリビューションの方法については、コントリビューションガイドをご覧ください。

ライセンス

MIT ライセンスのもとで配布されています。詳しくは LICENSE をご覧ください。使用しているサードパーティソフトウェアのライセンスは、/docs/licenses ディレクトリに含まれています。

お問い合わせ

Twitter の @stackql からご連絡いただくか、[email protected] までメールをお送りください。または、ディスカッションで会話を始めてください。

謝辞

以下のフォークが、私たちの取り組みを支えています。

• vitess
• kin-openapi
• gorilla/mux
• readline
• psql-wire
• mcp-postgres
• golang MCP SDK
• …など。記載漏れがありましたらご容赦ください。

これらの成果に心より感謝いたします。