Files
yetone 5da6c24e80 agents, gui, cli: an agent can be shown only the models picked for it, so a model added later stays out of its list until ticked (#1337, nianlee-official)
nianlee-official asked for an agent whose model list grows only by hand:
today the Agents page's per-agent list hides models one at a time, and
every new model, of a new provider or an old one, shows up in the
agent's picker and config on its own ("New models are shown").

What changed:
- settings: PickedModels, per agent. An agent named in it is shown only
  the catalog entries listed for it (after Visible); HiddenModels is not
  read for it.
- provider: ModelOff(agent) is the one test CatalogFor, the Agents page
  count and Codex's own ChatGPT models (CodexNativeHidden) use, so the
  gateway's /v1/models for that agent's key, the lists magpie writes into
  its config and Codex's /model all narrow the same way hidden models do.
  SetOnlyPicked switches it on or off keeping what is shown as it is
  (on: what is shown becomes the picks; off: the listed models not
  picked become hidden). SetPickedModels keeps a pick whose provider is
  missing for now. renameModelPrefs moves picks with a provider rename.
  A model asked for by name still resolves against the full catalog.
- GUI: the list's foot "New models are shown" note is now a switch
  "Only models I pick", with a tooltip saying what each side does. On,
  a click sends what is ticked ({shown}), not what is hidden, so a model
  that arrived after the list was opened isn't picked by accident; the
  server still reads {hidden} from an older page. The model in use is
  always kept. Hide all / Show all's armed state takes the switch's room.
  zh, zh-TW, ja and de strings; the old note string is gone.
- CLI: magpie visible <agent> --only-picked | --show-new; magpie visible
  lists such an agent as "only models picked"; magpie models <agent>
  says how many are not picked, and what to do when none is.
- /api/settings keeps PickedModels like HiddenModels.
- docs/reference.md: the per-agent list bullet.
Not touched: #1302 (bulk agent visibility) and its files.

Run:
- go test -tags nogui ./... in a temp HOME: 44 packages ok.
- New: provider TestOnlyPickedModels, gui TestAgentModelsOnlyPicked,
  gateway TestOnlyPickedModelsList (opencode's key: a new provider's and
  an old provider's new model are left out of /v1/models, cursor's key
  has them, and a chat request naming fresh/x1 reaches the upstream) and
  TestCodexModelListOnlyPicked. With ModelOff made to ignore picks, all
  four fail.
- GUI: new agent-models-only-picked.test.cjs, Chromium and WebKit, en/zh/de,
  420 and 1100 wide (12/12). With save() sending {hidden} in pick mode it
  fails. agent-model*, agent-models*, codex-model-order, cursor-local-models,
  desktop-model-menu, click-scroll, gui-ja, gui-de, gui-zh-tw: 85/85.
- gofmt -l clean; go vet -tags nogui ./... on darwin, GOOS=linux and
  GOOS=windows; go build, and linux/windows builds.
- The built CLI in a sandbox HOME: visible codex --only-picked, a model
  added after it is left out of `magpie models codex` and kept in claude's;
  --show-new keeps it out and new ones show again.
Not tried: the real window against a live gateway, or a real agent
reading the narrowed config.
2026-10-09 08:50:14 +08:00

312 lines
9.5 KiB
Go

package gui
import (
"cmp"
"encoding/json"
"net/http"
"slices"
"strings"
"github.com/yetone/magpie/internal/agent"
"github.com/yetone/magpie/internal/provider"
)
// Which of the catalog an agent's lists show, picked one model at a time
// on the Agents page (settings.HiddenModels, or settings.PickedModels for an
// agent shown only the models picked, #1337): the line under an agent's
// name counts them, and opens the list to pick in.
// modelCountJSON is how many models an agent's lists show, of those its
// visibility gives it.
type modelCountJSON struct {
Shown int `json:"shown"`
Listed int `json:"listed"`
// By is the models shown by whose they are, a connected agent's
// expanded row's chips (OpenAI 6 · OpenRouter 24)
By []modelGroupJSON `json:"by,omitempty"`
// Names are the first few models shown by name, for a row that says
// which it lists rather than how many (Claude Desktop's)
Names []string `json:"names,omitempty"`
}
// countNames is how many models' names modelCount gives.
const countNames = 3
// modelGroupJSON is how many of the models shown one provider (or the
// routing groups) gives.
type modelGroupJSON struct {
Name string `json:"name"`
Icon string `json:"icon,omitempty"`
Icons []string `json:"icons,omitempty"`
N int `json:"n"`
}
// agentModelJSON is a model an agent may be shown, as the list draws it.
type agentModelJSON struct {
ID string `json:"id"`
Name string `json:"name"`
Group string `json:"group"` // its provider's name, or "Routing groups"
Icon string `json:"icon,omitempty"`
Icons []string `json:"icons,omitempty"`
// Logo is its maker's: known by the model's family, or its provider's
// when that is the maker; "" when neither says, and for a group, which
// has Icons
Logo string `json:"logo,omitempty"`
Context int `json:"context,omitempty"`
Hidden bool `json:"hidden,omitempty"`
// InUse: the agent is set to it, so it can't be taken out
InUse bool `json:"inUse,omitempty"`
// Own: one of Codex's own, a ChatGPT account's, which Codex lists
// ahead of magpie's until the user puts them in an order (#855)
Own bool `json:"own,omitempty"`
}
// takesCatalog reports whether an agent picks among magpie's catalog: some
// option of a field of its is a catalog entry.
func takesCatalog(fields []fieldJSON) bool {
for _, f := range fields {
for _, o := range f.Options {
if o.Ref != "" {
return true
}
}
}
return false
}
// agentFields are an agent's pickers as the Agents page draws them.
func agentFields(a *agent.Agent, vals map[string]string) []fieldJSON {
out := []fieldJSON{}
for _, f := range a.Fields {
opts := f.Options(vals)
if opts == nil {
opts = []agent.Option{}
}
out = append(out, fieldJSON{Key: f.Key, Label: f.Label, Value: vals[f.Key], Options: opts})
}
return out
}
// agentModelCount is the line under an agent's name, nil for an agent that
// doesn't pick among the catalog nor has its menu from the gateway's list
// (agent.ListsModels). Its pickers list only the models shown, so
// with every one taken out they have no catalog entry left, yet the line is
// the one way to put them back (#356): it stays while any is hidden.
func agentModelCount(a *agent.Agent, fields []fieldJSON) *modelCountJSON {
id := a.ListsFor()
if takesCatalog(fields) || a.ListsModels {
return modelCount(id)
}
if _, only := provider.PickedModels(id); !only && len(provider.HiddenModels(id)) == 0 {
return nil
}
if c := modelCount(id); c.Shown < c.Listed {
return c
}
return nil
}
func modelCount(id string) *modelCountJSON {
listed, _ := provider.ListedFor(id)
off := provider.ModelOff(id)
c := &modelCountJSON{Listed: len(listed)}
at := map[string]int{}
for _, e := range listed {
if off(e.ID) {
continue
}
c.Shown++
if len(c.Names) < countNames {
c.Names = append(c.Names, cmp.Or(e.Name, e.Model, e.ID))
}
g := modelGroupJSON{Name: e.Provider.Name, Icon: e.Provider.Icon}
if e.Group != "" {
g = modelGroupJSON{Name: agent.RoutingGroups, Icons: e.Icons}
}
i, ok := at[g.Name]
if !ok {
i = len(c.By)
at[g.Name] = i
c.By = append(c.By, g)
}
c.By[i].N++
}
return c
}
// usedBy reports whether one of the agent's values is the entry: its id,
// with a prefix the agent's files give it (magpie/…), or, for the agent's
// own account, the vendor's model id alone.
func usedBy(a *agent.Agent, vals map[string]string, e provider.Entry) bool {
for _, v := range vals {
if v == "" {
continue
}
if v == e.ID || strings.HasSuffix(v, "/"+e.ID) {
return true
}
if acc := e.Provider.Account; e.Group == "" && acc != nil && acc.Agent == a.ListsFor() && v == e.Model {
return true
}
}
return false
}
func agentModelList(a *agent.Agent) []agentModelJSON {
id := a.ListsFor()
listed, _ := provider.ListedFor(id)
off := provider.ModelOff(id)
vals := a.Values()
out := []agentModelJSON{}
for _, e := range listed {
m := agentModelJSON{ID: e.ID, Name: e.Name, Group: e.Provider.Name, Icon: e.Provider.Icon, Context: e.Context,
Hidden: off(e.ID), InUse: usedBy(a, vals, e), Own: id == "codex" && provider.CodexOwn(e)}
if m.Name == "" {
m.Name = e.Model
}
m.Logo = agent.ModelIcon(e.Model)
if e.Group != "" {
// a group shows its providers' icons, as it does everywhere else
m.Group, m.Icons, m.Logo = agent.RoutingGroups, e.Icons, ""
} else if m.Logo == "" {
if p := provider.Preset(e.Provider.Preset); p != nil && p.Kind == provider.KindVendor {
m.Logo = e.Provider.Icon
}
}
out = append(out, m)
}
return out
}
func agentModelsAPI(mux *http.ServeMux) {
// a model the agent picks sent in its vendor's fast mode, or not (#954):
// for is the option's fastFor, the agent whose requests it goes on
mux.HandleFunc("POST /api/agent-fast", func(rw http.ResponseWriter, r *http.Request) {
var in struct {
For, Ref string
Fast bool
}
if err := json.NewDecoder(r.Body).Decode(&in); err != nil {
fail(rw, err)
return
}
if err := provider.SetFastPick(in.For, in.Ref, in.Fast); err != nil {
fail(rw, err)
return
}
writeJSON(rw, map[string]any{"fast": provider.IsFastPick(in.For, in.Ref)})
})
mux.HandleFunc("GET /api/agent-models/{id}", func(rw http.ResponseWriter, r *http.Request) {
a, err := agent.Find(r.PathValue("id"))
if err != nil {
fail(rw, err)
return
}
_, only := provider.PickedModels(a.ListsFor())
writeJSON(rw, map[string]any{"models": agentModelList(a), "ordered": len(provider.ModelOrder(a.ListsFor())) > 0, "only": only})
})
// hidden is every entry to take out of the agent's lists; the others
// are shown, and one the agent is set to is kept in whatever is asked
//
// order, instead, is the order the agent's list puts them in (#855):
// the ones named first, as named; none puts back magpie's own. Every
// agent's (#1052): its list, the gateway's /models and the files magpie
// writes for it all come from provider.CatalogFor, which keeps it
//
// only switches the agent between being shown new models and being
// shown only the models picked for it (#1337), the ones shown now
// staying as they are; shown, for an agent shown only its picks, is
// every entry its lists show, the others not, a model that comes later
// among them
mux.HandleFunc("POST /api/agent-models/{id}", func(rw http.ResponseWriter, r *http.Request) {
var in struct {
Hidden []string
Shown *[]string
Order *[]string
Only *bool
}
if err := json.NewDecoder(r.Body).Decode(&in); err != nil {
fail(rw, err)
return
}
a, err := agent.Find(r.PathValue("id"))
if err != nil {
fail(rw, err)
return
}
if in.Order != nil {
if err := provider.SetModelOrder(a.ListsFor(), *in.Order); err != nil {
fail(rw, err)
return
}
writeJSON(rw, map[string]any{"models": agentModelList(a), "ordered": len(provider.ModelOrder(a.ListsFor())) > 0})
return
}
id := a.ListsFor()
answer := func() {
_, only := provider.PickedModels(id)
writeJSON(rw, map[string]any{"models": agentModelList(a), "count": modelCount(id), "only": only})
}
if in.Only != nil {
if err := provider.SetOnlyPicked(id, *in.Only); err != nil {
fail(rw, err)
return
}
answer()
return
}
used := map[string]bool{}
listed := agentModelList(a)
for _, m := range listed {
used[m.ID] = m.InUse
}
// one the agent is set to is kept in whatever is asked, so it is
// among the picks too
if _, only := provider.PickedModels(id); only {
shown := map[string]bool{}
if in.Shown != nil {
for _, s := range *in.Shown {
shown[s] = true
}
} else {
// a list still sending what it hides, as it did before
// there were picks (one opened before the switch, in
// another window): every other listed one is shown
for _, m := range listed {
shown[m.ID] = !slices.Contains(in.Hidden, m.ID)
}
}
var picks []string
for _, m := range listed {
if shown[m.ID] || used[m.ID] {
picks = append(picks, m.ID)
}
}
if err := provider.SetPickedModels(id, picks); err != nil {
fail(rw, err)
return
}
answer()
return
}
var hidden []string
if in.Shown != nil {
// a list opened while the agent was shown only its picks, sent
// after it was switched back: every other listed one is hidden
for _, m := range listed {
if !slices.Contains(*in.Shown, m.ID) {
hidden = append(hidden, m.ID)
}
}
} else {
hidden = in.Hidden
}
hidden = slices.DeleteFunc(slices.Clone(hidden), func(s string) bool { return used[s] })
if err := provider.SetHiddenModels(id, hidden); err != nil {
fail(rw, err)
return
}
answer()
})
}