# CLI・MCP・API キー

> コマンドや AI エージェントからサイトを操作する手段。API キーで、サイトの作成・schema の反映・テスト送信・お問い合わせの確認・Webhook の管理・ホスティングへの公開ができます。

URL: https://siteon.dev/ja/docs/cli-mcp

Siteon は、AI で作ったサイトのためのインフラです。AI や手で作った静的サイト（HTML）に、ホスティング・お客さん（お店の人）が直せる CMS・お問い合わせフォーム・アクセス解析・AI エージェントからの操作（CLI・MCP）を足し、そのまま納品できる状態にします。

## API キー

アカウント単位で発行する鍵です。CLI と MCP サーバーはこの鍵で動きます。

- 発行できるのはアカウントのオーナーと管理者（右上のアカウントのメニュー →「API キー」、またはサイドバー下の「開発者」）
- 鍵は発行したときに **1 回だけ** 表示されます。安全な場所に保存してください
- 形は `stk_` で始まる文字列です。GitHub の secret scanning にカスタムパターン `stk_[a-z0-9]{8}_[A-Za-z0-9_-]{43}` を登録すると、誤ってコミットしたときに気づけます
- 発行のときに権限（scope）を選びます

| scope | できること |
|---|---|
| `sites:read` | サイトの一覧・設定・schema・Webhook の一覧を読む |
| `sites:write` | サイトを作る（Free から）、名前と[許可ドメイン](https://siteon.dev/ja/docs/domains#allowed-origins)を変える、Webhook を追加・削除する（追加は `submissions:read` も要る） |
| `schema:write` | schema.json を反映する |
| `submissions:read` | お問い合わせを読む |
| `forms:test` | 通知と Webhook のテスト送信 |
| `deploy:write` | ホスティングを有効にする・公開する（deploy）・前の版に戻す（rollback）・版の一覧を見る |
| `content:read` / `content:write` / `assets:write` | 値・記事・写真（CLI / MCP からの操作は準備中） |
| `forms:write` | フォームの作成・公開ページの公開 / 停止 |
| `settings:read` / `settings:write` | サイトの設定（通知先・お礼メールの文面など）を読む / 文面を変える |
| `settings:notify` | 通知先（メール・Slack・Webhook の URL）を変える。`siteon login` で作った本人の鍵だけ。変えるとアカウントの owner にお知らせが届く |
| `billing:read` / `billing:write` | プランと契約の状態を読む / 有料プランを申し込む・上位に変える（`plan set`） |
| `submissions:write` | 回答の状態・担当・メモ・取消・削除、CSV の書き出し |
| `bookings:write` （近日）| 日程調整の予約の確認・取消、予約ページの一時停止 |
| `domains:write` （近日）| 独自ドメインの追加・削除。なりすましの入口になりうるので、既定では付かず、発行のときに明示して選ぶ（`login --scopes +domains:write`。[独自ドメイン](https://siteon.dev/ja/docs/domains#custom-domain)） |

- `siteon login` で作る鍵（本人の鍵）には、サイト・schema・フォーム・設定・公開・プランの申し込み（`billing:write`）の権限が既定で付きます。サイトの削除・独自ドメイン・引き下げや解約は既定では付かず、`login --scopes` で足します
- 鍵の管理には、どの鍵からも触れません
- 別のアカウントのサイトには届きません（存在も教えません）
- 取り消し（失効）はすぐ効きます。有効期限は最長 1 年。発行した人がアカウントを抜けても鍵は残ります
- 1 つの鍵で 1 分あたり 600 リクエストまで。間違った鍵での失敗は、同じ接続元から 1 分に 30 回までです

## CLI

Node.js 22 以上で動きます。依存パッケージはありません。npm で配布しているので、インストールせずに `npx` で動かせます。

```sh
npx -y siteon-cli login      # 承認用の URL とコードが出る。ブラウザで開いて承認すると、鍵が CLI に保存される
npx -y siteon-cli whoami
```

AI エージェントから使うときは `login --json`（待たずに URL とコードを返す）→ 人が承認 → `login --wait`（承認を待って鍵を保存）の 2 段にします。鍵は画面にもチャットにも出ません。

承認や支払いの URL は、ブラウザで開いて人に渡します。CLI 1.0.4 からは `--open` を付けると、CLI がその URL を既定のブラウザで開きます（`login`・`plan set`・`plan status`・`google connect`。開けなくても URL はいつもどおり出ます）。1.0.3 までは `--open` を知らないオプションとして止まるので、エージェントが `open`（macOS）・`Start-Process`（Windows の PowerShell）・`xdg-open`（Linux）で開きます。版は `siteon --version` で確かめます。

すでに鍵を持っている場合は `login --stdin`（標準入力から読む）か、環境変数 `SITEKIT_API_KEY` に入れれば login は要りません（CI 向け）。

| コマンド | 中身 |
|---|---|
| `login` / `logout` / `whoami` | 承認リンクでのログイン（鍵の保存）・削除・確認 |
| `login --open` | 承認の URL をブラウザでも開く（CLI 1.0.4 から） |
| `sites list` | サイトの一覧 |
| `sites create <id> --name 名前 [--origin URL] [--template form] [--plan lite\|standard\|business]` | サイトを作る（既定は Free。開発用ドメインと siteun.com のサブドメイン）。`<id>` は[サイト ID の決まり](#site-id)のとおり。`--plan` を付けると、作るのと同時にそのプランを申し込む（返る URL と続きは `plan set` と同じ） |
| `schema pull` | サイトの schema を `sitekit/schema.json` に書き出す |
| `schema validate` | 手元で検査する（通信しない） |
| `schema push` | 検査してから反映する |
| `settings show` | サイトの設定（通知先・お礼メール・Turnstile・言語。Slack は伏せ字） |
| `settings set --settings <json\|@file>` | 設定を保存する。書いたフォームの項目だけが変わる。通知先の例: `--settings '{"forms":{"contact":{"staff_mail":["info@example.jp"]}}}'`（`settings:notify`。保存するとアカウントの owner にお知らせが届く） |
| `forms test <form>` | 通知のテスト送信。通知先が空なら、どの送り先も `skipped`（`no_target`）になる |
| `plan show` | 上限・月額の契約の合計・各サイトのプラン |
| `plan set <lite\|standard\|business> --site <id> [--yearly] [--json]` | 有料プランを申し込む・上位に変える。待たずに返る。契約が無ければ支払い（Checkout）の URL、AI に任せた月額の上限を超えれば owner の承認の URL を返すので、人に渡す。上限内ならそのまま進む（`billing:write`） |
| `plan status --site <id> [--request <id>] [--wait] [--timeout 600] [--json]` | 申し込みと契約の状態。`--wait` は `applied` か終わりの状態（却下・失効・失敗・`action_required`）まで 5 秒ごとに見る。`applied` になったら公開できる。`action_required` なら `recovery_url`（支払いの URL）を人に渡す |
| `submissions list [--form key] [--unread]` | お問い合わせの一覧 |
| `snippet [--form key] [--prompt]` | 貼るタグとフォームの HTML。`--prompt` で AI に貼る指示文 |
| `hosting enable [--subdomain 名前]` | ホスティングを有効にする（初回だけ。Free プランでも使える）。サイト ID がサブドメインに使えないときは `--subdomain` で決める |
| `deploy <dir>` | フォルダを公開する。変わったファイルだけを送り、全部届いてから切り替える |
| `rollback [deploy_id]` | 保持している前の版に戻す（省略すると 1 つ前） |
| `deploys` | 版の一覧（公開中に `*`） |
| `domains add <ドメイン> [--primary]` / `domains status` （近日）| 独自ドメインを申請する（DNS に入れる CNAME と TXT が出る）/ 状態と DNS の案内（その場で確かめる）。[独自ドメイン](https://siteon.dev/ja/docs/domains#custom-domain) |
| `domains remove <ドメイン> --yes` / `domains primary <ドメイン> --yes` （近日）| 独自ドメインを外す（すぐに表示が止まる）/ 主ドメインにする |
| `webhooks list` | Webhook の一覧（URL は伏せ字・対象のフォーム・直近の送信結果） |
| `webhooks add <https-url> [--form key ...]` | Webhook を追加する（有料プラン・1サイト5本）。**署名用の秘密はこのときだけ表示** |
| `webhooks remove <id>` | Webhook を削除する（送信待ちのものも送らない） |
| `webhooks test <id>` | 署名付きのダミーを送って結果を見る |
| `forms create --template <contact\|survey\|application\|brochure\|job> [--site id] [--key k] [--title "..."] [--no-page]` | テンプレートからフォームと公開ページを作る。`--site` も `site.json` も無ければ、サイトが 1 つならそれを、0 なら Free サイトを 1 つ作って使う（2 つ以上なら `--site` が要る。キーの権限 `schema:write` と `forms:write`） |
| `forms list` | フォーム・key・受付数・公開 URL |
| `forms show <form>` | URL・QR・埋め込みコード・状態 |
| `forms publish <form>` / `forms unpublish <form>` | 公開ページを出す・止める（`forms:write`） |
| `forms qr <form> [--out qr.svg]` | QR の URL・SVG の保存 |
| `forms stats <form> [--from YYYY-MM] [--to YYYY-MM]` | 集計（`submissions:read`） |
| `forms export <form> [--from YYYY-MM] [--to YYYY-MM] [--status s] [--entry-state s] [--out file.csv]` | CSV に保存（`submissions:write`。1 回 50,000 件まで） |
| `submissions show <id>` | 回答・状態・申込の状態・版・メモ・履歴 |
| `submissions set-status <id> <状態>` / `assign <id> <user_id\|none>` / `note <id> <メモ>` | 状態・担当・メモ（`submissions:write`。先に変えられていれば 409） |
| `submissions cancel <id> --yes` （近日）| 定員つき・メール確認つきの申込の取消。取り消せず、お客様にメールが届く。確定の席ならキャンセル待ちの先頭が繰り上がる |
| `submissions delete <id> --yes` | 回答の削除（取り消せない） |
| `statuses list` / `statuses add <key> <表示名>` / `statuses remove <key> --move-to <状態> --yes` | 回答の状態の定義（組込み 3 つ＋独自 10 件まで）。`remove` は状態を消して回答を `--move-to` の状態へ移すので、確認の `--yes` が必須 |
| `booking status` / `booking list` / `booking cancel <id> --yes` / `booking pause <resource\|page> <id>` （近日）| 日程調整の確認・取消・一時停止（`bookings:write`。[日程調整](https://siteon.dev/ja/docs/scheduling)） |
| `mcp [--read-only]` | MCP サーバーとして起動。`--read-only` は書き込み系の操作を出さない |

`--site` を省くと `sitekit/site.json` の `id` を使います。

### 鍵の保存先（設定ファイル）

| OS | 保存先 |
|---|---|
| macOS・Linux | `$SITEKIT_CONFIG` → `$XDG_CONFIG_HOME/sitekit/config.json` → `~/.config/sitekit/config.json`（ファイルは `0600`、フォルダは `0700`） |
| Windows（CLI 1.0.4 から） | `$SITEKIT_CONFIG` → `%APPDATA%\siteon\config.json`（`APPDATA` が無ければ `%USERPROFILE%\AppData\Roaming\siteon\config.json`）。前からある `~/.config/sitekit/config.json` があればそれを使います |

- **Windows では CLI 1.0.4 以降が要ります。** 1.0.3 までは、どのフォルダを指しても `config_unsafe` で止まり、ログインできません（Windows のフォルダの権限を POSIX の形で判定していたため）
- Windows には POSIX の権限が無いので、本人のプロファイルのアクセス権（本人・SYSTEM・Administrators だけ）で守ります。`SITEKIT_CONFIG` で別の場所を指すときは、本人しか書けないフォルダにしてください
- `--profile <名前>` を付けると、鍵を同じフォルダの `profiles/<名前>.json` に分けて持てます（読み取り専用の鍵と書き込める鍵を分けるときなど）
- 環境変数 `SITEKIT_API_KEY` / `SITEKIT_ORIGIN` は設定ファイルより優先します。保存した鍵は、login した接続先にしか送りません

### サイト ID の決まり

サイト ID は英小文字・数字・ハイフンで、先頭は英小文字か数字、64 文字までです（`^[a-z0-9][a-z0-9-]{0,63}$`）。あとから変えられず、Siteon のホスティングで公開すると、初回はサイト ID がサブドメイン（`<サイトID>.siteun.com`）になります。サブドメインに使えないときや別の名前にしたいときは、初回の `hosting enable --subdomain <名前>` で決めます。

登録のときに、ID がランダムな英数字の「はじめてのサイト」が 1 つ自動で作られます（schema は空、まだ公開していない）。そのまま使っても、新しく作っても構いません。Free のサイトはアカウントに 3 つまでで、「はじめてのサイト」も 1 つに数えます。

### 公開（deploy）

```sh
siteon hosting enable --site hanaya   # 初回だけ
siteon deploy ./dist --site hanaya    # 公開。URL が表示される
siteon rollback --site hanaya         # 1 つ前の版に戻す
```

- 公開できない種類のファイル（`exe` など）や予約パス（`admin/`・`v1/`・`_sk/`）があれば、**送る前に**止まります。ドットで始まるファイル（`.well-known/` 以外）は送りません
- 通信が切れても同じ操作として送り直すので、二重に公開されません。途中で失敗したら、予約を取り消してから終わります
- 反映までは最大 15 秒です。詳しくは [ホスティングと配信](https://siteon.dev/ja/docs/hosting#ホスティングsiteon-deploy)

### Webhook

```sh
siteon webhooks add https://hooks.example.com/siteon --site hanaya --form contact   # 秘密はこのときだけ表示
siteon webhooks test <id> --site hanaya     # 署名付きのダミーを送る
siteon webhooks list --site hanaya          # 直近の送信結果
```

送る JSON・署名の検証・再送は [Webhook](https://siteon.dev/ja/docs/webhooks) にあります。

### schema の反映

```sh
siteon schema pull --site <サイトID>   # sitekit/schema.json を作る
# schema.json を編集
siteon schema push                     # 検査して反映
```

pull したあとに管理画面などで schema が変わっていたら、push は止まります（上書きを防ぐため）。
もう一度 pull して直すか、上書きしてよいときだけ `--force` を付けます。

### 機械向けの出力

全コマンドに `--json` があり、成功でも失敗でも JSON を 1 つ出します。終了コード:

| コード | 意味 |
|---|---|
| 0 | 成功 |
| 2 | 入力の誤り（存在しないサイト、schema の競合、`reserved_path`・`subdomain_required` など） |
| 3 | 上限・プラン（`plan_required`・`deploy_too_large`・`too_many_files`・`file_too_large`・`quota_exceeded`・`rate_limited` など） |
| 4 | schema の検査に不合格 |
| 5 | サーバー・通信 |
| 6 | 鍵が無効・権限不足 |

失敗のときの JSON には、`error`（コード）と、何をすればよいかを日本語で書いた `hint` が入ります。

```json
{"ok":false,"error":"file_type_not_allowed","hint":"setup.exe は公開できない種類です（拡張子 exe）。…","status":400}
```

## MCP サーバー

CLI と同じ操作を、Claude や Cursor などの AI エージェントから使えます。AI で作ったサイトに「フォームを付けて」と頼むと、項目の追加・反映・貼るタグの提示・テスト送信まで、「公開して」と頼むと deploy まで進めます。MCP サーバーは手元で動きます（フォルダを読んで公開するため）。

### Claude Code

```sh
claude mcp add siteon -- npx -y siteon-cli mcp
```

先に `siteon login` しておくか、`-e SITEKIT_API_KEY=stk_...` を付けます。

### Claude Desktop

`claude_desktop_config.json` に:

```json
{
  "mcpServers": {
    "siteon": {
      "command": "npx",
      "args": ["-y", "siteon-cli", "mcp"],
      "env": { "SITEKIT_API_KEY": "stk_..." }
    }
  }
}
```

### チャット AI（Claude.ai・ChatGPT）から使う

チャット AI のコネクタ（カスタムコネクタ）に `https://app.siteon.dev/mcp` を追加すると、チャットの中から Siteon を操作できます。追加するとブラウザで Siteon のログインと承認の画面が開くので、何を許可するかを確かめて承認します。鍵を貼る必要はありません。手元のフォルダを読んで公開する作業は、手元で動く MCP サーバーか CLI で行います。

### 使える操作（tools）

| tool | 中身 |
|---|---|
| `list_sites` | サイトの一覧 |
| `create_site` | サイトを作る |
| `get_schema` / `update_schema` | schema を読む / 反映する |
| `add_form_field` | フォームに項目を 1 つ足す |
| `get_embed_snippet` | 貼るタグとフォームの HTML |
| `list_submissions` | お問い合わせの一覧 |
| `send_test` | 通知のテスト送信 |
| `deploy` | フォルダを公開する（`dir` は MCP サーバーを起動したフォルダからの相対パス） |
| `rollback` | 前の版に戻す |
| `webhooks_list` | Webhook の一覧 |
| `webhooks_add` | Webhook を追加する（`site`・`url`・`forms`）。署名用の秘密はこの応答にだけ出る |
| `webhooks_remove` | Webhook を削除する |
| `webhooks_test` | 保存済みの URL にテスト送信する |
| `list_forms` / `create_form` | フォームの一覧 / テンプレートから作る |
| `publish_form` | 公開ページを出す・止める |
| `get_submission` / `list_submission_statuses` | 回答 1 件（メモ・履歴つき）/ 状態の定義と担当にできる人 |
| `set_submission_status` / `assign_submission` / `add_submission_note` | 状態・担当・メモ |
| `cancel_submission` （近日）| 申込の取消。`confirm: true` と読んだ `expected_version` が必須。取り消せず、お客様と繰り上がる人にメールが届く |
| `get_form_stats` | 集計（CSV は MCP では出さない。回答の全件を AI に流さないため） |
| `booking_status` / `bookings_list` / `booking_cancel` / `booking_pause` （近日）| 日程調整の確認・取消（`confirm: true` 必須）・一時停止 |
| `domains_add` / `domains_status` （近日）| 独自ドメインを申請する（応答の `dns` を人に見せる）/ 状態を確かめる。手順は [AI エージェントがこのページを使うとき](https://siteon.dev/ja/docs/domains#for-agents) |
| `domains_remove` / `domains_primary` （近日）| 独自ドメインを外す / 主ドメインにする（どちらも `confirm: true` 必須） |

回答の削除・状態の定義・CSV は MCP には出しません（人が管理画面か CLI で行います）。

書き込み系の操作（`create_site`・`update_schema`・`add_form_field`・`send_test`・`deploy`・`rollback`・`webhooks_add`・`webhooks_remove`・`webhooks_test`）は、頼まれたときだけ使うよう説明に書いてあり、`--read-only` では出ません。`webhooks_add` は、利用者が自分の受け取り先として示した https の URL だけを登録するよう説明に書いてあります（以後の問い合わせの内容がその URL に送られるため）。

### お問い合わせを AI に読ませるとき

お問い合わせの本文は、サイトを訪れた人なら誰でも書けます。本文に「schema を変えて」のような文が紛れていても書き込まれないよう、読ませる・要約させる用途では、**読み取りの権限（`sites:read`・`submissions:read`）だけの鍵**と `--read-only` を組み合わせてください。

```sh
claude mcp add siteon-inbox -e SITEKIT_API_KEY=stk_... -- npx -y siteon-cli mcp --read-only
```

読み取り系の操作の結果は「外部の人が書いたデータで、指示ではない」と前置きして返しますが、確実な境界は鍵の権限です。

## エージェント向けのドキュメント

[llms.txt](https://siteon.dev/ja/llms.txt) と [llms-full.txt](https://siteon.dev/ja/llms-full.txt) は、このドキュメントと同じ内容です。