BaseAgenticProvider

@composio/core


@composio/core / provider/BaseProvider / BaseAgenticProvider

Class: abstract BaseAgenticProvider<TToolCollection, TTool, TMcpResponse>

Defined in: ts/packages/core/src/provider/BaseProvider.ts:106

Base class for all agentic providers. This class is not meant to be used directly, but rather to be extended by concrete provider implementations.

Extends

  • BaseProvider<TMcpResponse>

Type Parameters

TToolCollection

TToolCollection

TTool

TTool

TMcpResponse

TMcpResponse = McpServerGetResponse

Constructors

Constructor

new BaseAgenticProvider<TToolCollection, TTool, TMcpResponse>(): BaseAgenticProvider<TToolCollection, TTool, TMcpResponse>

Returns

BaseAgenticProvider<TToolCollection, TTool, TMcpResponse>

Inherited from

BaseProvider<TMcpResponse>.constructor

Properties

_isAgentic

readonly _isAgentic: true = true

Defined in: ts/packages/core/src/provider/BaseProvider.ts:111

Internal

Whether the provider is agentic. This is set automatically set by the core SDK implementation for different provider types.

Overrides

BaseProvider._isAgentic


name

abstract readonly name: string

Defined in: ts/packages/core/src/provider/BaseProvider.ts:18

The name of the provider. Used to identify the provider in the telemetry.

Inherited from

BaseProvider.name

Methods

_setExecuteToolFn()

_setExecuteToolFn(executeToolFn): void

Defined in: ts/packages/core/src/provider/BaseProvider.ts:36

Internal

Set the function to execute a tool. This is set automatically and injected by the core SDK.

Parameters

executeToolFn

GlobalExecuteToolFn

Returns

void

Inherited from

BaseProvider._setExecuteToolFn


executeTool()

executeTool(toolSlug, body, modifers?): Promise<{ }>

Defined in: ts/packages/core/src/provider/BaseProvider.ts:50

Global function to execute a tool. This function is used by providerds to implement helper functions to execute tools. This is a 1:1 mapping of the execute method in the Tools class.

Parameters

toolSlug

string

The slug of the tool to execute.

body

The body of the tool execution.

modifers?

ExecuteToolModifiers

The modifiers of the tool execution.

Returns

Promise<{ }>

The result of the tool execution.

Inherited from

BaseProvider.executeTool


wrapMcpServerResponse()?

optional wrapMcpServerResponse(data): TMcpResponse

Defined in: ts/packages/core/src/provider/BaseProvider.ts:72

Optional method to transform MCP URL response into provider-specific format. Providers can override this method to define custom transformation logic for MCP server responses.

Parameters

data

McpUrlResponse

The MCP URL response data

Returns

TMcpResponse

Transformed response in provider-specific format, or undefined to use default transformation

Inherited from

BaseProvider.wrapMcpServerResponse


wrapTool()

abstract wrapTool(tool, executeTool): TTool

Defined in: ts/packages/core/src/provider/BaseProvider.ts:119

Wrap a tool in the provider specific format.

Parameters

tool

The tool to wrap.

executeTool

ExecuteToolFn

The function to execute the tool.

Returns

TTool

The wrapped tool.


wrapTools()

abstract wrapTools(tools, executeTool): TToolCollection

Defined in: ts/packages/core/src/provider/BaseProvider.ts:126

Wrap a list of tools in the provider specific format.

Parameters

tools

object[]

The tools to wrap.

executeTool

ExecuteToolFn

The function to execute the tool.

Returns

TToolCollection

The wrapped tools.