List tool set events

JavaScript

import Cadenya from '@cadenya/cadenya';

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

// Automatically fetches more pages as needed.
for await (const toolSetEvent of client.toolSets.listEvents('toolset_01HXKD2E5NQM3T9AYWCFNRMN74', {
  workspaceId: 'workspace_01HXKD2E5NQM3T9AYWCF133E3Q',
})) {
  console.log(toolSetEvent.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
)
page = client.tool_sets.list_events(
    tool_set_id="toolset_01HXKD2E5NQM3T9AYWCFNRMN74",
    workspace_id="workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
)
page = page.items[0]
print(page.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"),
	)
	page, err := client.ToolSets.ListEvents(
		context.TODO(),
		"toolset_01HXKD2E5NQM3T9AYWCFNRMN74",
		cadenya.ToolSetListEventsParams{
			WorkspaceID: cadenya.String("workspace_01HXKD2E5NQM3T9AYWCF133E3Q"),
		},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", page)
}

require "cadenya"

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

page = cadenya.tool_sets.list_events(
  "toolset_01HXKD2E5NQM3T9AYWCFNRMN74",
  workspace_id: "workspace_01HXKD2E5NQM3T9AYWCF133E3Q"
)

puts(page)

<?php

$curl = curl_init();

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

{
  "items": [
    {
      "metadata": {
        "id": "<string>",
        "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
        "workspaceId": "workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
        "createdAt": "2023-11-07T05:31:56Z",
        "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08",
        "labels": {},
        "externalId": "<string>"
      },
      "toolSetId": "toolset_01HXKD2E5NQM3T9AYWCFNRMN74",
      "event": {
        "type": "syncStarted",
        "syncStarted": {
          "message": "<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>"
          }
        }
      }
    }
  ],
  "pagination": {
    "nextCursor": "<string>"
  }
}

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

GET

workspaces

{workspaceId}

tool_sets

{toolSetId}

events

JavaScript

import Cadenya from '@cadenya/cadenya';

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

// Automatically fetches more pages as needed.
for await (const toolSetEvent of client.toolSets.listEvents('toolset_01HXKD2E5NQM3T9AYWCFNRMN74', {
  workspaceId: 'workspace_01HXKD2E5NQM3T9AYWCF133E3Q',
})) {
  console.log(toolSetEvent.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
)
page = client.tool_sets.list_events(
    tool_set_id="toolset_01HXKD2E5NQM3T9AYWCFNRMN74",
    workspace_id="workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
)
page = page.items[0]
print(page.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"),
	)
	page, err := client.ToolSets.ListEvents(
		context.TODO(),
		"toolset_01HXKD2E5NQM3T9AYWCFNRMN74",
		cadenya.ToolSetListEventsParams{
			WorkspaceID: cadenya.String("workspace_01HXKD2E5NQM3T9AYWCF133E3Q"),
		},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", page)
}

require "cadenya"

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

page = cadenya.tool_sets.list_events(
  "toolset_01HXKD2E5NQM3T9AYWCFNRMN74",
  workspace_id: "workspace_01HXKD2E5NQM3T9AYWCF133E3Q"
)

puts(page)

<?php

$curl = curl_init();

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

{
  "items": [
    {
      "metadata": {
        "id": "<string>",
        "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
        "workspaceId": "workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
        "createdAt": "2023-11-07T05:31:56Z",
        "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08",
        "labels": {},
        "externalId": "<string>"
      },
      "toolSetId": "toolset_01HXKD2E5NQM3T9AYWCFNRMN74",
      "event": {
        "type": "syncStarted",
        "syncStarted": {
          "message": "<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>"
          }
        }
      }
    }
  ],
  "pagination": {
    "nextCursor": "<string>"
  }
}

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

A synced tool set discovers its tools in the background. There is no sync endpoint to call and no status field to poll. This event log is how you know a sync ran and how it went.

const events = await client.toolSets.listEvents(toolSetId, { workspaceId });

for await (const event of events) {
  console.log(event.event?.type, event.event?.type === 'syncCompleted' ? event.event.syncCompleted.toolsSynced : undefined);
}
// syncCompleted  3
// syncStarted    undefined

page, err := client.ToolSets.ListEvents(ctx, toolSetID,
	cadenya.ToolSetListEventsParams{WorkspaceID: cadenya.String(workspaceID)})
