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

puts(tool)

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

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.cadenya.com/v1/workspaces/{workspaceId}/tool_sets/{toolSetId}/tools/{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>",
    "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>"
    }
  ]
}

GET

workspaces

{workspaceId}

tool_sets

{toolSetId}

tools

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

puts(tool)

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

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.cadenya.com/v1/workspaces/{workspaceId}/tool_sets/{toolSetId}/tools/{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>",
    "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>"
    }
  ]
}

Read one tool from a tool set. This is the full definition, where List tools gives you the row.

const tool = await client.toolSets.tools.retrieve(toolSetId, toolId, { workspaceId });

console.log(tool.spec.llmToolName);        // 'GenerateFake'
console.log(tool.spec.requiresApproval);   // false
console.log(tool.state);                   // 'STATE_AVAILABLE'

tool, err := client.ToolSets.Tools.Get(ctx, toolSetID, toolID,
	cadenya.ToolSetToolGetParams{WorkspaceID: cadenya.String(workspaceID)})
if err != nil {
	panic(err.Error())
}

fmt.Println(tool.Spec.LlmToolName)      // GenerateFake
fmt.Println(tool.Spec.RequiresApproval) // false
fmt.Println(tool.State)                 // STATE_AVAILABLE

tool = cadenya.tool_sets.tools.retrieve(tool_id, tool_set_id: tool_set_id, workspace_id: workspace_id)

puts(tool.spec.llm_tool_name)      # GenerateFake
puts(tool.spec.requires_approval)  # false
puts(tool.state)                   # STATE_AVAILABLE

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

What a tool holds

spec carries all five fields a tool is created with:

Field	Meaning
`description`	What the tool does, shown to the model
`parameters`	The JSON Schema the model fills in
`requiresApproval`	Whether a call parks for approval
`config`	The adapter binding, a union: `type` is `mcp`, `http`, `openapi`, or `bare`, with the payload under the matching key
`llmToolName`	The cleaned name the model calls (`issue_refund` becomes `IssueRefund`)

state is STATE_AVAILABLE or STATE_OMITTED. An omitted tool reads back fine here; it is hidden from agents, not from you.

`info.signature` keys the tool

info holds createdBy and a signature, a hash of the tool’s definition. A synced tool set enforces uniqueness on (tool_set_id, signature), so the signature is what makes a re-sync idempotent: an unchanged tool keeps its signature and is not duplicated.

tool.info.signature;  // 'a54745c24935...'

You rarely read it directly, but it is the field a sync conflict names when two tools collide.

External ID

Tools take an external ID scoped to their tool set, so pass the tool_... value or the external_id: form. A missing ID is a 404. Synced tools (MCP, OpenAPI) come in without one unless you set it; a hand-defined HTTP or bare tool is where you usually pick your own.

List tools

All tools in the set, filtered by name or state.

Omit a tool

Why a tool reads STATE_OMITTED.

Create a tool set

Where the five spec fields are set.

Approve a tool call

What requiresApproval triggers.

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"

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

​What a tool holds

​info.signature keys the tool

​External ID

​Related

List tools

Omit a tool

Create a tool set

Approve a tool call

Authorizations

Path Parameters

Response

What a tool holds

`info.signature` keys the tool

External ID

Related