Files

34 lines
1.8 KiB
Markdown
Raw Permalink Normal View History

2026-08-26 18:06:02 +08:00
# 插件目录
每个子文件夹是一个插件。软件启动后扫描**网页宿主执行目录**下的 `plugins/`(即 `MAF1.Web.exe` 旁边),不是源码目录。
2026-08-26 18:06:02 +08:00
协议:`plugin.json``protocolVersion`**1**(缺省也当 1)。stdin 形状见 [docs/plugin-protocol-v1.schema.json](../docs/plugin-protocol-v1.schema.json)。
2026-08-26 18:06:02 +08:00
## 必备文件
- `plugin.json`id、protocolVersion、启动命令、凭据声明、inputs、outputs
2026-08-26 18:06:02 +08:00
- `README.md`:给使用者看的说明
- 可执行文件 / 脚本 / 源码:由 `launch.command` + `launch.args` 原样启动
非秘密配置(例如天气 URL 模板)放在**插件自己目录**的 `appsettings.json``plugin.json``env`。不要去读宿主 exe 旁的配置文件。
2026-08-26 18:06:02 +08:00
## 凭据(不要写进 plugin.json
n8n / Dify 一类产品把 API Key 放在宿主凭据库,节点只声明「我需要哪种凭据」。本项目同样:
- Key 和 endpoint 配在宿主的环境变量或 `appsettings.json``Credentials` / `Llm`
- 节点可选 `credentialId`LLM,默认 `llm-default`);其它类型用 `credential:<name>` 或按 type 取默认
- 只注入 **plugin.json 里声明过的**凭据。未声明 LLM 的插件拿不到 `OPENAI_API_KEY`
- 启动子进程时写入对应环境变量,并在 stdin JSON 的 `credentials` 里再传一份
2026-08-26 18:06:02 +08:00
- 浏览器和流程图 JSON **不会**包含 apiKey
已知 `type` 与环境变量:
| type | 环境变量 |
|------|----------|
| `openai-compatible` / `llm` | `OPENAI_ENDPOINT` / `OPENAI_API_KEY` / `OPENAI_CHAT_MODEL` |
| `openweather` | `OPENWEATHER_API_KEY` |
| 其它 | `extra` 里的键原样写入环境变量 |
2026-08-26 18:06:02 +08:00
第三方若要用自己的模型,可在插件目录放 `.env`(不要提交)。节点选中的宿主凭据会覆盖其中的同名变量。