if err != nil {
	panic(err.Error())
}

for _, event := range page.Items {
	fmt.Println(event.Event.Type, event.Event.SyncCompleted.ToolsSynced)
}
// syncCompleted  3
// syncStarted    0

page = cadenya.tool_sets.list_events(tool_set_id, workspace_id: workspace_id)

page.auto_paging_each do |event|
  puts([event.event.type, event.event.sync_completed&.tools_synced].inspect)
end
# [:syncCompleted, 3]
# [:syncStarted, nil]

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

Events come back newest first. The most recent sync is the first row.

Three event types

Type	Payload	Means
`syncStarted`	`syncStarted`	A sync began
`syncCompleted`	`syncCompleted`	It finished. `toolsSynced` counts the tools written.
`syncFailed`	`syncFailed`	It failed. `message`, `errorType`, and `error` describe why.

The event is a discriminated union: type names the variant, and the key matching type carries the payload. A sync is a syncStarted followed by exactly one syncCompleted or syncFailed. To block a setup script until the tools exist, poll this log after creating the set and stop on the first terminal event newer than your create.

`syncCompleted` does not mean every tool synced

This is the part to handle. A syncCompleted carries a message when some tools failed even though the sync as a whole succeeded. toolsSynced counts what landed; the message lists what did not.

{ "type": "syncCompleted",
  "syncCompleted": {
    "toolsSynced": 3,
    "message": "Some tools could not be synced:\n- tool_...: constraint failed: ..." } }

So a green syncCompleted is not proof the whole provider synced. Read toolsSynced against the count you expect, and read message when they differ:

const events = await client.toolSets.listEvents(toolSetId, { workspaceId });
for await (const event of events) {
  if (event.event?.type === 'syncCompleted') {
    const done = event.event.syncCompleted;
    if (done.message) console.warn(`partial sync: ${done.toolsSynced} synced,`, done.message);
  }
  if (event.event?.type === 'syncCompleted' || event.event?.type === 'syncFailed') break; // first terminal event
}

Reading a failure

syncFailed carries three fields. message is the human-readable summary, errorType is a machine tag for grouping, and error holds the underlying detail:

if (event.event?.type === 'syncFailed') {
  const failed = event.event.syncFailed;
  failed.message;    // "Some tools could not be synced: ..."
  failed.errorType;  // a category tag, may be empty
  failed.error;      // the raw provider or database error
}

The common causes are a provider your workspace cannot reach, an MCP server that is down, an OpenAPI URL that returns something other than a spec, or a bad credential in an adapter header. A failed sync leaves the previously synced tools in place; the set does not empty itself because a refresh failed.

Cadence

You do not trigger a sync. Cadenya syncs when you create or update the adapter, and on its own cycle after that. An OpenAPI adapter fetched by URL re-syncs hourly, which is visible here as a syncStarted roughly every hour. info.lastSync on the tool set gives you the timestamp of the most recent successful sync without walking the log. It is omitted until a sync completes, so a set whose only syncs have failed has no lastSync. sortOrder, limit, and cursor page the history the usual way; the SDK iterator follows the cursor for you.

Create a tool set

What a sync discovers, and the filters it applies each time.

List tools

The tools a completed sync wrote.

List tool sets

info.lastSync and the live tool count.

Connect an MCP server

The hands-on path, from URL to a synced tool.

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"

Query Parameters

limit

integer<int32>

Maximum number of results to return

cursor

string

Pagination cursor from previous response

sortOrder

string

Sort order for results (asc or desc by creation time)

includeInfo

boolean

When set to true you may use more of your alloted API rate-limit

labels

string

Filters by metadata labels. Comma-separated key=value pairs, e.g. "env=prod,team=ai". A resource matches only if every pair matches exactly (AND semantics).

Response

items

object[]

Show child attributes

pagination

object

Page carries cursor-based pagination state. There is no total: the cursor walks the result set without ever counting it, and a count would cost a second query on every list.

Show child attributes

​Three event types

​syncCompleted does not mean every tool synced

​Reading a failure

​Cadence

​Related

Create a tool set

List tools

List tool sets

Connect an MCP server

Authorizations

Path Parameters

Query Parameters

Response

Three event types

`syncCompleted` does not mean every tool synced

Reading a failure

Cadence

Related