Skip to content

Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.

Rename tool options

haxzie85b30c44e434
diff --git a/packages/core/src/composio.ts b/packages/core/src/composio.ts
index d59f2cbd9..ec1d58cb7 100644
--- a/packages/core/src/composio.ts
+++ b/packages/core/src/composio.ts
@@ -8,7 +8,7 @@ import { BaseComposioToolset } from './toolset/BaseToolset';
import { Telemetry } from './telemetry/Telemetry';
import { BaseTelemetryTransport } from './telemetry/TelemetryTransport';
import type { TelemetryMetadata } from './types/telemetry.types';
-import type { ToolsetModifierType } from './types/modifiers.types';
+import type { ToolsetOptions } from './types/modifiers.types';
import type { ToolListParams } from './types/tool.types';
import { getSDKConfig } from './utils/sdk';
import logger from './utils/logger';
@@ -196,12 +196,12 @@ export class Composio<TToolset extends BaseComposioToolset<unknown, unknown> = O
/**
* Fetch all the tools from Composio.
* @param {ToolListParams} params Parameters to fetch the tools.
- * @param {ToolsetModifierType<TToolset>} modifiers Modifiers to apply to the tools.
+ * @param {ToolsetOptions<TToolset>} modifiers Modifiers to apply to the tools.
* @returns {Promise<ReturnType<TToolset['getTools']>>} The tools from the toolset.
*/
getTools<T extends TToolset>(
params?: ToolListParams,
- modifiers?: ToolsetModifierType<T>
+ modifiers?: ToolsetOptions<T>
): Promise<ReturnType<T['getTools']>> {
return this.toolset.getTools(params, modifiers) as Promise<ReturnType<T['getTools']>>;
}
@@ -209,12 +209,12 @@ export class Composio<TToolset extends BaseComposioToolset<unknown, unknown> = O
/**
* Fetch a tool from Composio by its slug.
* @param {string} slug slug of the tool
- * @param {ToolsetModifierType<TToolset>} modifiers to be applied to the tool
+ * @param {ToolsetOptions<TToolset>} modifiers to be applied to the tool
* @returns {Promise<ReturnType<TToolset['getToolBySlug']>>} The tool from the toolset.
*/
getToolBySlug<T extends TToolset>(
slug: string,
- modifiers?: ToolsetModifierType<T>
+ modifiers?: ToolsetOptions<T>
): Promise<ReturnType<T['getToolBySlug']>> {
return this.toolset.getToolBySlug(slug, modifiers) as Promise<ReturnType<T['getToolBySlug']>>;
}
diff --git a/packages/core/src/index.ts b/packages/core/src/index.ts
index e15b4f549..c2af4a778 100644
--- a/packages/core/src/index.ts
+++ b/packages/core/src/index.ts
@@ -9,7 +9,9 @@ export { Tool, ToolListParams, ToolListParamsSchema } from './types/tool.types';
export { Toolset } from './types/toolset.types';
// Type exports
export type {
- ModifiersParams,
+ ExecuteToolModifiers,
+ AgenticToolOptions,
+ ToolOptions,
TransformToolSchemaModifier,
BeforeToolExecuteModifier,
AfterToolExecuteModifier,
diff --git a/packages/core/src/models/Tools.ts b/packages/core/src/models/Tools.ts
index 2881b8d93..fc8813f3b 100644
--- a/packages/core/src/models/Tools.ts
+++ b/packages/core/src/models/Tools.ts
@@ -21,7 +21,7 @@ import {
} from '@composio/client/resources/tools';
import { CustomTools } from './CustomTools';
import { CustomToolOptions } from '../types/customTool.types';
-import { ExecuteToolModifiersParams, TransformToolSchemaModifier } from '../types/modifiers.types';
+import { ExecuteToolModifiers, TransformToolSchemaModifier } from '../types/modifiers.types';
/**
* This class is used to manage tools in the Composio SDK.
@@ -142,7 +142,7 @@ export class Tools {
async execute(
slug: string,
body: ToolExecuteParams,
- modifiers?: ExecuteToolModifiersParams
+ modifiers?: ExecuteToolModifiers
): Promise<ToolExecuteResponse> {
// apply local modifiers if they are provided
if (modifiers && modifiers.beforeToolExecute) {
diff --git a/packages/core/src/toolset/BaseToolset.ts b/packages/core/src/toolset/BaseToolset.ts
index 7f1093caa..1bb5b51a1 100644
--- a/packages/core/src/toolset/BaseToolset.ts
+++ b/packages/core/src/toolset/BaseToolset.ts
@@ -1,7 +1,7 @@
import type { Toolset } from '../types/toolset.types';
import type { Tool, ToolListParams } from '../types/tool.types';
import type { Composio } from '../composio';
-import { ModifiersParams, SchemaModifiersParams } from '../types/modifiers.types';
+import { AgenticToolOptions, ToolOptions } from '../types/modifiers.types';
/**
* Base class for non-agentic toolsets that only support schema modifiers
@@ -18,12 +18,9 @@ export abstract class BaseNonAgenticToolset<TToolCollection, TTool>
this.composio = composio;
}
- abstract getTools(
- params?: ToolListParams,
- modifiers?: SchemaModifiersParams
- ): Promise<TToolCollection>;
+ abstract getTools(params?: ToolListParams, modifiers?: ToolOptions): Promise<TToolCollection>;
- abstract getToolBySlug(slug: string, modifiers?: SchemaModifiersParams): Promise<TTool>;
+ abstract getToolBySlug(slug: string, modifiers?: ToolOptions): Promise<TTool>;
abstract wrapTool(tool: Tool): TTool;
@@ -52,9 +49,12 @@ export abstract class BaseAgenticToolset<TToolCollection, TTool>
this.composio = composio;
}
- abstract getTools(params?: ToolListParams, modifiers?: ModifiersParams): Promise<TToolCollection>;
+ abstract getTools(
+ params?: ToolListParams,
+ modifiers?: AgenticToolOptions
+ ): Promise<TToolCollection>;
- abstract getToolBySlug(slug: string, modifiers?: ModifiersParams): Promise<TTool>;
+ abstract getToolBySlug(slug: string, modifiers?: AgenticToolOptions): Promise<TTool>;
abstract wrapTool(tool: Tool): TTool;
diff --git a/packages/core/src/toolset/ComposioToolset.ts b/packages/core/src/toolset/ComposioToolset.ts
index 681a4c85c..f90e55e2e 100644
--- a/packages/core/src/toolset/ComposioToolset.ts
+++ b/packages/core/src/toolset/ComposioToolset.ts
@@ -1,4 +1,4 @@
-import { SchemaModifiersParams } from '../types/modifiers.types';
+import { ToolOptions } from '../types/modifiers.types';
import { Tool, ToolListParams } from '../types/tool.types';
import { BaseNonAgenticToolset } from './BaseToolset';
@@ -28,8 +28,8 @@ export class ComposioToolset extends BaseNonAgenticToolset<Array<CustomTool>, Cu
return tools?.map(tool => this.wrapTool(tool as Tool)) ?? [];
}
- async getToolBySlug(slug: string, modifiers?: SchemaModifiersParams): Promise<CustomTool> {
- const tool = await this.getComposio().tools.getToolBySlug(slug, modifiers?.schema);
+ async getToolBySlug(slug: string, modifiers?: ToolOptions): Promise<CustomTool> {
+ const tool = await this.getComposio().tools.getToolBySlug(slug, modifiers?.modifyToolSchema);
return this.wrapTool(tool as Tool);
}
diff --git a/packages/core/src/toolset/OpenAIToolset.ts b/packages/core/src/toolset/OpenAIToolset.ts
index 4f0320be8..0dbc0bf10 100644
--- a/packages/core/src/toolset/OpenAIToolset.ts
+++ b/packages/core/src/toolset/OpenAIToolset.ts
@@ -10,9 +10,9 @@
import { OpenAI } from 'openai';
import { Stream } from 'openai/streaming';
import { BaseNonAgenticToolset } from './BaseToolset';
-import { Tool, ToolListParams } from '../types/tool.types';
+import { Tool, ToolExecuteParams, ToolListParams } from '../types/tool.types';
import logger from '../utils/logger';
-import { ExecuteToolModifiersParams, SchemaModifiersParams } from '../types/modifiers.types';
+import { ExecuteToolModifiers, ToolOptions } from '../types/modifiers.types';
export type OpenAiTool = OpenAI.ChatCompletionTool;
export type OpenAiToolCollection = Array<OpenAiTool>;
@@ -41,16 +41,13 @@ export class OpenAIToolset extends BaseNonAgenticToolset<OpenAiToolCollection, O
* @param modifiers - Optional modifiers to transform tool schemas
* @returns The tools.
*/
- async getTools(
- params?: ToolListParams,
- modifiers?: SchemaModifiersParams
- ): Promise<OpenAiToolCollection> {
- const tools = await this.getComposio()?.tools.getTools(params, modifiers?.schema);
+ async getTools(params?: ToolListParams, modifiers?: ToolOptions): Promise<OpenAiToolCollection> {
+ const tools = await this.getComposio()?.tools.getTools(params, modifiers?.modifyToolSchema);
return tools?.map(tool => this.wrapTool(tool as Tool)) ?? [];
}
- async getToolBySlug(slug: string, modifiers?: SchemaModifiersParams): Promise<OpenAiTool> {
- const tool = await this.getComposio().tools.getToolBySlug(slug, modifiers?.schema);
+ async getToolBySlug(slug: string, modifiers?: ToolOptions): Promise<OpenAiTool> {
+ const tool = await this.getComposio().tools.getToolBySlug(slug, modifiers?.modifyToolSchema);
return this.wrapTool(tool);
}
@@ -63,7 +60,7 @@ export class OpenAIToolset extends BaseNonAgenticToolset<OpenAiToolCollection, O
async executeToolCall(
tool: OpenAI.ChatCompletionMessageToolCall,
userId?: string,
- modifiers?: ExecuteToolModifiersParams
+ modifiers?: ExecuteToolModifiers
): Promise<string> {
const toolSchema = await this.getComposio().tools.getToolBySlug(tool.function.name);
const appSlug = toolSchema?.toolkit?.slug.toLowerCase();
@@ -71,9 +68,9 @@ export class OpenAIToolset extends BaseNonAgenticToolset<OpenAiToolCollection, O
throw new Error('App slug not found');
}
const connectedAccountId = this.getComposio().getConnectedAccountId(appSlug);
- const payload = {
- entity_id: userId ?? this.getComposio().userId,
- connected_account_id: connectedAccountId,
+ const payload: ToolExecuteParams = {
+ userId: userId ?? this.getComposio().userId,
+ connectedAccountId: connectedAccountId,
arguments: JSON.parse(tool.function.arguments),
};
const results = await this.getComposio().tools.execute(toolSchema.slug, payload, modifiers);
@@ -90,7 +87,7 @@ export class OpenAIToolset extends BaseNonAgenticToolset<OpenAiToolCollection, O
async handleToolCall(
chatCompletion: OpenAI.ChatCompletion,
userId?: string,
- modifiers?: ExecuteToolModifiersParams
+ modifiers?: ExecuteToolModifiers
) {
const outputs: string[] = [];
for (const message of chatCompletion.choices) {
@@ -111,7 +108,7 @@ export class OpenAIToolset extends BaseNonAgenticToolset<OpenAiToolCollection, O
async handleAssistantMessage(
run: OpenAI.Beta.Threads.Run,
userId?: string,
- modifiers?: ExecuteToolModifiersParams
+ modifiers?: ExecuteToolModifiers
) {
const tool_calls = run.required_action?.submit_tool_outputs?.tool_calls || [];
const tool_outputs: Array<OpenAI.Beta.Threads.Runs.RunSubmitToolOutputsParams.ToolOutput> =
@@ -151,7 +148,7 @@ export class OpenAIToolset extends BaseNonAgenticToolset<OpenAiToolCollection, O
runStream: Stream<OpenAI.Beta.Assistants.AssistantStreamEvent>,
thread: OpenAI.Beta.Threads.Thread,
userId?: string,
- modifiers?: ExecuteToolModifiersParams
+ modifiers?: ExecuteToolModifiers
) {
// @TODO: Log the run stream
const defaultUserId = this.getComposio()?.userId;
@@ -238,7 +235,7 @@ export class OpenAIToolset extends BaseNonAgenticToolset<OpenAiToolCollection, O
run: OpenAI.Beta.Threads.Run,
thread: OpenAI.Beta.Threads.Thread,
userId?: string,
- modifiers?: ExecuteToolModifiersParams
+ modifiers?: ExecuteToolModifiers
) {
const defaultUserId = this.getComposio()?.userId;
while (['queued', 'in_progress', 'requires_action'].includes(run.status)) {
diff --git a/packages/core/src/types/modifiers.types.ts b/packages/core/src/types/modifiers.types.ts
index 0e4b06ecb..b42c6ce4d 100644
--- a/packages/core/src/types/modifiers.types.ts
+++ b/packages/core/src/types/modifiers.types.ts
@@ -26,31 +26,34 @@ export type AfterToolExecuteModifier = (
export type TransformToolSchemaModifier = (toolSlug: string, toolSchema: Tool) => Tool;
/**
- * Modifiers for the toolset
- * This is used by Agentic toolsets
+ * Non Agentic tool options. These are used by Non-Agentic toolsets
*/
-export type ModifiersParams = {
- beforeToolExecute?: BeforeToolExecuteModifier;
- afterToolExecute?: AfterToolExecuteModifier;
- schema?: TransformToolSchemaModifier;
-};
-
-/**
- * Modifiers for the tool schema
- * This is used by Non-Agentic toolsets
- */
-export type SchemaModifiersParams = {
- schema?: TransformToolSchemaModifier;
+export type ToolOptions = {
+ /**
+ * Transform tool schema modifier
+ */
+ modifyToolSchema?: TransformToolSchemaModifier;
};
/**
* Modifiers for the tool execution
* This is used by execute call and handleToolCall of Non-Agentic toolsets
*/
-export type ExecuteToolModifiersParams = {
+export type ExecuteToolModifiers = {
+ /**
+ * Before tool execute modifier
+ */
beforeToolExecute?: BeforeToolExecuteModifier;
+ /**
+ * After tool execute modifier
+ */
afterToolExecute?: AfterToolExecuteModifier;
};
-export type ToolsetModifierType<T extends BaseComposioToolset<unknown, unknown>> =
- T extends BaseAgenticToolset<unknown, unknown> ? ModifiersParams : SchemaModifiersParams;
+/**
+ * Agentic tool options. These are used by Agentic toolsets
+ */
+export type AgenticToolOptions = ToolOptions & ExecuteToolModifiers;
+
+export type ToolsetOptions<T extends BaseComposioToolset<unknown, unknown>> =
+ T extends BaseAgenticToolset<unknown, unknown> ? AgenticToolOptions : ToolOptions;
diff --git a/packages/toolsets/cloudflare/src/index.ts b/packages/toolsets/cloudflare/src/index.ts
index 85c9badeb..5e714b680 100644
--- a/packages/toolsets/cloudflare/src/index.ts
+++ b/packages/toolsets/cloudflare/src/index.ts
@@ -10,11 +10,13 @@
* @module toolsets/cloudflare
*/
import { AiTextGenerationToolInput } from '@cloudflare/workers-types';
-import { BaseNonAgenticToolset, Tool, ToolListParams } from '@composio/core';
import {
- ExecuteToolModifiersParams,
- SchemaModifiersParams,
-} from 'packages/core/src/types/modifiers.types';
+ BaseNonAgenticToolset,
+ Tool,
+ ToolListParams,
+ ExecuteToolModifiers,
+ ToolOptions,
+} from '@composio/core';
type AiToolCollection = Record<string, AiTextGenerationToolInput>;
@@ -57,13 +59,13 @@ export class CloudflareToolset extends BaseNonAgenticToolset<
*/
override async getTools(
query?: ToolListParams,
- modifiers?: SchemaModifiersParams
+ modifiers?: ToolOptions
): Promise<AiToolCollection> {
if (!this.getComposio()) {
throw new Error('Client not set');
}
- const tools = await this.getComposio().tools.getTools(query, modifiers?.schema);
+ const tools = await this.getComposio().tools.getTools(query, modifiers?.modifyToolSchema);
return tools.reduce(
(tools, tool) => ({
...tools,
@@ -75,12 +77,12 @@ export class CloudflareToolset extends BaseNonAgenticToolset<
override async getToolBySlug(
slug: string,
- modifiers?: SchemaModifiersParams
+ modifiers?: ToolOptions
): Promise<AiTextGenerationToolInput> {
if (!this.getComposio()) {
throw new Error('Client not set');
}
- const tool = await this.getComposio().tools.getToolBySlug(slug, modifiers?.schema);
+ const tool = await this.getComposio().tools.getToolBySlug(slug, modifiers?.modifyToolSchema);
return this.wrapTool(tool);
}
@@ -93,7 +95,7 @@ export class CloudflareToolset extends BaseNonAgenticToolset<
async executeToolCall(
tool: { name: string; arguments: unknown },
userId?: string,
- modifiers?: ExecuteToolModifiersParams
+ modifiers?: ExecuteToolModifiers
): Promise<string> {
if (!this.getComposio()) {
throw new Error('Client not set');
diff --git a/packages/toolsets/langchain/src/index.ts b/packages/toolsets/langchain/src/index.ts
index 2eae4f0ce..0d8b06007 100644
--- a/packages/toolsets/langchain/src/index.ts
+++ b/packages/toolsets/langchain/src/index.ts
@@ -9,9 +9,14 @@
* @packageDocumentation
* @module toolsets/langchain
*/
-import { BaseAgenticToolset, jsonSchemaToModel, Tool, ToolListParams } from '@composio/core';
+import {
+ BaseAgenticToolset,
+ jsonSchemaToModel,
+ Tool,
+ ToolListParams,
+ AgenticToolOptions,
+} from '@composio/core';
import { DynamicStructuredTool } from '@langchain/core/tools';
-import { ModifiersParams } from 'packages/core/src/types/modifiers.types';
export type LangChainToolCollection = Array<DynamicStructuredTool>;
export class LangchainToolset extends BaseAgenticToolset<
@@ -24,7 +29,7 @@ export class LangchainToolset extends BaseAgenticToolset<
* @param tool - The tool to wrap.
* @returns The wrapped tool.
*/
- wrapTool(tool: Tool, modifiers?: ModifiersParams): DynamicStructuredTool {
+ wrapTool(tool: Tool, modifiers?: AgenticToolOptions): DynamicStructuredTool {
const toolName = tool.slug;
const description = tool.description;
const appName = tool.toolkit?.name?.toLowerCase();
@@ -68,17 +73,17 @@ export class LangchainToolset extends BaseAgenticToolset<
*/
override async getTools(
params?: ToolListParams,
- modifiers?: ModifiersParams
+ modifiers?: AgenticToolOptions
): Promise<LangChainToolCollection> {
- const tools = await this.getComposio()?.tools.getTools(params, modifiers?.schema);
+ const tools = await this.getComposio()?.tools.getTools(params, modifiers?.modifyToolSchema);
return tools?.map(tool => this.wrapTool(tool, modifiers)) ?? [];
}
override async getToolBySlug(
slug: string,
- modifiers?: ModifiersParams
+ modifiers?: AgenticToolOptions
): Promise<DynamicStructuredTool> {
- const tool = await this.getComposio()?.tools.getToolBySlug(slug, modifiers?.schema);
+ const tool = await this.getComposio()?.tools.getToolBySlug(slug, modifiers?.modifyToolSchema);
return this.wrapTool(tool as Tool, modifiers);
}
}
diff --git a/packages/toolsets/vercel/src/index.ts b/packages/toolsets/vercel/src/index.ts
index fcebcb793..4e42f0066 100644
--- a/packages/toolsets/vercel/src/index.ts
+++ b/packages/toolsets/vercel/src/index.ts
@@ -10,13 +10,15 @@
* @packageDocumentation
* @module toolsets/vercel
*/
-import { BaseAgenticToolset, Tool as ComposioTool, ToolListParams } from '@composio/core';
+import {
+ BaseAgenticToolset,
+ Tool as ComposioTool,
+ ToolListParams,
+ ExecuteToolModifiers,
+ AgenticToolOptions,
+} from '@composio/core';
import type { Tool as VercelTool } from 'ai';
import { jsonSchema, tool } from 'ai';
-import {
- ExecuteToolModifiersParams,
- ModifiersParams,
-} from 'packages/core/src/types/modifiers.types';
type VercelToolCollection = Record<string, VercelTool>;
export class VercelToolset extends BaseAgenticToolset<VercelToolCollection, VercelTool> {
@@ -30,7 +32,7 @@ export class VercelToolset extends BaseAgenticToolset<VercelToolCollection, Verc
*/
override async getTools(
params?: ToolListParams,
- modifiers?: ModifiersParams
+ modifiers?: AgenticToolOptions
): Promise<VercelToolCollection> {
if (!this.getComposio()) {
throw new Error('Client not initialized');
@@ -45,8 +47,8 @@ export class VercelToolset extends BaseAgenticToolset<VercelToolCollection, Verc
);
}
- override async getToolBySlug(slug: string, modifiers?: ModifiersParams): Promise<VercelTool> {
- const tool = await this.getComposio().tools.getToolBySlug(slug, modifiers?.schema);
+ override async getToolBySlug(slug: string, modifiers?: AgenticToolOptions): Promise<VercelTool> {
+ const tool = await this.getComposio().tools.getToolBySlug(slug, modifiers?.modifyToolSchema);
return this.wrapTool(tool as ComposioTool, modifiers);
}
@@ -59,7 +61,7 @@ export class VercelToolset extends BaseAgenticToolset<VercelToolCollection, Verc
async executeToolCall(
tool: { name: string; arguments: unknown },
userId?: string,
- modifiers?: ExecuteToolModifiersParams
+ modifiers?: ExecuteToolModifiers
): Promise<string> {
if (!this.getComposio()) {
throw new Error('Client not initialized');
@@ -82,7 +84,7 @@ export class VercelToolset extends BaseAgenticToolset<VercelToolCollection, Verc
return JSON.stringify(results);
}
- wrapTool(composioTool: ComposioTool, modifiers?: ExecuteToolModifiersParams): VercelTool {
+ wrapTool(composioTool: ComposioTool, modifiers?: ExecuteToolModifiers): VercelTool {
return tool({
description: composioTool.description,
parameters: jsonSchema(composioTool.inputParameters ?? {}),