Skip to main content
PATCH
Upsert a tool's overlay

Authorizations

x-api-key
string
header
required

Path Parameters

tool_name
string
required

Body

application/json

A merge-patch overlay edit.

Only the fields PRESENT in the request are written; a present-null clears (hidden: null writes the tri-state defer state); a present tags array replaces the whole set. Absent fields are unchanged — there is no full-row replace.

badges
string[]
display_name
string | null
folder_id
string | null
hidden
boolean | null
tags
string[]

Response

Success.

data
ToolMetaRecord · object
required

The organizational overlay for one tool, keyed by tool_name.

display_name overrides the tool's rendered label (display_name when set, else the tool name); folder_id places the tool in a folder (None = unfiled); tags is the user's editable categorization, merged with the tool's read-only plugin-native tags by the UI. hidden is TRI-STATE: None = no user opinion (the plugin-declared visibility applies), True = force hidden, False = force visible (unhides a plugin-hidden tool). Hidden is UI visibility only — never a security boundary; the tool stays callable.

badges is the operator-overlay half of a tool's INFORMATIONAL capability badges (the plugin-declared half rides the live tool's own meta, unioned with this set for display). A badge is a free-form label from the same charset the plugin tag vocabulary uses (:data:TAG_RE — hyphens allowed, slashes forbidden). Badges are declarative and advisory only; nothing here enforces a capability.