Skip to content

Commit 7e2a5b7

Browse files
committed
docs(readme): clarify that explicit provider config does not require listing models
Split the previous combined example into a minimal URL/auth override and a separate optional curation example, so users no longer think they must declare each model under `models` to make the plugin work.
1 parent 74f68b6 commit 7e2a5b7

1 file changed

Lines changed: 22 additions & 3 deletions

File tree

README.md

Lines changed: 22 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -89,9 +89,9 @@ If LiteLLM is on `localhost:4000`, `:8000`, or `:8080`, the plugin self-configur
8989
}
9090
```
9191

92-
### Explicit provider
92+
### Explicit provider (custom URL or auth)
9393

94-
Override the URL, set an API key, or pre-define curated models that the plugin will preserve:
94+
You **do not need to list any models** — the plugin still discovers them from `/v1/models` automatically. Use this form only when you need to point at a non-default URL or pass an API key:
9595

9696
```jsonc
9797
{
@@ -101,6 +101,25 @@ Override the URL, set an API key, or pre-define curated models that the plugin w
101101
"litellm": {
102102
"npm": "@ai-sdk/openai-compatible",
103103
"name": "LiteLLM (proxy)",
104+
"options": {
105+
"baseURL": "http://litellm.internal.example.com/v1",
106+
"apiKey": "{env:LITELLM_API_KEY}"
107+
}
108+
}
109+
}
110+
}
111+
```
112+
113+
That's the whole config — every model in your LiteLLM `model_list` will appear in the picker.
114+
115+
### Overriding or curating individual models (optional)
116+
117+
If you want to rename a model in the picker, pin its `organizationOwner`, or otherwise hand-curate metadata, add it under `models`. The plugin **preserves your entries verbatim** and only injects discovered models whose key isn't already defined:
118+
119+
```jsonc
120+
{
121+
"provider": {
122+
"litellm": {
104123
"options": {
105124
"baseURL": "http://litellm.internal.example.com/v1",
106125
"apiKey": "{env:LITELLM_API_KEY}"
@@ -116,7 +135,7 @@ Override the URL, set an API key, or pre-define curated models that the plugin w
116135
}
117136
```
118137

119-
The plugin will **keep your hand-defined `openai/gpt-4o`** and only inject models it discovers that aren't already there.
138+
Here, `openai/gpt-4o` keeps your custom name; every other model from the proxy is still discovered and added automatically.
120139

121140
### Reasoning models (gpt-5, o1/o3/o4)
122141

0 commit comments

Comments
 (0)