Omit a tool - Cadenya

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 tool = await client.toolSets.tools.omit(
  'toolset_01HXKD2E5NQM3T9AYWCFNRMN74',
  'tool_01HXKD2E5NQM3T9AYWCFWVYY9K',
  { workspaceId: 'workspace_01HXKD2E5NQM3T9AYWCF133E3Q' },
);

console.log(tool.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 = client.tool_sets.tools.omit(
    tool_set_id="toolset_01HXKD2E5NQM3T9AYWCFNRMN74",
    id="tool_01HXKD2E5NQM3T9AYWCFWVYY9K",
    workspace_id="workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
)
print(tool.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"),
	)
	tool, err := client.ToolSets.Tools.Omit(
		context.TODO(),
		"toolset_01HXKD2E5NQM3T9AYWCFNRMN74",
		"tool_01HXKD2E5NQM3T9AYWCFWVYY9K",
		cadenya.ToolSetToolOmitParams{
			WorkspaceID: cadenya.String("workspace_01HXKD2E5NQM3T9AYWCF133E3Q"),
		},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", tool.Metadata)
}

require "cadenya"

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

tool = cadenya.tool_sets.tools.omit(
  "toolset_01HXKD2E5NQM3T9AYWCFNRMN74",
  "tool_01HXKD2E5NQM3T9AYWCFWVYY9K",
  workspace_id: "workspace_01HXKD2E5NQM3T9AYWCF133E3Q"
)

puts(tool)

cadenya tool-sets:tools omit \
  --api-key 'My API Key' \
  --workspace-id workspace_01HXKD2E5NQM3T9AYWCF133E3Q \
  --tool-set-id toolset_01HXKD2E5NQM3T9AYWCFNRMN74 \
  --id tool_01HXKD2E5NQM3T9AYWCFWVYY9K

curl --request POST \
  --url https://api.cadenya.com/v1/workspaces/{workspaceId}/tool_sets/{toolSetId}/tools/{id}:omit \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.cadenya.com/v1/workspaces/{workspaceId}/tool_sets/{toolSetId}/tools/{id}:omit",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    
  ]),
  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.post("https://api.cadenya.com/v1/workspaces/{workspaceId}/tool_sets/{toolSetId}/tools/{id}:omit")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .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>",
    "requiresApproval": true,
    "parameters": {},
    "config": {
      "type": "http",
      "http": {
        "path": "<string>",
        "query": "<string>",
        "headers": {},
        "requestBodyTemplate": "<string>",
        "requestBodyContentType": "<string>"
      }
    },
    "llmToolName": "<string>"
  },
  "info": {
    "toolSet": {
      "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"
    },
    "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>"
      }
    },
    "signature": "<string>"
  }
}

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

POST

workspaces

{workspaceId}

tool_sets

{toolSetId}

tools

{id}

:omit

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 tool = await client.toolSets.tools.omit(
  'toolset_01HXKD2E5NQM3T9AYWCFNRMN74',
  'tool_01HXKD2E5NQM3T9AYWCFWVYY9K',
  { workspaceId: 'workspace_01HXKD2E5NQM3T9AYWCF133E3Q' },
);

console.log(tool.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 = client.tool_sets.tools.omit(
    tool_set_id="toolset_01HXKD2E5NQM3T9AYWCFNRMN74",
    id="tool_01HXKD2E5NQM3T9AYWCFWVYY9K",
    workspace_id="workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
)
print(tool.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"),
	)
	tool, err := client.ToolSets.Tools.Omit(
		context.TODO(),
		"toolset_01HXKD2E5NQM3T9AYWCFNRMN74",
		"tool_01HXKD2E5NQM3T9AYWCFWVYY9K",
		cadenya.ToolSetToolOmitParams{
			WorkspaceID: cadenya.String("workspace_01HXKD2E5NQM3T9AYWCF133E3Q"),
		},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", tool.Metadata)
}

require "cadenya"

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

tool = cadenya.tool_sets.tools.omit(
  "toolset_01HXKD2E5NQM3T9AYWCFNRMN74",
  "tool_01HXKD2E5NQM3T9AYWCFWVYY9K",
  workspace_id: "workspace_01HXKD2E5NQM3T9AYWCF133E3Q"
)

puts(tool)

cadenya tool-sets:tools omit \
  --api-key 'My API Key' \
  --workspace-id workspace_01HXKD2E5NQM3T9AYWCF133E3Q \
  --tool-set-id toolset_01HXKD2E5NQM3T9AYWCFNRMN74 \
  --id tool_01HXKD2E5NQM3T9AYWCFWVYY9K

curl --request POST \
  --url https://api.cadenya.com/v1/workspaces/{workspaceId}/tool_sets/{toolSetId}/tools/{id}:omit \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.cadenya.com/v1/workspaces/{workspaceId}/tool_sets/{toolSetId}/tools/{id}:omit",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    
  ]),
  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.post("https://api.cadenya.com/v1/workspaces/{workspaceId}/tool_sets/{toolSetId}/tools/{id}:omit")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .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>",
    "requiresApproval": true,
    "parameters": {},
    "config": {
      "type": "http",
      "http": {
        "path": "<string>",
        "query": "<string>",
        "headers": {},
        "requestBodyTemplate": "<string>",
        "requestBodyContentType": "<string>"
      }
    },
    "llmToolName": "<string>"
  },
  "info": {
    "toolSet": {
      "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"
    },
    "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>"
      }
    },
    "signature": "<string>"
  }
}

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

