Skip to main content
Glama
README.md
# kSQL アクション — 設定のオーサリング(tools と MCP)

kintone プラグイン **「kSQL アクション」(rex0220 kSQL Action)** の設定を、AI(Claude)が要望から作り・直すための環境です。
作った設定は、利用者がプラグインの設定画面で **設定をアップロード → 保存 → 運用環境に反映** して使います。

- **AI は kintone に書き込みません。** 読むのは項目定義などの GET だけで、取り込みと実行は必ず人が画面で行います。
- **検査はプラグイン本体と同じコードを使います。** 設定の形・SQL(kSQL の Flow dialect 1)・テーブルへの書き戻し(APPLY)・計算式の検査は、
  **利用者が持っているプラグインの zip に同梱された「オーサリング API」**(`config_js/ksql-action-authoring-api.js`)を読み込んで呼びます。
  このリポジトリに有償プラグインのコードは入っていません。
- 配り方は 2 つ: **Claude Code のプラグイン**(ツール名の接頭辞は `kact_`)と、**Claude Desktop の `.mcpb`**。

## 要るもの

| もの | 置き場所 | 備考 |
|---|---|---|
| kSQL アクションプラグインの zip | 利用者が配布元から入手したもの | `.env` の `KACT_PLUGIN_ZIP`(または MCP の設定項目)で場所を指定 |
| kintone の接続のファイル | 作業フォルダーの外 | kSQL の `ksql.config.json` と同じ形。アプリごとの**閲覧だけ**の API トークン |
| Node | 20 以上 | |

## 使い方(概要)

1. 作業フォルダーを用意し、MCP(または CLI)を登録する。
2. AI に作りたいアクションを伝える(「受注を顧客ごとに集計して、集計アプリのテーブルに書き戻したい」など)。
3. AI が項目定義を読み、SQL と計算式を組み立て、**本体と同じ検査**を通してから設定ファイルを保存する。
4. 利用者が設定画面で取り込み、保存し、運用環境に反映して、ボタンを押して確かめる。

## このリポジトリの中身

| フォルダー | 中身 |
|---|---|
| `src/` | tools の中核(zip の読み取り、エンジンとオーサリング API の読み込み、検査の呼び出し)と MCP サーバー |
| `vendor/` | zip に入っていない moment(プラグインは CDN から読むため、tools は自前で持つ) |
| `docs/` | 手順と資料(`kact_docs` が返すもの) |

## ライセンス

MIT(`LICENSE`)。zip から読み込む kSQL アクションプラグインと計算式エンジンのコードは**このリポジトリには含まれません**。