Tools API

Manage agent-bound tools and execute them via API tokens.

Overview

Tools are defined in Cognipeer Console and can be attached to agents. Use the SDK to list tools for an agent, execute a tool, or convert definitions to Agent SDK-compatible tool objects.

listAgentTools

Fetch all tools assigned to an agent (including toolsets).

import { ConsoleClient } from '@cognipeer/console-sdk';

const client = new ConsoleClient({ apiKey: process.env.COGNIPEER_API_KEY! });

const tools = await client.tools.listAgentTools('support-bot');
console.log(tools);

executeAgentTool

Execute a tool by key with arguments.

const result = await client.tools.executeAgentTool('support-bot', 'search_docs', {
  query: 'billing plans',
});

console.log(result);

toAgentTools

Convert the agent tool list into Agent SDK-compatible tool objects (ToolInterface).

import { createSmartAgent, fromLangchainModel } from '@cognipeer/agent-sdk';
import { ChatOpenAI } from '@langchain/openai';

const model = fromLangchainModel(new ChatOpenAI({ model: 'gpt-4o-mini' }));
const agentTools = await client.tools.toAgentTools('support-bot');

const agent = createSmartAgent({
  name: 'Support',
  model,
  tools: agentTools,
});

Types

interface AgentToolDefinition {
  key: string;
  name: string;
  description?: string;
  schema?: Record<string, unknown>;
  toolsetKey?: string | null;
  executionType?: string;
}

interface AgentToolAdapter {
  name: string;
  description?: string;
  schema?: Record<string, unknown>;
  invoke: (args: Record<string, unknown>) => Promise<unknown>;
}