1 files changed, 22 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d88e388
--- /dev/null
+++ b/README.md
@@ -0,0 +1,22 @@
+# mcp-sd15
+
+ローカルの NVIDIA GPU と Stable Diffusion 1.x 互換 checkpoint を使う、stdio MCP
+サーバです。Text-to-Image、Depth/Openpose 誘導生成、ControlNet Inpaint を公開します。
+
+## セットアップ
+
+1. `config.example.toml` をコピーし、モデルの root とファイル名を設定します。
+2. `uv sync` を実行します。
+3. `uv run mcp-sd15 --config path/to/config.toml` で起動します。
+
+モデルは `<root>/checkpoints`、`vae`、`lora`、`controlnet` からだけ読み込みます。
+Depth/Openpose の annotator 重みは `controlnet_aux` のローカルキャッシュに事前配置して
+ください。推論時のダウンロードは行いません。
+
+MCP の `input_image` / `mask_image` は PNG または JPEG の Base64（data URI も可）です。
+mask は白い領域が再生成対象です。出力は PNG の画像 content で、seed 等は PNG metadata
+にも記録されます。
+
+GPU を使わないテストは `uv run pytest`、lint は `uv run ruff check .`、型検査は
+`uv run pyright` で実行できます。実モデルの smoke test は環境依存のため自動テストには
+含めていません。