summaryrefslogtreecommitdiff
path: root/doc/config.md
diff options
context:
space:
mode:
Diffstat (limited to 'doc/config.md')
-rw-r--r--doc/config.md59
1 files changed, 52 insertions, 7 deletions
diff --git a/doc/config.md b/doc/config.md
index 48142dc..9fcdd55 100644
--- a/doc/config.md
+++ b/doc/config.md
@@ -25,10 +25,13 @@ uv run mcp-sd15 --config C:\path\to\config.toml
│ └─ <model.vae>
├─ lora/
│ └─ <model.lora.file>
-└─ controlnet/
- ├─ <controlnet.depth.model>
- ├─ <controlnet.openpose.model>
- └─ <controlnet.inpaint.model>
+├─ controlnet/
+│ ├─ <controlnet.depth.model>
+│ ├─ <controlnet.openpose.model>
+│ └─ <controlnet.inpaint.model>
+└─ prompts/
+ ├─ <prompt.positive_file>
+ └─ <prompt.negative_file>
```
各モデル項目にはパスではなくファイル名だけを記述する。絶対パス、ディレクトリ名を含む
@@ -59,6 +62,8 @@ uv run mcp-sd15 --config C:\path\to\config.toml
| `server.transport` | string enum | No | `stdio` |
| `server.host` | string | No | `127.0.0.1` |
| `server.port` | integer | No | `8000` |
+| `prompt.positive_file` | string | No | なし |
+| `prompt.negative_file` | string | No | なし |
## 4. `[model]`
@@ -295,10 +300,46 @@ port = 8000
- 既定値は`8000`
- `transport`が`stdio`のときは使用されない
+## 10. `[prompt]`
+
+全ツールで共通するbase promptを指定する。プロンプトファイルは`<root>/prompts/`に
+配置し、TOMLにはファイル名だけを記述する。table自体を省略した場合はbase promptなし
+(後方互換)となる。
+
+```toml
+[prompt]
+positive_file = "positive.txt"
+negative_file = "negative.txt"
+```
+
+起動時にファイルを読み込み、LLMからのプロンプトと結合してpipelineへ渡す。
+
+### 結合規則
+
+| 項目 | 結合方式 |
+|---|---|
+| positive | `base_positive, user_positive` の順でカンマ区切り |
+| negative | `base_negative\nuser_negative` の順で改行区切り |
+
+baseが空の場合はuserプロンプトのみになる。userの`positive_prompt`が空の場合は
+従来通りエラーになる。
+
+### `positive_file`
+
+- `<root>/prompts/<positive_file>`として解決
+- ファイル名のみ指定可能。パスは拒否される
+- 省略時はbase positiveなし
+
+### `negative_file`
+
+- `<root>/prompts/<negative_file>`として解決
+- ファイル名のみ指定可能。パスは拒否される
+- 省略時はbase negativeなし
+
相対`directory`はconfigファイルのディレクトリを基準に解決する。保存が有効な場合、
ディレクトリは最初の保存時に作成され、ファイル名はランダムUUIDの`<uuid>.png`となる。
-## 9. 最小設定例
+## 11. 最小設定例
Text-to-Imageだけを使用する最小構成は次のとおり。
@@ -311,7 +352,7 @@ checkpoint = "model.safetensors"
この場合、VAEとLoRAは使用せず、全ControlNetとローカル保存は無効になる。生成設定には
既定値が使用される。
-## 10. 全設定例
+## 12. 全設定例
```toml
[model]
@@ -349,9 +390,13 @@ model = "control_v11p_sd15_inpaint.safetensors"
[output]
enabled = false
directory = "./outputs"
+
+[prompt]
+positive_file = "positive.txt"
+negative_file = "negative.txt"
```
-## 11. 起動時validation
+## 13. 起動時validation
次のいずれかに該当するとMCPサーバは起動しない。