Toggle a tool

Sets whether a tool is enabled. The parent service can still disable the tool at runtime even if the stored tool flag is true.

POST /tools/{serviceId}/{toolId}/enabled

Toggle a tool

cURL

curl --request POST \
  --url http://localhost:9371/tools/{serviceId}/{toolId}/enabled \
  --header 'Content-Type: application/json' \
  --data '
{
  "enabled": true
}
'

200

{
  "id": "<string>",
  "serviceId": "<string>",
  "enabled": true
}

Path Parameters

serviceId · string · required

Service identifier matching the installed manifest id.

Minimum string length: 1

toolId · string · required

Tool identifier exposed by the service manifest.

Minimum string length: 1

Body

application/json

Request body used to toggle a tool enabled state.

enabled · boolean · required

Desired enabled state for the tool.

Response

200

application/json

Updated tool enabled state.

Response returned after toggling a tool enabled state.

id · string · required

Identifier of the tool whose enabled state was updated.

Minimum string length: 1

serviceId · string · required

Identifier of the service that owns the tool.

Minimum string length: 1

enabled · boolean · required

The new enabled state stored for the tool.