curl --request PATCH \
--url https://api.example.com/api/tool-meta/tools/{tool_name} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"badges": [],
"display_name": "<string>",
"folder_id": "<string>",
"hidden": true,
"tags": []
}
'import requests
url = "https://api.example.com/api/tool-meta/tools/{tool_name}"
payload = {
"badges": [],
"display_name": "<string>",
"folder_id": "<string>",
"hidden": True,
"tags": []
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
badges: [],
display_name: '<string>',
folder_id: '<string>',
hidden: true,
tags: []
})
};
fetch('https://api.example.com/api/tool-meta/tools/{tool_name}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/tool-meta/tools/{tool_name}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'badges' => [
],
'display_name' => '<string>',
'folder_id' => '<string>',
'hidden' => true,
'tags' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/tool-meta/tools/{tool_name}"
payload := strings.NewReader("{\n \"badges\": [],\n \"display_name\": \"<string>\",\n \"folder_id\": \"<string>\",\n \"hidden\": true,\n \"tags\": []\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.example.com/api/tool-meta/tools/{tool_name}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"badges\": [],\n \"display_name\": \"<string>\",\n \"folder_id\": \"<string>\",\n \"hidden\": true,\n \"tags\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/tool-meta/tools/{tool_name}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"badges\": [],\n \"display_name\": \"<string>\",\n \"folder_id\": \"<string>\",\n \"hidden\": true,\n \"tags\": []\n}"
response = http.request(request)
puts response.read_body{
"data": {
"tool_name": "<string>",
"badges": [
"<string>"
],
"display_name": "<string>",
"folder_id": "<string>",
"hidden": true,
"tags": [
"<string>"
]
}
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}Upsert a tool's overlay
Merge-patch the overlay row for tool_name (create it if absent).
patch holds ONLY the fields the caller sent; each is applied over the current row (or
the empty defaults when none exists), absent fields unchanged. A blank
display_name is refused; a present-null clears; a present tags or
badges array replaces that set. An unknown folder_id is a loud 400.
curl --request PATCH \
--url https://api.example.com/api/tool-meta/tools/{tool_name} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"badges": [],
"display_name": "<string>",
"folder_id": "<string>",
"hidden": true,
"tags": []
}
'import requests
url = "https://api.example.com/api/tool-meta/tools/{tool_name}"
payload = {
"badges": [],
"display_name": "<string>",
"folder_id": "<string>",
"hidden": True,
"tags": []
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
badges: [],
display_name: '<string>',
folder_id: '<string>',
hidden: true,
tags: []
})
};
fetch('https://api.example.com/api/tool-meta/tools/{tool_name}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/tool-meta/tools/{tool_name}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'badges' => [
],
'display_name' => '<string>',
'folder_id' => '<string>',
'hidden' => true,
'tags' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/tool-meta/tools/{tool_name}"
payload := strings.NewReader("{\n \"badges\": [],\n \"display_name\": \"<string>\",\n \"folder_id\": \"<string>\",\n \"hidden\": true,\n \"tags\": []\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.example.com/api/tool-meta/tools/{tool_name}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"badges\": [],\n \"display_name\": \"<string>\",\n \"folder_id\": \"<string>\",\n \"hidden\": true,\n \"tags\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/tool-meta/tools/{tool_name}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"badges\": [],\n \"display_name\": \"<string>\",\n \"folder_id\": \"<string>\",\n \"hidden\": true,\n \"tags\": []\n}"
response = http.request(request)
puts response.read_body{
"data": {
"tool_name": "<string>",
"badges": [
"<string>"
],
"display_name": "<string>",
"folder_id": "<string>",
"hidden": true,
"tags": [
"<string>"
]
}
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}Authorizations
Path Parameters
Body
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.
Response
Success.
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.
Show child attributes
Show child attributes

