> ## Documentation Index
> Fetch the complete documentation index at: https://docs.makkii.jp/llms.txt
> Use this file to discover all available pages before exploring further.

# AI アシスタント連携

> Markdown 仕様書エクスポートと HTTP API で AI アシスタントに作業させる

Number Codec Compiler は、ChatGPT や Claude のような AI アシスタントにフィールド追加や生成コードの調整を依頼しやすいように、仕様一式を Markdown で書き出す機能と、AI アシスタントから直接叩ける HTTP API を持っています。

## Markdown 仕様書エクスポート

AI プロンプトエクスポートのモーダルから、以下を含む 1 つの Markdown ドキュメントをコピー/ダウンロードできます。

1. ツールの仕組み (フィールドの状態数の数え方、4 種類のパッキング方式、プロジェクト JSON スキーマ、HTTP API) の固定リファレンス。
2. 現在のパケット概要 (パケット名、受信テーブル変数名、送信/受信チャンネル、`backend`、総状態数、必要チャンネル数)。
3. 現在のフィールド一覧 (名前・種類・チャンネル・範囲や状態数)。
4. 現在選択中の候補で生成される Sender/Receiver の Lua コードのプレビュー。
5. (「現在編集中の設定データ (JSON) を末尾に含める」を有効にした場合) 現在のプロジェクト設定そのもの (JSON)。

コピーボタンを押すとクリップボードにコピーされ (「AIプロンプトをクリップボードにコピーしました」)、「.md保存」ボタンを押すと `codec-compiler-ai-prompt.md` として保存されます (「codec-compiler-ai-prompt.md を保存しました」)。この Markdown を AI アシスタントに渡すと、ツール固有の仕様 (フィールドの意味、パッキングの仕組み、JSON スキーマ) を踏まえたうえでフィールド追加やコード調整を手伝ってもらえます。

## HTTP API

HTTP リクエストを実行できる AI アシスタント (エージェント) 向けに、公開 API を提供しています。ベース URL は次のとおりです。

```
https://www.makkii.jp/tools/stormworks/codec-compiler/api
```

| エンドポイント     | メソッド   | 用途                                                                                                                                                                                                                                         |
| ----------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `/generate` | `POST` | ボディに [プロジェクト JSON スキーマ](/codec-compiler/reference/json-schema) に沿った 1 パケット分の JSON を渡すと、パッキング結果を返します。クエリパラメータ `?k=<n>` で特定のチャンネル数の候補を指定でき、`?format=lua&part=sender` または `?format=lua&part=receiver` を付けると JSON 応答の代わりに生の Lua コードをテキストで返します。 |
| `/schema`   | `GET`  | API の正式なリクエスト/レスポンススキーマを Markdown で返します。                                                                                                                                                                                                   |
| `/example`  | `GET`  | そのまま `POST /generate` に渡せるサンプルのリクエストボディを返します。                                                                                                                                                                                              |

API はステートレスで、CORS が有効 (`Access-Control-Allow-Origin: *`)、認証は不要です。`/generate` の JSON レスポンスには `ok: true`/`false` が含まれ、`false` の場合は `error` (該当する場合は `channelRange` も) が含まれます。UI での編集を介さず、この API を使って直接 Lua を生成させることもできます。


## Related topics

- [セーブ管理と設定の入出力](/physics-codegen/reference/data.md)
- [JSON インポート/エクスポート](/codec-compiler/guides/import-export.md)
- [Number Codec Compiler](/codec-compiler/index.md)
- [HTTP API リファレンス](/physics-codegen/reference/api.md)
- [信号モデル](/stormworks/logic/signal-model.md)