:omit takes a tool out of circulation without deleting it. It moves to STATE_OMITTED, no agent sees it, and :restore brings it back.

await client.toolSets.tools.omit(toolSetId, toolId, { workspaceId });
// state: 'STATE_OMITTED'

// state: STATE_OMITTED
_, err := client.ToolSets.Tools.Omit(ctx, toolSetID, toolID,
	cadenya.ToolSetToolOmitParams{WorkspaceID: cadenya.String(workspaceID)})

cadenya.tool_sets.tools.omit(tool_id, tool_set_id: tool_set_id, workspace_id: workspace_id)
# state: STATE_OMITTED

curl -X POST "https://api.cadenya.com/v1/workspaces/${WORKSPACE_ID}/tool_sets/${TOOL_SET_ID}/tools/${TOOL_ID}:omit" \
  -H "Authorization: Bearer ${CADENYA_API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{}'

An omitted tool stays in the tool set and still shows in List tools with its omitted state. It is hidden from agents, not gone. An objective run against a set with GenerateFake omitted reports exactly this:

"I have exactly 2 tools:
 1. GenerateCurseWord
 2. GetFakerOptions"

Both :omit and :restore are idempotent and return 200.

Which mechanism, by tool set kind

Curation depends on where the tools come from.

Tool set	Tools defined by	Curate with
`bare`, `http`	You, by hand	`:omit` / `:restore`
`mcp`, `openapi`	The synced source	`excludeTools` / `includeTools` on the adapter

For a bare or HTTP tool set, you own every tool and nothing overwrites your changes, so :omit is the natural switch. For a synced tool set, the source is the authority. The adapter re-runs on every sync, so the durable way to hide a tool is a filter that the sync reapplies, not a one-time state change the sync discards.

On a synced tool set today, :omit still returns 200, but the next sync flips the tool back to STATE_AVAILABLE, silently. An OpenAPI source syncs hourly, so an omitted tool can return within the hour with no event to show it.Use excludeTools for anything on a synced set, especially a dangerous tool. Treat :omit there as a temporary mute at best.

Curate a synced set with a filter

An excludeTools filter is reapplied on every sync, so it holds. Measured across three syncs, the excluded tool stayed STATE_OMITTED every time, while a manually omitted one flipped back on the first.

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: 'GenerateFake', caseSensitive: false },
            },
          ],
        },
      },
    },
  },
});

Match on ATTRIBUTE_NAME, ATTRIBUTE_TITLE, or ATTRIBUTE_DESCRIPTION, with a matcher whose type is exact, contains, startsWith, endsWith, or regex. includeTools is the allowlist form: sync only the tools that match, and drop the rest.

Restore a tool

Move an omitted tool back to STATE_AVAILABLE.

Create a tool set

excludeTools and includeTools, the filters that survive a sync.

List tools

Where an omitted tool still shows, with its state.

Deny a tool call

Gate a tool at call time instead of hiding it.

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"

toolSetId

string

required

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

Example:

"toolset_01HXKD2E5NQM3T9AYWCFNRMN74"

string

required

Tool ID. Accepts the canonical tool_… form or the external_id: form.

Example:

"tool_01HXKD2E5NQM3T9AYWCFWVYY9K"

Body

application/json

Omit tool request

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. Output only. Use the :omit and :restore actions to transition; tool set syncs may also update it.

Available options:

STATE_UNSPECIFIED,

STATE_AVAILABLE,

STATE_OMITTED,

STATE_ARCHIVED

info

object

Show child attributes

​Which mechanism, by tool set kind

​Curate a synced set with a filter

​Related

Restore a tool

Create a tool set

List tools

Deny a tool call

Authorizations

Path Parameters

Body

Response

Which mechanism, by tool set kind

Curate a synced set with a filter

Related