Update a tool set

JavaScript

import Cadenya from '@cadenya/cadenya';

const client = new Cadenya({
  apiKey: process.env['CADENYA_API_KEY'], // This is the default and can be omitted
});

const toolSet = await client.toolSets.update('toolset_01HXKD2E5NQM3T9AYWCFNRMN74', {
  workspaceId: 'workspace_01HXKD2E5NQM3T9AYWCF133E3Q',
});

console.log(toolSet.metadata);

import os
from cadenya import Cadenya

client = Cadenya(
    api_key=os.environ.get("CADENYA_API_KEY"),  # This is the default and can be omitted
)
tool_set = client.tool_sets.update(
    id="toolset_01HXKD2E5NQM3T9AYWCFNRMN74",
    workspace_id="workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
)
print(tool_set.metadata)

package main

import (
	"context"
	"fmt"
	"go.cadenya.com/cadenya-go"
	"go.cadenya.com/cadenya-go/option"
)

func main() {
	client := cadenya.NewClient(
		option.WithAPIKey("My API Key"),
	)
	toolSet, err := client.ToolSets.Update(
		context.TODO(),
		"toolset_01HXKD2E5NQM3T9AYWCFNRMN74",
		cadenya.ToolSetUpdateParams{
			WorkspaceID: cadenya.String("workspace_01HXKD2E5NQM3T9AYWCF133E3Q"),
		},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", toolSet.Metadata)
}

require "cadenya"

cadenya = Cadenya::Client.new(api_key: "My API Key")

tool_set = cadenya.tool_sets.update(
  "toolset_01HXKD2E5NQM3T9AYWCFNRMN74",
  workspace_id: "workspace_01HXKD2E5NQM3T9AYWCF133E3Q"
)

puts(tool_set)

curl --request PATCH \
  --url https://api.cadenya.com/v1/workspaces/{workspaceId}/tool_sets/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "spec": {
    "description": "<string>",
    "adapter": {
      "type": "mcp",
      "mcp": {
        "url": "<string>",
        "headers": {},
        "toolApprovals": {
          "type": "always",
          "always": true
        },
        "justInTime": {
          "enabled": true,
          "failObjectiveOnToolListError": true
        }
      }
    }
  },
  "updateMask": "<string>"
}
'

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.cadenya.com/v1/workspaces/{workspaceId}/tool_sets/{id}",
  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([
    'spec' => [
        'description' => '<string>',
        'adapter' => [
                'type' => 'mcp',
                'mcp' => [
                                'url' => '<string>',
                                'headers' => [
                                                                
                                ],
                                'toolApprovals' => [
                                                                'type' => 'always',
                                                                'always' => true
                                ],
                                'justInTime' => [
                                                                'enabled' => true,
                                                                'failObjectiveOnToolListError' => true
                                ]
                ]
        ]
    ],
    'updateMask' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.patch("https://api.cadenya.com/v1/workspaces/{workspaceId}/tool_sets/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"spec\": {\n    \"description\": \"<string>\",\n    \"adapter\": {\n      \"type\": \"mcp\",\n      \"mcp\": {\n        \"url\": \"<string>\",\n        \"headers\": {},\n        \"toolApprovals\": {\n          \"type\": \"always\",\n          \"always\": true\n        },\n        \"justInTime\": {\n          \"enabled\": true,\n          \"failObjectiveOnToolListError\": true\n        }\n      }\n    }\n  },\n  \"updateMask\": \"<string>\"\n}")
  .asString();

{
  "metadata": {
    "id": "<string>",
    "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
    "workspaceId": "workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
    "name": "<string>",
    "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08",
    "createdAt": "2023-11-07T05:31:56Z",
    "externalId": "<string>",
    "labels": {},
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "spec": {
    "description": "<string>",
    "adapter": {
      "type": "mcp",
      "mcp": {
        "url": "<string>",
        "headers": {},
        "includeTools": {
          "filters": [
            {
              "matcher": {
                "type": "exact",
                "exact": "<string>",
                "caseSensitive": true
              }
            }
          ]
        },
        "excludeTools": {
          "filters": [
            {
              "matcher": {
                "type": "exact",
                "exact": "<string>",
                "caseSensitive": true
              }
            }
          ]
        },
        "toolApprovals": {
          "type": "always",
          "always": true
        },
        "justInTime": {
          "enabled": true,
          "failObjectiveOnToolListError": true
        }
      }
    }
  },
  "info": {
    "toolCount": 123,
    "agentCount": 123,
    "lastSync": "2023-11-07T05:31:56Z",
    "createdBy": {
      "metadata": {
        "id": "<string>",
        "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
        "name": "<string>",
        "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08",
        "externalId": "<string>",
        "labels": {},
        "createdAt": "2023-11-07T05:31:56Z"
      },
      "spec": {
        "email": "<string>",
        "name": "<string>"
      }
    },
    "availableTools": 123,
    "omittedTools": 123
  }
}

{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "@type": "<string>"
    }
  ]
}

PATCH

workspaces

{workspaceId}

tool_sets

{id}

JavaScript

import Cadenya from '@cadenya/cadenya';

const client = new Cadenya({
  apiKey: process.env['CADENYA_API_KEY'], // This is the default and can be omitted
});

const toolSet = await client.toolSets.update('toolset_01HXKD2E5NQM3T9AYWCFNRMN74', {
  workspaceId: 'workspace_01HXKD2E5NQM3T9AYWCF133E3Q',
});

console.log(toolSet.metadata);

import os
from cadenya import Cadenya

client = Cadenya(
    api_key=os.environ.get("CADENYA_API_KEY"),  # This is the default and can be omitted
)
tool_set = client.tool_sets.update(
    id="toolset_01HXKD2E5NQM3T9AYWCFNRMN74",
    workspace_id="workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
)
print(tool_set.metadata)

package main

import (
	"context"
	"fmt"
	"go.cadenya.com/cadenya-go"
	"go.cadenya.com/cadenya-go/option"
)

func main() {
	client := cadenya.NewClient(
		option.WithAPIKey("My API Key"),
	)
	toolSet, err := client.ToolSets.Update(
		context.TODO(),
		"toolset_01HXKD2E5NQM3T9AYWCFNRMN74",
		cadenya.ToolSetUpdateParams{
			WorkspaceID: cadenya.String("workspace_01HXKD2E5NQM3T9AYWCF133E3Q"),
		},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", toolSet.Metadata)
}

require "cadenya"

cadenya = Cadenya::Client.new(api_key: "My API Key")

tool_set = cadenya.tool_sets.update(
  "toolset_01HXKD2E5NQM3T9AYWCFNRMN74",
  workspace_id: "workspace_01HXKD2E5NQM3T9AYWCF133E3Q"
)

puts(tool_set)

curl --request PATCH \
  --url https://api.cadenya.com/v1/workspaces/{workspaceId}/tool_sets/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "spec": {
    "description": "<string>",
    "adapter": {
      "type": "mcp",
      "mcp": {
        "url": "<string>",
        "headers": {},
        "toolApprovals": {
          "type": "always",
          "always": true
        },
        "justInTime": {
          "enabled": true,
          "failObjectiveOnToolListError": true
        }
      }
    }
  },
  "updateMask": "<string>"
}
'

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.cadenya.com/v1/workspaces/{workspaceId}/tool_sets/{id}",
  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([
    'spec' => [
        'description' => '<string>',
        'adapter' => [
                'type' => 'mcp',
                'mcp' => [
                                'url' => '<string>',
                                'headers' => [
                                                                
                                ],
                                'toolApprovals' => [
                                                                'type' => 'always',
                                                                'always' => true
                                ],
                                'justInTime' => [
                                                                'enabled' => true,
                                                                'failObjectiveOnToolListError' => true
                                ]
                ]
        ]
    ],
    'updateMask' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.patch("https://api.cadenya.com/v1/workspaces/{workspaceId}/tool_sets/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"spec\": {\n    \"description\": \"<string>\",\n    \"adapter\": {\n      \"type\": \"mcp\",\n      \"mcp\": {\n        \"url\": \"<string>\",\n        \"headers\": {},\n        \"toolApprovals\": {\n          \"type\": \"always\",\n          \"always\": true\n        },\n        \"justInTime\": {\n          \"enabled\": true,\n          \"failObjectiveOnToolListError\": true\n        }\n      }\n    }\n  },\n  \"updateMask\": \"<string>\"\n}")
  .asString();

{
  "metadata": {
    "id": "<string>",
    "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
    "workspaceId": "workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
    "name": "<string>",
    "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08",
    "createdAt": "2023-11-07T05:31:56Z",
    "externalId": "<string>",
    "labels": {},
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "spec": {
    "description": "<string>",
    "adapter": {
      "type": "mcp",
      "mcp": {
        "url": "<string>",
        "headers": {},
        "includeTools": {
          "filters": [
            {
              "matcher": {
                "type": "exact",
                "exact": "<string>",
                "caseSensitive": true
              }
            }
          ]
        },
        "excludeTools": {
          "filters": [
            {
              "matcher": {
                "type": "exact",
                "exact": "<string>",
                "caseSensitive": true
              }
            }
          ]
        },
        "toolApprovals": {
          "type": "always",
          "always": true
        },
        "justInTime": {
          "enabled": true,
          "failObjectiveOnToolListError": true
        }
      }
    }
  },
  "info": {
    "toolCount": 123,
    "agentCount": 123,
    "lastSync": "2023-11-07T05:31:56Z",
    "createdBy": {
      "metadata": {
        "id": "<string>",
        "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
        "name": "<string>",
        "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08",
        "externalId": "<string>",
        "labels": {},
        "createdAt": "2023-11-07T05:31:56Z"
      },
      "spec": {
        "email": "<string>",
        "name": "<string>"
      }
    },
    "availableTools": 123,
    "omittedTools": 123
  }
}

{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "@type": "<string>"
    }
  ]
}

Change a tool set after it exists: rename it, relabel it, or edit the adapter. Any update also triggers a re-sync, so this is how you refresh a set on demand.

await client.toolSets.update(toolSetId, {
  workspaceId,
  metadata: { name: 'Faker, renamed' },
});

_, err := client.ToolSets.Update(ctx, toolSetID,
	cadenya.ToolSetUpdateParams{
		WorkspaceID: cadenya.String(workspaceID),
		Metadata: shared.UpdateResourceMetadataParam{
			Name: cadenya.String("Faker, renamed"),
		},
	})

cadenya.tool_sets.update(
  tool_set_id,
  workspace_id: workspace_id,
  metadata: {name: "Faker, renamed"}
)

curl -X PATCH "https://api.cadenya.com/v1/workspaces/${WORKSPACE_ID}/tool_sets/${TOOL_SET_ID}" \
  -H "Authorization: Bearer ${CADENYA_API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{ "metadata": { "name": "Faker, renamed" } }'

The update merges

Send one field and the rest survive. A name-only patch keeps the adapter and the labels untouched:

// Before: adapter.mcp.url set, labels { env: 'test' }
await client.toolSets.update(toolSetId, { workspaceId, metadata: { name: 'renamed' } });
// After:  name changed, adapter and labels intact

So you do not have to resend the whole adapter to change a label, and omitting your filters does not wipe them.

Any update re-syncs

There is no sync endpoint. Cadenya syncs on create and on every update. So the way to force a refresh, pick up a provider’s new tools, or reapply a filter, is to PATCH the set, most naturally by resending the adapter.

await client.toolSets.update(toolSetId, {
  workspaceId,
  spec: {
    adapter: {
      type: 'mcp',
      mcp: {
        url: 'https://free.cadenya.com/faker-mcp',
        excludeTools: {
          operator: 'OPERATOR_AND',
          filters: [
            {
              attribute: 'ATTRIBUTE_NAME',
              matcher: { type: 'contains', contains: 'Curse', caseSensitive: false },
            },
          ],
        },
      },
    },
  },
});

Verified: seconds after this patch, the matching tool flips to STATE_OMITTED and the event log shows a fresh syncStarted / syncCompleted.

Every update re-syncs, not only adapter edits. Measured: a metadata-only patch (a rename) triggers a syncStarted / syncCompleted pair, exactly as an adapter patch does. So renaming a tool set re-hits its provider. Harmless for a healthy MCP server, but worth knowing if a sync is slow or rate-limited, or if the provider is flaky, a rename is not a free operation.

Send the adapter whole, with its type discriminator and the full variant payload. When you re-sync to reapply a filter, include the url (or baseUrl) alongside the filter, as above, rather than sending the filter alone.

Curate a synced set here, not on its tools

A synced tool set does not let you edit its individual tools (:omit is transient there). The durable curation is includeTools / excludeTools on the adapter, set through this endpoint. A filter is reapplied on every sync, so it sticks where a per-tool omit does not.

Create a tool set

The adapter kinds and the filter grammar in full.

List tool set events

The syncStarted an adapter edit produces.

Omit a tool

Why per-tool omit does not survive on a synced set.

Archive a tool set

Stop syncing entirely, reversibly.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

workspaceId

string

required

Workspace ID.

Example:

"workspace_01HXKD2E5NQM3T9AYWCF133E3Q"

string

required

Tool set ID. Accepts the canonical ts_… form or the external_id: form.

Example:

"toolset_01HXKD2E5NQM3T9AYWCFNRMN74"

Body

application/json

metadata

object

UpdateResourceMetadata contains the user-provided fields for updating a workspace-scoped resource. Read-only fields (id, account_id, workspace_id, profile_id, created_at) are excluded since they are set by the server.

Show child attributes

spec

object

Show child attributes

updateMask

string<field-mask>

Response

metadata

object

required

Standard metadata for persistent, named resources (e.g., agents, tools, prompts)

Show child attributes

spec

object

required

Show child attributes

state

enum<string>

required

read-only

The current lifecycle state of the tool set. Output only. Tool sets are created STATE_ACTIVE; use the :archive and :unarchive actions to transition between states.

Available options:

STATE_UNSPECIFIED,

STATE_ACTIVE,

STATE_ARCHIVED

info

object

Tool set information

Show child attributes

​The update merges

​Any update re-syncs

​Curate a synced set here, not on its tools

​Related

Create a tool set

List tool set events

Omit a tool

Archive a tool set

Authorizations

Path Parameters

Body

Response

The update merges

Any update re-syncs

Curate a synced set here, not on its tools

Related