Get a tool set - 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 toolSet = await client.toolSets.retrieve('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.retrieve(
    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.Get(
		context.TODO(),
		"toolset_01HXKD2E5NQM3T9AYWCFNRMN74",
		cadenya.ToolSetGetParams{
			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.retrieve(
  "toolset_01HXKD2E5NQM3T9AYWCFNRMN74",
  workspace_id: "workspace_01HXKD2E5NQM3T9AYWCF133E3Q"
)

puts(tool_set)

<?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 => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

{
  "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>"
    }
  ]
}

GET

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.retrieve('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.retrieve(
    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.Get(
		context.TODO(),
		"toolset_01HXKD2E5NQM3T9AYWCFNRMN74",
		cadenya.ToolSetGetParams{
			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.retrieve(
  "toolset_01HXKD2E5NQM3T9AYWCFNRMN74",
  workspace_id: "workspace_01HXKD2E5NQM3T9AYWCF133E3Q"
)

puts(tool_set)

<?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 => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

{
  "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>"
    }
  ]
}

Read one tool set. spec.adapter tells you what it points at, state whether it is active, and info how many tools it holds.

const toolSet = await client.toolSets.retrieve(toolSetId, { workspaceId });

console.log(toolSet.state);              // 'STATE_ACTIVE'
console.log(toolSet.spec.adapter?.type); // 'mcp'
console.log(toolSet.info.toolCount);     // 5

toolSet, err := client.ToolSets.Get(ctx, toolSetID,
	cadenya.ToolSetGetParams{WorkspaceID: cadenya.String(workspaceID)})
if err != nil {
	panic(err.Error())
}

fmt.Println(toolSet.State)          // STATE_ACTIVE
fmt.Println(toolSet.Info.ToolCount) // 5

tool_set = cadenya.tool_sets.retrieve(tool_set_id, workspace_id: workspace_id)

puts(tool_set.state)            # STATE_ACTIVE
puts(tool_set.info.tool_count)  # 5

curl "https://api.cadenya.com/v1/workspaces/${WORKSPACE_ID}/tool_sets/${TOOL_SET_ID}" \
  -H "Authorization: Bearer ${CADENYA_API_KEY}"

What the counts tell you

info returns on every read; includeInfo is a no-op on tool sets. Five fields, and the three counts are how you spot a problem without listing the tools:

Field	Meaning
`toolCount`	Tools currently synced
`availableTools`	Callable now
`omittedTools`	Hidden by a filter
`agentCount`	Intended as the assigning-variation count. Currently always `0`.
`createdBy`	Who made it

availableTools short of toolCount means tools are omitted.

info.lastSync is documented on the tool set, but it is omitted until a sync completes successfully. A set whose syncs have only ever failed has no lastSync, so read the event log to see what happened rather than inferring health from its absence.

The adapter is a union

spec.adapter carries a type of mcp, openapi, http, or bare, and the key matching type holds the payload. Switch on type to know the kind:

const adapter = toolSet.spec.adapter;
switch (adapter?.type) {
  case 'mcp':     console.log('MCP server:', adapter.mcp.url); break;
  case 'openapi': console.log('OpenAPI source:', adapter.openapi.type); break;
  case 'http':    console.log('HTTP base:', adapter.http.baseUrl); break;
  case 'bare':    console.log('bare, your code fulfills calls'); break;
}

A secret referenced in an adapter header comes back as its ${NAME} placeholder, never resolved, so a read never leaks a credential.

Fetch by your own ID

Tool sets take an external ID:

const toolSet = await client.toolSets.retrieve('external_id:faker', { workspaceId });

A missing ID is a 404.

List tools

The tools this set holds, with their states.

List tool set events

Whether the last sync landed, when lastSync cannot tell you.

Create a tool set

The four adapter kinds in full.

Archive a tool set

The reversible retirement, allowed even while assigned.

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"

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

​What the counts tell you

​The adapter is a union

​Fetch by your own ID

​Related

List tools

List tool set events

Create a tool set

Archive a tool set

Authorizations

Path Parameters

Response

What the counts tell you

The adapter is a union

Fetch by your own ID

Related