Skip to content

customize

The customize domain has 2 actions. On the meta surface they are all reached through arcane_customize; on the individual surface each one is its own tool; on the dynamic surface run them with arcane_execute_action and the canonical ID.

ActionTitleKind
customize.categoriesGet customization categoriesread
customize.searchSearch customization optionsread

Get customization categories

Get all available customization categories with metadata

  • Kind: read
  • Required parameters: none
  • Meta tool: arcane_customize with "action": "categories"
  • Individual tool: arcane_customize_categories
  • Arcane route: GET /api/customize/categories
  • Operation ID: get-customize-categories
  • Usage: Static navigation metadata of the web UI’s Customize section: categories templates, registries, variables and git-repositories (only those the caller’s permissions allow), each with id, title, description, icon, url and a settings list of descriptive option entries (key, label, type, description, keywords). Category keywords are always empty. It holds no stored values and nothing reads or writes these options. Manage the real items with template.list, registry.list, variable.list and git_repository.list.
  • Related actions: customize.search, template.list, registry.list, variable.list, git_repository.list

Search customization options

Search customization categories and options by query

  • Kind: read
  • Required parameters: query
  • Meta tool: arcane_customize with "action": "search"
  • Individual tool: arcane_customize_search
  • Arcane route: POST /api/customize/search
  • Operation ID: search-customize
  • Usage: Finds which Customize category covers a word: query (required, non-empty or 400) is matched case-insensitively as a substring against category titles and descriptions and against each option’s key, label, description and keywords, and categories the caller’s permissions hide are dropped. Results are sorted by relevanceScore, and matchingSettings is present only when an option itself matched (e.g. query git returns git-repositories). Use settings.search instead for instance settings.
  • Related actions: customize.categories, settings.search, template.list, git_repository.list