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 toolset to providers

haxzie17e607423a8a
diff --git a/README.md b/README.md
index 9da364112..7ae8b9228 100644
--- a/README.md
+++ b/README.md
@@ -9,11 +9,11 @@ composio/
├── packages/ # Main packages directory
│ ├── core/ # Core SDK package
│ │ └── core/ # Core SDK package
-│ ├── toolsets/ # Toolset implementations
-│ │ ├── openai/ # OpenAI toolset
-│ │ ├── vercel/ # Vercel AI toolset
-│ │ ├── langchain/ # LangChain toolset
-│ │ └── cloudflare/ # Cloudflare toolset
+│ ├── providers/ # Provider implementations
+│ │ ├── openai/ # OpenAI provider
+│ │ ├── vercel/ # Vercel AI provider
+│ │ ├── langchain/ # LangChain provider
+│ │ └── cloudflare/ # Cloudflare provider
│ └── wrappers/ # Runtime-specific wrappers
├── examples/ # Example implementations
│ ├── langchain/ # LangChain example
@@ -58,8 +58,8 @@ composio/
# Format code
pnpm format
- # Create a new toolset
- pnpm create:toolset <toolset-name> [--agentic]
+ # Create a new provider
+ pnpm create:provider <provider-name> [--agentic]
# Check peer dependencies
pnpm check:peer-deps
@@ -68,24 +68,24 @@ composio/
pnpm update:peer-deps
```
-## Creating a New Toolset
+## Creating a New Provider
-1. Use the create:toolset script:
+1. Use the create:provider script:
```bash
- pnpm create:toolset my-toolset [--agentic]
+ pnpm create:provider my-provider [--agentic]
```
-2. The script will create a new toolset in `packages/toolsets/my-toolset` with:
+2. The script will create a new provider in `packages/providers/my-provider` with:
- - Basic toolset implementation
+ - Basic provider implementation
- TypeScript configuration
- Package configuration
- README template
3. Implement the required methods in `src/index.ts`:
- - For non-agentic toolsets: `wrapTool` and `wrapTools`
- - For agentic toolsets: `wrapTool`, `wrapTools`, and execution handlers
+ - For non-agentic providers: `wrapTool` and `wrapTools`
+ - For agentic providers: `wrapTool`, `wrapTools`, and execution handlers
## Release Process
@@ -149,31 +149,31 @@ yarn add @composio/core
pnpm add @composio/core
```
-### Toolsets
+### Providers
```bash
-# Install OpenAI toolset (included in core)
+# Install OpenAI provider (included in core)
npm install @composio/openai
-# Install Vercel AI toolset
+# Install Vercel AI provider
npm install @composio/vercel
-# Install Langchain toolset
+# Install Langchain provider
npm install @composio/langchain
```
## Getting Started
-### Basic Usage with OpenAI Toolset
+### Basic Usage with OpenAI Provider
```typescript
import { Composio } from '@composio/core';
-import { OpenAIToolset } from '@composio/openai-toolset';
+import { OpenAIProvider } from '@composio/openai-provider';
const composio = new Composio({
apiKey: process.env.COMPOSIO_API_KEY,
- // OpenAIToolset is the default, so this is optional
- toolset: new OpenAIToolset(),
+ // OpenAIProvider is the default, so this is optional
+ provider: new OpenAIProvider(),
});
// Fetch a single tool
@@ -186,17 +186,17 @@ const tools = await composio.tools.get('user123', {
});
```
-## Using with a Toolset
+## Using with a Provider
-### Example with Vercel AI Toolset
+### Example with Vercel AI Provider
```typescript
import { Composio } from '@composio/core';
-import { VercelToolset } from '@composio/vercel-toolset';
+import { VercelProvider } from '@composio/vercel-provider';
const composio = new Composio({
apiKey: process.env.COMPOSIO_API_KEY,
- toolset: new VercelToolset(),
+ provider: new VercelProvider(),
});
// Fetch tools for Vercel AI SDK
@@ -238,7 +238,7 @@ const tool = await composio.tools.get('user123', 'HACKERNEWS_SEARCH_POSTS', {
### Execution Modifiers
-For agentic toolsets (like Vercel AI and Langchain), you can also modify tool execution behavior:
+For agentic providers (like Vercel AI and Langchain), you can also modify tool execution behavior:
```typescript
const tool = await composio.tools.get('user123', 'HACKERNEWS_SEARCH_POSTS', {
@@ -344,14 +344,14 @@ Composio supports various authentication schemes:
## Development
-### Creating Custom Toolsets
+### Creating Custom Providers
-You can create custom toolsets by extending either `BaseNonAgenticToolset` or `BaseAgenticToolset`:
+You can create custom providers by extending either `BaseNonAgenticProvider` or `BaseAgenticProvider`:
-#### Non-Agentic Toolset
+#### Non-Agentic Provider
```typescript
-import { BaseNonAgenticToolset } from '@composio/core';
+import { BaseNonAgenticProvider } from '@composio/core';
import type { Tool } from '@composio/core';
interface CustomTool {
@@ -359,8 +359,8 @@ interface CustomTool {
// ... custom tool properties
}
-export class CustomToolset extends BaseNonAgenticToolset<CustomTool[], CustomTool> {
- readonly name = 'custom-toolset';
+export class CustomProvider extends BaseNonAgenticProvider<CustomTool[], CustomTool> {
+ readonly name = 'custom-provider';
wrapTool = (tool: Tool): CustomTool => ({
name: tool.name,
@@ -371,14 +371,14 @@ export class CustomToolset extends BaseNonAgenticToolset<CustomTool[], CustomToo
}
```
-#### Agentic Toolset
+#### Agentic Provider
```typescript
-import { BaseAgenticToolset } from '@composio/core';
+import { BaseAgenticProvider } from '@composio/core';
import type { Tool, ToolExecuteParams, ToolExecuteResponse } from '@composio/core';
-export class CustomAgenticToolset extends BaseAgenticToolset<CustomTool[], CustomTool> {
- readonly name = 'custom-agentic-toolset';
+export class CustomAgenticProvider extends BaseAgenticProvider<CustomTool[], CustomTool> {
+ readonly name = 'custom-agentic-provider';
wrapTool = (tool: Tool): CustomTool => ({
name: tool.name,
@@ -407,14 +407,14 @@ export class CustomAgenticToolset extends BaseAgenticToolset<CustomTool[], Custo
}
```
-To quickly create a new toolset project, use the provided script:
+To quickly create a new provider project, use the provided script:
```bash
-# Create a non-agentic toolset
-pnpm create:toolset my-toolset
+# Create a non-agentic provider
+pnpm create:provider my-provider
-# Create an agentic toolset
-pnpm create:toolset my-toolset --agentic
+# Create an agentic provider
+pnpm create:provider my-provider --agentic
```
## Environment Variables
diff --git a/examples/connected-accounts/src/index.ts b/examples/connected-accounts/src/index.ts
index 7e3c32e6b..5cd140a50 100644
--- a/examples/connected-accounts/src/index.ts
+++ b/examples/connected-accounts/src/index.ts
@@ -1,7 +1,7 @@
import { AuthConfigTypes, AuthSchemeTypes, Composio } from '@composio/core';
// Initialize Composio
-// OpenAI Toolset is automatically installed and initialized
+// OpenAI Provider is automatically installed and initialized
const composio = new Composio({
apiKey: process.env.COMPOSIO_API_KEY,
});
diff --git a/examples/connected-accounts/src/toolkit-authorize.ts b/examples/connected-accounts/src/toolkit-authorize.ts
index 58dca6ee7..b81ec5f0e 100644
--- a/examples/connected-accounts/src/toolkit-authorize.ts
+++ b/examples/connected-accounts/src/toolkit-authorize.ts
@@ -1,7 +1,7 @@
import { Composio } from '@composio/core';
// Initialize Composio
-// OpenAI Toolset is automatically installed and initialized
+// OpenAI Provider is automatically installed and initialized
const composio = new Composio({
apiKey: process.env.COMPOSIO_API_KEY,
});
diff --git a/examples/langchain/src/index.ts b/examples/langchain/src/index.ts
index 5093a63fc..799930e78 100644
--- a/examples/langchain/src/index.ts
+++ b/examples/langchain/src/index.ts
@@ -3,11 +3,11 @@ import { HumanMessage, AIMessage } from '@langchain/core/messages';
import { ToolNode } from '@langchain/langgraph/prebuilt';
import { StateGraph, MessagesAnnotation } from '@langchain/langgraph';
import { Composio } from '@composio/core';
-import { LangchainToolset } from '@composio/langchain';
+import { LangchainProvider } from '@composio/langchain';
// initiate composio
const composio = new Composio({
apiKey: process.env.COMPOSIO_API_KEY,
- toolset: new LangchainToolset(),
+ provider: new LangchainProvider(),
});
// fetch the tool
diff --git a/examples/modifiers/README.md b/examples/modifiers/README.md
index 30d3fa303..08e1ab65a 100644
--- a/examples/modifiers/README.md
+++ b/examples/modifiers/README.md
@@ -19,27 +19,32 @@ This example demonstrates how to use the Composio SDK with Vercel's AI SDK to cr
## Getting Started
1. Clone the repository and navigate to the example directory:
+
```bash
cd examples/vercel
```
2. Install dependencies:
+
```bash
pnpm install
```
3. Copy the `.env.example` file to `.env` and fill in your API keys:
+
```bash
cp .env.example .env
```
4. Update the `.env` file with your credentials:
+
```env
COMPOSIO_API_KEY=your_composio_api_key
OPENAI_API_KEY=your_openai_api_key
```
5. Start the development server:
+
```bash
pnpm start
```
@@ -47,7 +52,8 @@ pnpm start
## How It Works
This example showcases how to:
-1. Initialize the Composio SDK with the Vercel toolset
+
+1. Initialize the Composio SDK with the Vercel provider
2. Use the HackerNews tool to fetch front page data
3. Generate AI responses using OpenAI's GPT-4
4. Handle tool calls and results in a chat-like interface
@@ -66,4 +72,4 @@ ISC
## Support
-For questions and support, please refer to the [Composio documentation](https://docs.composio.dev) or open an issue in the repository.
\ No newline at end of file
+For questions and support, please refer to the [Composio documentation](https://docs.composio.dev) or open an issue in the repository.
diff --git a/examples/modifiers/src/index.ts b/examples/modifiers/src/index.ts
index c64ac3950..df4d3c68a 100644
--- a/examples/modifiers/src/index.ts
+++ b/examples/modifiers/src/index.ts
@@ -1,8 +1,8 @@
import { Composio } from '@composio/core';
-import { VercelToolset } from '@composio/vercel';
+import { VercelProvider } from '@composio/vercel';
/**
- * Non agentic toolset
+ * Non agentic provider
*/
const composio = new Composio({
apiKey: process.env.COMPOSIO_API_KEY,
@@ -31,12 +31,12 @@ const tools = await composio.tools.get('default', 'HACKERNEWS_GET_USER', {
console.log(tools);
/**
- * Agentic toolset
+ * Agentic provider
*/
const vercel = new Composio({
apiKey: process.env.COMPOSIO_API_KEY,
// calling this provider now no? or what? or toolProvider or toolManager?
- toolset: new VercelToolset(),
+ provider: new VercelProvider(),
});
const agenticTools = await vercel.tools.get(
diff --git a/examples/openai/src/assistants.ts b/examples/openai/src/assistants.ts
index 32dbf3de4..0ff37869f 100644
--- a/examples/openai/src/assistants.ts
+++ b/examples/openai/src/assistants.ts
@@ -1,7 +1,7 @@
/**
* OpenAI Assistants with Composio Tool Example
*
- * This example demonstrates how to use the Composio OpenAIToolset with OpenAI Assistants API.
+ * This example demonstrates how to use the Composio OpenAIProvider with OpenAI Assistants API.
* It uses the HACKERNEWS_GET_USER tool to fetch information about a HackerNews user.
*/
import { Composio } from '@composio/core';
@@ -56,7 +56,7 @@ async function main() {
});
console.log('🔄 Waiting for assistant response and handling tool calls...');
- const completedRun = await composio.toolset.waitAndHandleAssistantToolCalls(
+ const completedRun = await composio.provider.waitAndHandleAssistantToolCalls(
'default',
openai,
run,
diff --git a/examples/openai/src/chat-completions.ts b/examples/openai/src/chat-completions.ts
index abb699662..ec87f8790 100644
--- a/examples/openai/src/chat-completions.ts
+++ b/examples/openai/src/chat-completions.ts
@@ -1,7 +1,7 @@
/**
* OpenAI Chat Completions with Composio Tool Example
*
- * This example demonstrates how to use the Composio OpenAIToolset with OpenAI chat completions API.
+ * This example demonstrates how to use the Composio OpenAIProvider with OpenAI chat completions API.
* It uses the HACKERNEWS_GET_USER tool to fetch information about a HackerNews user.
*/
import { Composio } from '@composio/core';
@@ -50,7 +50,7 @@ async function main() {
response.choices[0].message.tool_calls[0].function.name
);
- const toolResult = await composio.toolset.executeToolCall(
+ const toolResult = await composio.provider.executeToolCall(
'default',
response.choices[0].message.tool_calls[0],
{
diff --git a/examples/openai/src/index.ts b/examples/openai/src/index.ts
index 4216eedf0..97f15e2bd 100644
--- a/examples/openai/src/index.ts
+++ b/examples/openai/src/index.ts
@@ -7,7 +7,7 @@ const openai = new OpenAI({
/**
* Initialize Composio
- * OpenAI Toolset is automatically installed and initialized
+ * OpenAI Provider is automatically installed and initialized
*/
const composio = new Composio({
apiKey: process.env.COMPOSIO_API_KEY,
@@ -15,7 +15,7 @@ const composio = new Composio({
/**
* Get the tool by slug
- * This tool is automatically typed and wrapped with the OpenAI Toolset
+ * This tool is automatically typed and wrapped with the OpenAI Provider
*/
const tool = await composio.tools.get('default', 'HACKERNEWS_GET_USER');
/**
@@ -46,7 +46,7 @@ const response = await openai.chat.completions.create({
*/
if (response.choices[0].message.tool_calls) {
console.log(`✅ Calling tool ${response.choices[0].message.tool_calls[0].function.name}`);
- const result = await composio.toolset.handleToolCall('default', response);
+ const result = await composio.provider.handleToolCall('default', response);
const data = JSON.parse(result[0]);
console.log(data);
}
diff --git a/examples/openai/src/tools.ts b/examples/openai/src/tools.ts
index fcc06a76d..89c2f080b 100644
--- a/examples/openai/src/tools.ts
+++ b/examples/openai/src/tools.ts
@@ -28,6 +28,6 @@ const response = await openai.chat.completions.create({
tool_choice: 'auto',
});
-const toolCall = await composio.toolset.handleToolCall('default', response);
+const toolCall = await composio.provider.handleToolCall('default', response);
console.log(toolCall);
diff --git a/examples/toolkits/README.md b/examples/toolkits/README.md
index 30d3fa303..08e1ab65a 100644
--- a/examples/toolkits/README.md
+++ b/examples/toolkits/README.md
@@ -19,27 +19,32 @@ This example demonstrates how to use the Composio SDK with Vercel's AI SDK to cr
## Getting Started
1. Clone the repository and navigate to the example directory:
+
```bash
cd examples/vercel
```
2. Install dependencies:
+
```bash
pnpm install
```
3. Copy the `.env.example` file to `.env` and fill in your API keys:
+
```bash
cp .env.example .env
```
4. Update the `.env` file with your credentials:
+
```env
COMPOSIO_API_KEY=your_composio_api_key
OPENAI_API_KEY=your_openai_api_key
```
5. Start the development server:
+
```bash
pnpm start
```
@@ -47,7 +52,8 @@ pnpm start
## How It Works
This example showcases how to:
-1. Initialize the Composio SDK with the Vercel toolset
+
+1. Initialize the Composio SDK with the Vercel provider
2. Use the HackerNews tool to fetch front page data
3. Generate AI responses using OpenAI's GPT-4
4. Handle tool calls and results in a chat-like interface
@@ -66,4 +72,4 @@ ISC
## Support
-For questions and support, please refer to the [Composio documentation](https://docs.composio.dev) or open an issue in the repository.
\ No newline at end of file
+For questions and support, please refer to the [Composio documentation](https://docs.composio.dev) or open an issue in the repository.
diff --git a/examples/vercel/README.md b/examples/vercel/README.md
index 30d3fa303..08e1ab65a 100644
--- a/examples/vercel/README.md
+++ b/examples/vercel/README.md
@@ -19,27 +19,32 @@ This example demonstrates how to use the Composio SDK with Vercel's AI SDK to cr
## Getting Started
1. Clone the repository and navigate to the example directory:
+
```bash
cd examples/vercel
```
2. Install dependencies:
+
```bash
pnpm install
```
3. Copy the `.env.example` file to `.env` and fill in your API keys:
+
```bash
cp .env.example .env
```
4. Update the `.env` file with your credentials:
+
```env
COMPOSIO_API_KEY=your_composio_api_key
OPENAI_API_KEY=your_openai_api_key
```
5. Start the development server:
+
```bash
pnpm start
```
@@ -47,7 +52,8 @@ pnpm start
## How It Works
This example showcases how to:
-1. Initialize the Composio SDK with the Vercel toolset
+
+1. Initialize the Composio SDK with the Vercel provider
2. Use the HackerNews tool to fetch front page data
3. Generate AI responses using OpenAI's GPT-4
4. Handle tool calls and results in a chat-like interface
@@ -66,4 +72,4 @@ ISC
## Support
-For questions and support, please refer to the [Composio documentation](https://docs.composio.dev) or open an issue in the repository.
\ No newline at end of file
+For questions and support, please refer to the [Composio documentation](https://docs.composio.dev) or open an issue in the repository.
diff --git a/examples/vercel/src/index.ts b/examples/vercel/src/index.ts
index f7cd9f3dd..dd7a56419 100644
--- a/examples/vercel/src/index.ts
+++ b/examples/vercel/src/index.ts
@@ -1,17 +1,17 @@
import { Composio } from '@composio/core';
import { generateText } from 'ai';
import { openai } from '@ai-sdk/openai';
-import { VercelToolset } from '@composio/vercel';
+import { VercelProvider } from '@composio/vercel';
import dotenv from 'dotenv';
import { Message, MessageRoles } from './types';
dotenv.config();
/**
- * Initialize the Composio SDK with the Vercel toolset
+ * Initialize the Composio SDK with the Vercel provider
*/
const composio = new Composio({
apiKey: process.env.COMPOSIO_API_KEY,
- toolset: new VercelToolset(),
+ provider: new VercelProvider(),
});
/**
diff --git a/package.json b/package.json
index 7ceda6e3e..8e9313317 100644
--- a/package.json
+++ b/package.json
@@ -4,7 +4,7 @@
"description": "",
"workspaces": [
"packages/core",
- "packages/toolsets/*"
+ "packages/providers/*"
],
"scripts": {
"build": "turbo build",
@@ -13,7 +13,7 @@
"lint:fix": "eslint . --ext .ts,.tsx --fix",
"format": "prettier --write \"**/*.{ts,tsx,js,jsx,json,md}\"",
"prepare": "husky",
- "create:toolset": "bash scripts/create-toolset.sh",
+ "create:provider": "bash scripts/create-provider.sh",
"check:peer-deps": "tsx scripts/check-peer-deps.ts",
"update:peer-deps": "tsx scripts/update-peer-deps.ts",
"publish": "lerna publish --no-private",
diff --git a/packages/core/README.md b/packages/core/README.md
index 9096b4ef3..be2a23d28 100644
--- a/packages/core/README.md
+++ b/packages/core/README.md
@@ -23,16 +23,16 @@ pnpm add @composio/core
## Getting Started
-### Basic Usage with OpenAI Toolset
+### Basic Usage with OpenAI Provider
```typescript
import { Composio } from '@composio/core';
-import { OpenAIToolset } from '@composio/openai-toolset';
+import { OpenAIProvider } from '@composio/openai';
const composio = new Composio({
apiKey: process.env.COMPOSIO_API_KEY,
- // OpenAIToolset is the default, so this is optional
- toolset: new OpenAIToolset(),
+ // OpenAIProvider is the default, so this is optional
+ provider: new OpenAIProvider(),
});
// Fetch a single tool
@@ -55,7 +55,7 @@ interface ComposioConfig {
baseURL?: string; // Custom API base URL (optional)
allowTracking?: boolean; // Enable/disable telemetry (default: true)
allowTracing?: boolean; // Enable/disable tracing (default: true)
- toolset?: TToolset; // Custom toolset (default: OpenAIToolset)
+ provider?: TProvider; // Custom provider (default: OpenAIProvider)
telemetryTransport?: BaseTelemetryTransport; // Custom telemetry transport
}
```
@@ -87,7 +87,7 @@ const tool = await composio.tools.get('user123', 'HACKERNEWS_SEARCH_POSTS', {
### Execution Modifiers
-For agentic toolsets (like Vercel AI and Langchain), you can also modify tool execution behavior:
+For agentic providers (like Vercel AI and Langchain), you can also modify tool execution behavior:
```typescript
const tool = await composio.tools.get('user123', 'HACKERNEWS_SEARCH_POSTS', {
diff --git a/packages/core/src/composio.ts b/packages/core/src/composio.ts
index 0ee9a7f68..f8ce44c99 100644
--- a/packages/core/src/composio.ts
+++ b/packages/core/src/composio.ts
@@ -4,35 +4,36 @@ import { Toolkits } from './models/Toolkits';
import { Triggers } from './models/Triggers';
import { AuthConfigs } from './models/AuthConfigs';
import { ConnectedAccounts } from './models/ConnectedAccounts';
-import { BaseComposioToolset } from './toolset/BaseToolset';
+import { BaseComposioProvider } from './provider/BaseProvider';
import { Telemetry } from './telemetry/Telemetry';
import { BaseTelemetryTransport } from './telemetry/TelemetryTransport';
import type { TelemetryMetadata } from './types/telemetry.types';
-import type { ToolsetOptions } from './types/modifiers.types';
+import type { ProviderOptions } from './types/modifiers.types';
import type { ToolListParams } from './types/tool.types';
import { getSDKConfig } from './utils/sdk';
import logger from './utils/logger';
import { IS_DEVELOPMENT_OR_CI } from './utils/constants';
import { checkForLatestVersionFromNPM } from './utils/version';
-import { OpenAIToolset } from './toolset/OpenAIToolset';
+import { OpenAIProvider } from './provider/OpenAIProvider';
import { version } from '../package.json';
import { getRandomUUID } from './utils/uuid';
-export type ComposioConfig<TToolset extends BaseComposioToolset<unknown, unknown> = OpenAIToolset> =
- {
- apiKey?: string;
- baseURL?: string;
- allowTracking?: boolean;
- allowTracing?: boolean;
- toolset?: TToolset;
- telemetryTransport?: BaseTelemetryTransport;
- };
+export type ComposioConfig<
+ TProvider extends BaseComposioProvider<unknown, unknown> = OpenAIProvider,
+> = {
+ apiKey?: string;
+ baseURL?: string;
+ allowTracking?: boolean;
+ allowTracing?: boolean;
+ provider?: TProvider;
+ telemetryTransport?: BaseTelemetryTransport;
+};
/**
* This is the core class for Composio.
* It is used to initialize the Composio SDK and provide a global configuration.
*/
-export class Composio<TToolset extends BaseComposioToolset<unknown, unknown> = OpenAIToolset> {
+export class Composio<TProvider extends BaseComposioProvider<unknown, unknown> = OpenAIProvider> {
/**
* The Composio API client.
* @type {ComposioClient}
@@ -41,19 +42,19 @@ export class Composio<TToolset extends BaseComposioToolset<unknown, unknown> = O
/**
* The configuration for the Composio SDK.
- * @type {ComposioConfig<TToolset>}
+ * @type {ComposioConfig<TProvider>}
*/
- private config: ComposioConfig<TToolset>;
+ private config: ComposioConfig<TProvider>;
private telemetry: Telemetry | undefined;
/**
* Core models for Composio.
*/
- tools: Tools<unknown, unknown, TToolset>;
+ tools: Tools<unknown, unknown, TProvider>;
toolkits: Toolkits;
triggers: Triggers;
- toolset: TToolset;
+ provider: TProvider;
// auth configs
authConfigs: AuthConfigs;
createAuthConfig: AuthConfigs['create'];
@@ -68,9 +69,9 @@ export class Composio<TToolset extends BaseComposioToolset<unknown, unknown> = O
* @param {string} config.runtime The runtime for the Composio SDK.
* @param {boolean} config.allowTracking Whether to allow analytics / tracking. Defaults to true.
* @param {boolean} config.allowTracing Whether to allow tracing. Defaults to true.
- * @param {TToolset} config.toolset The toolset to use for this Composio instance.
+ * @param {TProvider} config.provider The provider to use for this Composio instance.
*/
- constructor(config: ComposioConfig<TToolset>) {
+ constructor(config: ComposioConfig<TProvider>) {
const { baseURL: baseURLParsed, apiKey: apiKeyParsed } = getSDKConfig(
config?.baseURL,
config?.apiKey
@@ -99,11 +100,11 @@ export class Composio<TToolset extends BaseComposioToolset<unknown, unknown> = O
};
/**
- * Set the default toolset, if not provided by the user.
+ * Set the default provider, if not provided by the user.
*/
- this.toolset = (config.toolset ?? new OpenAIToolset()) as TToolset;
- this.tools = new Tools(this.client, this.toolset);
- this.toolset._setExecuteToolFn(this.tools.execute);
+ this.provider = (config.provider ?? new OpenAIProvider()) as TProvider;
+ this.tools = new Tools(this.client, this.provider);
+ this.provider._setExecuteToolFn(this.tools.execute);
this.toolkits = new Toolkits(this.client);
this.triggers = new Triggers(this.client);
this.authConfigs = new AuthConfigs(this.client);
@@ -151,7 +152,7 @@ export class Composio<TToolset extends BaseComposioToolset<unknown, unknown> = O
this.telemetry.instrumentTelemetry(this.triggers);
this.telemetry.instrumentTelemetry(this.authConfigs);
this.telemetry.instrumentTelemetry(this.connectedAccounts);
- this.telemetry.instrumentTelemetry(this.toolset);
+ this.telemetry.instrumentTelemetry(this.provider);
}
/**
@@ -168,13 +169,13 @@ export class Composio<TToolset extends BaseComposioToolset<unknown, unknown> = O
/**
* Fetch all the tools from Composio.
* @param {ToolListParams} params Parameters to fetch the tools.
- * @param {ToolsetOptions<TToolset>} modifiers Modifiers to apply to the tools.
- * @returns {Promise<ReturnType<TToolset['getTools']>>} The tools from the toolset.
+ * @param {ProviderOptions<TProvider>} modifiers Modifiers to apply to the tools.
+ * @returns {Promise<ReturnType<TProvider['getTools']>>} The tools from the provider.
*/
- getTools<T extends TToolset>(
+ getTools<T extends TProvider>(
userId: string,
filters: ToolListParams,
- modifiers?: ToolsetOptions<T>
+ modifiers?: ProviderOptions<T>
): Promise<ReturnType<T['wrapTools']>> {
return this.tools.get(userId, filters, modifiers) as Promise<ReturnType<T['wrapTools']>>;
}
@@ -182,13 +183,13 @@ 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 {ToolsetOptions<TToolset>} modifiers to be applied to the tool
- * @returns {Promise<ReturnType<TToolset['getToolBySlug']>>} The tool from the toolset.
+ * @param {ProviderOptions<TProvider>} modifiers to be applied to the tool
+ * @returns {Promise<ReturnType<TProvider['getToolBySlug']>>} The tool from the provider.
*/
- getToolBySlug<T extends TToolset>(
+ getToolBySlug<T extends TProvider>(
userId: string,
slug: string,
- modifiers?: ToolsetOptions<T>
+ modifiers?: ProviderOptions<T>
): Promise<ReturnType<T['wrapTool']>> {
return this.tools.get(userId, slug, modifiers) as Promise<ReturnType<T['wrapTool']>>;
}
diff --git a/packages/core/src/errors/ToolErrors.ts b/packages/core/src/errors/ToolErrors.ts
index d2515bf6e..410a11ee1 100644
--- a/packages/core/src/errors/ToolErrors.ts
+++ b/packages/core/src/errors/ToolErrors.ts
@@ -10,16 +10,16 @@ export const ToolErrorCodes = {
GLOBAL_EXECUTE_TOOL_FN_NOT_SET: 'GLOBAL_EXECUTE_TOOL_FN_NOT_SET',
} as const;
-export class ComposioToolsetNotDefinedError extends ComposioError {
- constructor(message: string = 'Toolset not defined', meta: Record<string, unknown> = {}) {
+export class ComposioProviderNotDefinedError extends ComposioError {
+ constructor(message: string = 'Provider not defined', meta: Record<string, unknown> = {}) {
super(message, {
code: ToolErrorCodes.TOOLSET_NOT_DEFINED,
meta,
possibleFixes: [
- 'Ensure that the toolset is defined in the Composio project and passed into the tool instance',
+ 'Ensure that the provider is defined in the Composio project and passed into the tool instance',
],
});
- this.name = 'ComposioToolsetNotDefinedError';
+ this.name = 'ComposioProviderNotDefinedError';
}
}
@@ -97,7 +97,7 @@ export class ComposioGlobalExecuteToolFnNotSetError extends ComposioError {
super(message, {
code: ToolErrorCodes.GLOBAL_EXECUTE_TOOL_FN_NOT_SET,
meta,
- possibleFixes: ['Ensure the global execute tool function is set in the toolset'],
+ possibleFixes: ['Ensure the global execute tool function is set in the provider'],
});
this.name = 'ComposioGlobalExecuteToolFnNotSetError';
}
diff --git a/packages/core/src/index.ts b/packages/core/src/index.ts
index 4965578e5..9d4a582fc 100644
--- a/packages/core/src/index.ts
+++ b/packages/core/src/index.ts
@@ -1,14 +1,14 @@
// Core exports
export { Composio } from './composio';
-export { ComposioToolset } from './toolset/ComposioToolset';
-export { BaseAgenticToolset, BaseNonAgenticToolset } from './toolset/BaseToolset';
-export type { BaseComposioToolset } from './toolset/BaseToolset';
-export { OpenAIToolset } from './toolset/OpenAIToolset';
+export { ComposioProvider } from './provider/ComposioProvider';
+export { BaseAgenticProvider, BaseNonAgenticProvider } from './provider/BaseProvider';
+export type { BaseComposioProvider } from './provider/BaseProvider';
+export { OpenAIProvider } from './provider/OpenAIProvider';
export { BaseTelemetryTransport } from './telemetry/TelemetryTransport';
export { jsonSchemaToModel } from './utils/jsonSchema';
export { ToolListParamsSchema } from './types/tool.types';
export type { Tool, ToolListParams, ToolExecuteParams } from './types/tool.types';
-export type { Toolset, ExecuteToolFn, ExecuteToolFnOptions } from './types/toolset.types';
+export type { Provider, ExecuteToolFn, ExecuteToolFnOptions } from './types/provider.types';
export type { ExecuteMetadata } from './types/customTool.types';
export { AuthConfigTypes, AuthSchemeTypes } from './types/authConfigs.types';
export type { AuthConfigType, AuthSchemeType } from './types/authConfigs.types';
diff --git a/packages/core/src/models/Tools.ts b/packages/core/src/models/Tools.ts
index 200dc2c71..2f1fea8fa 100644
--- a/packages/core/src/models/Tools.ts
+++ b/packages/core/src/models/Tools.ts
@@ -23,18 +23,18 @@ import { CustomTools } from './CustomTools';
import { CustomToolOptions } from '../types/customTool.types';
import {
ExecuteToolModifiers,
- ToolsetOptions,
+ ProviderOptions,
TransformToolSchemaModifier,
} from '../types/modifiers.types';
-import { BaseComposioToolset } from '../toolset/BaseToolset';
+import { BaseComposioProvider } from '../provider/BaseProvider';
import logger from '../utils/logger';
-import { ExecuteToolFn } from '../types/toolset.types';
+import { ExecuteToolFn } from '../types/provider.types';
import {
ComposioCustomToolsNotInitializedError,
ComposioInvalidModifierError,
ComposioToolExecutionError,
ComposioToolNotFoundError,
- ComposioToolsetNotDefinedError,
+ ComposioProviderNotDefinedError,
} from '../errors/ToolErrors';
import { ValidationError } from '../errors/ValidationError';
@@ -45,23 +45,23 @@ import { ValidationError } from '../errors/ValidationError';
export class Tools<
TToolCollection,
TTool,
- TToolset extends BaseComposioToolset<TToolCollection, TTool>,
+ TProvider extends BaseComposioProvider<TToolCollection, TTool>,
> {
private client: ComposioClient;
private readonly customTools: CustomTools;
- private toolset: TToolset;
+ private provider: TProvider;
- constructor(client: ComposioClient, toolset: TToolset) {
+ constructor(client: ComposioClient, provider: TProvider) {
if (!client) {
throw new Error('ComposioClient is required');
}
- if (!toolset) {
- throw new ComposioToolsetNotDefinedError('Toolset not passed into Tools instance');
+ if (!provider) {
+ throw new ComposioProviderNotDefinedError('Provider not passed into Tools instance');
}
this.client = client;
this.customTools = new CustomTools(client);
- this.toolset = toolset;
+ this.provider = provider;
// Bind methods that use customTools to ensure correct 'this' context
this.execute = this.execute.bind(this);
@@ -200,7 +200,7 @@ export class Tools<
/**
* Lists all tools available in the Composio SDK as well as custom tools.
- * This method fetches the tools from the Composio API and wraps them using the toolset.
+ * This method fetches the tools from the Composio API and wraps them using the provider.
* @returns {ToolList} List of tools
*/
async getComposioTools(
@@ -307,10 +307,10 @@ export class Tools<
* const tool = await composio.tools.get('default', 'github');
* ```
*/
- async get<T extends TToolset>(
+ async get<T extends TProvider>(
userId: string,
slug: string,
- options?: ToolsetOptions<TToolset>
+ options?: ProviderOptions<TProvider>
): Promise<ReturnType<T['wrapTool']>>;
/**
@@ -327,10 +327,10 @@ export class Tools<
* });
* ```
*/
- async get<T extends TToolset>(
+ async get<T extends TProvider>(
userId: string,
filters: ToolListParams,
- options?: ToolsetOptions<TToolset>
+ options?: ProviderOptions<TProvider>
): Promise<ReturnType<T['wrapTools']>>;
/**
@@ -343,18 +343,18 @@ export class Tools<
async get(
userId: string,
arg2: ToolListParams | string,
- options?: ToolsetOptions<TToolset>
+ options?: ProviderOptions<TProvider>
): Promise<TTool | TToolCollection> {
// create the execute tool function
const executeToolFn = this.createExecuteToolFn(userId, options as ExecuteToolModifiers);
// if the first argument is a string, get a single tool
if (typeof arg2 === 'string') {
const tool = await this.getComposioToolBySlug(userId, arg2, options?.modifyToolSchema);
- return this.toolset.wrapTool(tool, executeToolFn) as TTool;
+ return this.provider.wrapTool(tool, executeToolFn) as TTool;
} else {
// if the first argument is an object, get a list of tools
const tools = await this.getComposioTools(userId, arg2, options?.modifyToolSchema);
- return this.toolset.wrapTools(tools, executeToolFn) as TToolCollection;
+ return this.provider.wrapTools(tools, executeToolFn) as TToolCollection;
}
}
diff --git a/packages/core/src/toolset/BaseToolset.ts b/packages/core/src/provider/BaseProvider.ts
similarity index 75%
rename from packages/core/src/toolset/BaseToolset.ts
rename to packages/core/src/provider/BaseProvider.ts
index 9595eda54..36bba8dbf 100644
--- a/packages/core/src/toolset/BaseToolset.ts
+++ b/packages/core/src/provider/BaseProvider.ts
@@ -1,24 +1,24 @@
import { ComposioGlobalExecuteToolFnNotSetError } from '../errors/ToolErrors';
import { ExecuteToolModifiers } from '../types/modifiers.types';
import type { Tool, ToolExecuteParams, ToolExecuteResponse } from '../types/tool.types';
-import { ExecuteToolFn, GlobalExecuteToolFn } from '../types/toolset.types';
+import { ExecuteToolFn, GlobalExecuteToolFn } from '../types/provider.types';
/**
* @internal
* Base class for all toolsets.
- * This class is not meant to be used directly, but rather to be extended by different toolset implementations.
+ * This class is not meant to be used directly, but rather to be extended by different provider implementations.
*/
-abstract class BaseToolset {
+abstract class BaseProvider {
/**
* @public
- * The name of the toolset.
- * Used to identify the toolset in the telemetry.
+ * The name of the provider.
+ * Used to identify the provider in the telemetry.
*/
abstract readonly name: string;
/**
* @internal
- * Whether the toolset is agentic.
- * This is set automatically set by the core SDK implementation for different toolset types.
+ * Whether the provider is agentic.
+ * This is set automatically set by the core SDK implementation for different provider types.
*/
abstract readonly _isAgentic: boolean;
/**
@@ -39,7 +39,7 @@ abstract class BaseToolset {
/**
* @public
* Gloabl function to execute a tool.
- * This function is used by toolset providers to implement helper functions to execute tools.
+ * This function is used by provider providers to implement helper functions to execute tools.
* This is a 1:1 mapping of the `execute` method in the `Tools` class.
* @param {string} toolSlug - The slug of the tool to execute.
* @param {Record<string, unknown>} input - The input to the tool.
@@ -60,9 +60,9 @@ abstract class BaseToolset {
/**
* @public
* Base class for all non-agentic toolsets.
- * This class is not meant to be used directly, but rather to be extended by concrete toolset implementations.
+ * This class is not meant to be used directly, but rather to be extended by concrete provider implementations.
*/
-export abstract class BaseNonAgenticToolset<TToolCollection, TTool> extends BaseToolset {
+export abstract class BaseNonAgenticProvider<TToolCollection, TTool> extends BaseProvider {
override readonly _isAgentic = false;
/**
@@ -82,9 +82,9 @@ export abstract class BaseNonAgenticToolset<TToolCollection, TTool> extends Base
/**
* @public
* Base class for all agentic toolsets.
- * This class is not meant to be used directly, but rather to be extended by concrete toolset implementations.
+ * This class is not meant to be used directly, but rather to be extended by concrete provider implementations.
*/
-export abstract class BaseAgenticToolset<TToolCollection, TTool> extends BaseToolset {
+export abstract class BaseAgenticProvider<TToolCollection, TTool> extends BaseProvider {
override readonly _isAgentic = true;
/**
@@ -104,8 +104,8 @@ export abstract class BaseAgenticToolset<TToolCollection, TTool> extends BaseToo
/**
* @internal
* Base type for all toolsets.
- * This type is used to infer the type of the toolset from the toolset implementation.
+ * This type is used to infer the type of the provider from the provider implementation.
*/
-export type BaseComposioToolset<TToolCollection, TTool> =
- | BaseNonAgenticToolset<TToolCollection, TTool>
- | BaseAgenticToolset<TToolCollection, TTool>;
+export type BaseComposioProvider<TToolCollection, TTool> =
+ | BaseNonAgenticProvider<TToolCollection, TTool>
+ | BaseAgenticProvider<TToolCollection, TTool>;
diff --git a/packages/core/src/provider/ComposioProvider.ts b/packages/core/src/provider/ComposioProvider.ts
new file mode 100644
index 000000000..c77f84a65
--- /dev/null
+++ b/packages/core/src/provider/ComposioProvider.ts
@@ -0,0 +1,24 @@
+import { Tool } from '../types/tool.types';
+import { BaseNonAgenticProvider } from './BaseProvider';
+
+/**
+ * This is a default provider implementation for Composio.
+ * This class is used as a default provider for Composio, if the user does not provide a provider.
+ *
+ * This class shouldn't be used directly or to be extended.
+ */
+
+interface CustomTool {
+ name: string;
+}
+export class ComposioProvider extends BaseNonAgenticProvider<Array<CustomTool>, CustomTool> {
+ readonly name = 'ComposioProvider';
+
+ wrapTool = (tool: Tool): CustomTool => {
+ return tool as CustomTool;
+ };
+
+ wrapTools(tools: Tool[]): CustomTool[] {
+ return tools.map(tool => this.wrapTool(tool));
+ }
+}
diff --git a/packages/core/src/toolset/OpenAIToolset.ts b/packages/core/src/provider/OpenAIProvider.ts
similarity index 95%
rename from packages/core/src/toolset/OpenAIToolset.ts
rename to packages/core/src/provider/OpenAIProvider.ts
index b9d10ec6c..873f7376f 100644
--- a/packages/core/src/toolset/OpenAIToolset.ts
+++ b/packages/core/src/provider/OpenAIProvider.ts
@@ -4,24 +4,24 @@
* Author: Musthaq Ahamad <[email protected]>
* Legacy Reference: https://github.com/ComposioHQ/composio/blob/master/js/src/toolsets/openai.ts
*
- * This is a default toolset for Composio SDK.
+ * This is a default provider for Composio SDK.
* This will be shipped with the SDK and users don't need to install it separately.
*/
import { OpenAI } from 'openai';
import { Stream } from 'openai/streaming';
-import { BaseNonAgenticToolset } from './BaseToolset';
+import { BaseNonAgenticProvider } from './BaseProvider';
import { Tool, ToolExecuteParams } from '../types/tool.types';
import logger from '../utils/logger';
import { ExecuteToolModifiers } from '../types/modifiers.types';
-import { ExecuteToolFnOptions } from '../types/toolset.types';
+import { ExecuteToolFnOptions } from '../types/provider.types';
export type OpenAiTool = OpenAI.ChatCompletionTool;
export type OpenAiToolCollection = Array<OpenAiTool>;
-export class OpenAIToolset extends BaseNonAgenticToolset<OpenAiToolCollection, OpenAiTool> {
+export class OpenAIProvider extends BaseNonAgenticProvider<OpenAiToolCollection, OpenAiTool> {
readonly name = 'openai';
/**
- * Absract method to wrap a tool in the toolset.
- * This method is implemented by the toolset.
+ * Absract method to wrap a tool in the provider.
+ * This method is implemented by the provider.
* @param tool - The tool to wrap.
* @returns The wrapped tool.
*/
diff --git a/packages/core/src/toolset/ComposioToolset.ts b/packages/core/src/toolset/ComposioToolset.ts
deleted file mode 100644
index cd6ebd9d2..000000000
--- a/packages/core/src/toolset/ComposioToolset.ts
+++ /dev/null
@@ -1,24 +0,0 @@
-import { Tool } from '../types/tool.types';
-import { BaseNonAgenticToolset } from './BaseToolset';
-
-/**
- * This is a default toolset implementation for Composio.
- * This class is used as a default toolset for Composio, if the user does not provide a toolset.
- *
- * This class shouldn't be used directly or to be extended.
- */
-
-interface CustomTool {
- name: string;
-}
-export class ComposioToolset extends BaseNonAgenticToolset<Array<CustomTool>, CustomTool> {
- readonly name = 'ComposioToolset';
-
- wrapTool = (tool: Tool): CustomTool => {
- return tool as CustomTool;
- };
-
- wrapTools(tools: Tool[]): CustomTool[] {
- return tools.map(tool => this.wrapTool(tool));
- }
-}
diff --git a/packages/core/src/types/modifiers.types.ts b/packages/core/src/types/modifiers.types.ts
index 32549abb9..9259cc7c8 100644
--- a/packages/core/src/types/modifiers.types.ts
+++ b/packages/core/src/types/modifiers.types.ts
@@ -1,4 +1,4 @@
-import { BaseAgenticToolset, BaseComposioToolset } from '../toolset/BaseToolset';
+import { BaseAgenticProvider, BaseComposioProvider } from '../provider/BaseProvider';
import { ToolExecuteParams, ToolExecuteResponse, Tool } from './tool.types';
/**
@@ -61,5 +61,5 @@ export type ExecuteToolModifiers = {
*/
export type AgenticToolOptions = ToolOptions & ExecuteToolModifiers;
-export type ToolsetOptions<T extends BaseComposioToolset<unknown, unknown>> =
- T extends BaseAgenticToolset<unknown, unknown> ? AgenticToolOptions : ToolOptions;
+export type ProviderOptions<T extends BaseComposioProvider<unknown, unknown>> =
+ T extends BaseAgenticProvider<unknown, unknown> ? AgenticToolOptions : ToolOptions;
diff --git a/packages/core/src/types/toolset.types.ts b/packages/core/src/types/provider.types.ts
similarity index 64%
rename from packages/core/src/types/toolset.types.ts
rename to packages/core/src/types/provider.types.ts
index 9cbc6e535..19c24e416 100644
--- a/packages/core/src/types/toolset.types.ts
+++ b/packages/core/src/types/provider.types.ts
@@ -8,11 +8,11 @@ import {
} from './tool.types';
/**
- * Base toolset implementation, which needs to be implemented by the extended class.
- * This class is used to create a base toolset by implementing this class.
- * This class also extends InstrumentedInstance, so that the telemetry can be instrumented for the toolset.
+ * Base provider implementation, which needs to be implemented by the extended class.
+ * This class is used to create a base provider by implementing this class.
+ * This class also extends InstrumentedInstance, so that the telemetry can be instrumented for the provider.
*/
-export interface Toolset<TTool, TToolCollection> {
+export interface Provider<TTool, TToolCollection> {
wrapTool: (tool: Tool) => TTool;
getTools: (params?: ToolListParams) => Promise<TToolCollection>;
}
@@ -23,8 +23,8 @@ export type ExecuteToolFnOptions = {
};
/**
- * This type is used to infer the wrapped tool type from the toolset.
- * It checks if the toolset has a method `_wrapTool` and infers the return type.
+ * This type is used to infer the wrapped tool type from the provider.
+ * It checks if the provider has a method `_wrapTool` and infers the return type.
*/
export type ExecuteToolFn = (
toolSlug: string,
diff --git a/packages/core/test/toolset/openai-toolset.test.ts b/packages/core/test/provider/openai-provider.test.ts
similarity index 90%
rename from packages/core/test/toolset/openai-toolset.test.ts
rename to packages/core/test/provider/openai-provider.test.ts
index e106adbc8..4e15dc110 100644
--- a/packages/core/test/toolset/openai-toolset.test.ts
+++ b/packages/core/test/provider/openai-provider.test.ts
@@ -1,5 +1,5 @@
import { describe, it, expect, vi, beforeEach } from 'vitest';
-import { OpenAIToolset } from '../../src/toolset/OpenAIToolset';
+import { OpenAIProvider } from '../../src/provider/OpenAIProvider';
import { Tool } from '../../src/types/tool.types';
import { OpenAI } from 'openai';
import { Stream } from 'openai/streaming';
@@ -19,18 +19,18 @@ vi.mock('openai/streaming', () => {
};
});
-describe('OpenAIToolset', () => {
- let toolset: OpenAIToolset;
+describe('OpenAIProvider', () => {
+ let provider: OpenAIProvider;
let mockTool: Tool;
let mockExecuteToolFn: any;
// Sample tool data
beforeEach(() => {
- toolset = new OpenAIToolset();
+ provider = new OpenAIProvider();
// Mock the global execute tool function
mockExecuteToolFn = vi.fn().mockResolvedValue({ result: 'success' });
- toolset._setExecuteToolFn(mockExecuteToolFn);
+ provider._setExecuteToolFn(mockExecuteToolFn);
// Use the transformed tool mock from existing test utilities
mockTool = {
@@ -41,19 +41,19 @@ describe('OpenAIToolset', () => {
describe('name property', () => {
it('should have the correct name', () => {
- expect(toolset.name).toBe('openai');
+ expect(provider.name).toBe('openai');
});
});
describe('_isAgentic property', () => {
it('should be non-agentic', () => {
- expect(toolset._isAgentic).toBe(false);
+ expect(provider._isAgentic).toBe(false);
});
});
describe('wrapTool', () => {
it('should wrap a tool in OpenAI function format', () => {
- const wrapped = toolset.wrapTool(mockTool);
+ const wrapped = provider.wrapTool(mockTool);
expect(wrapped).toEqual({
type: 'function',
@@ -71,7 +71,7 @@ describe('OpenAIToolset', () => {
const anotherTool = { ...mockTool, slug: 'another-tool' };
const tools = [mockTool, anotherTool];
- const wrapped = toolset.wrapTools(tools);
+ const wrapped = provider.wrapTools(tools);
expect(wrapped).toHaveLength(2);
expect(wrapped[0].function.name).toBe(mockTool.slug);
@@ -91,7 +91,7 @@ describe('OpenAIToolset', () => {
},
} as OpenAI.ChatCompletionMessageToolCall;
- const result = await toolset.executeToolCall(userId, toolCall);
+ const result = await provider.executeToolCall(userId, toolCall);
expect(mockExecuteToolFn).toHaveBeenCalledWith(
'test-tool',
@@ -137,7 +137,7 @@ describe('OpenAIToolset', () => {
}),
};
- await toolset.executeToolCall(userId, toolCall, options, modifiers);
+ await provider.executeToolCall(userId, toolCall, options, modifiers);
expect(mockExecuteToolFn).toHaveBeenCalledWith(
'test-tool',
@@ -188,10 +188,10 @@ describe('OpenAIToolset', () => {
},
} as OpenAI.ChatCompletion;
- const executeToolCallSpy = vi.spyOn(toolset, 'executeToolCall');
+ const executeToolCallSpy = vi.spyOn(provider, 'executeToolCall');
executeToolCallSpy.mockResolvedValue(JSON.stringify({ result: 'success' }));
- const results = await toolset.handleToolCall(userId, chatCompletion);
+ const results = await provider.handleToolCall(userId, chatCompletion);
expect(executeToolCallSpy).toHaveBeenCalledWith(
userId,
@@ -238,10 +238,10 @@ describe('OpenAIToolset', () => {
},
} as OpenAI.ChatCompletion;
- const executeToolCallSpy = vi.spyOn(toolset, 'executeToolCall');
+ const executeToolCallSpy = vi.spyOn(provider, 'executeToolCall');
executeToolCallSpy.mockResolvedValue(JSON.stringify({ result: 'success' }));
- const results = await toolset.handleToolCall(userId, chatCompletion);
+ const results = await provider.handleToolCall(userId, chatCompletion);
expect(executeToolCallSpy).toHaveBeenCalledTimes(1);
expect(results).toEqual([JSON.stringify({ result: 'success' })]);
@@ -276,10 +276,10 @@ describe('OpenAIToolset', () => {
},
} as unknown as OpenAI.Beta.Threads.Run;
- const executeToolCallSpy = vi.spyOn(toolset, 'executeToolCall');
+ const executeToolCallSpy = vi.spyOn(provider, 'executeToolCall');
executeToolCallSpy.mockResolvedValue(JSON.stringify({ result: 'success' }));
- const toolOutputs = await toolset.handleAssistantMessage(userId, run);
+ const toolOutputs = await provider.handleAssistantMessage(userId, run);
expect(executeToolCallSpy).toHaveBeenCalledWith(
userId,
@@ -307,9 +307,9 @@ describe('OpenAIToolset', () => {
assistant_id: 'asst-123',
} as unknown as OpenAI.Beta.Threads.Run;
- const executeToolCallSpy = vi.spyOn(toolset, 'executeToolCall');
+ const executeToolCallSpy = vi.spyOn(provider, 'executeToolCall');
- const toolOutputs = await toolset.handleAssistantMessage(userId, run);
+ const toolOutputs = await provider.handleAssistantMessage(userId, run);
expect(executeToolCallSpy).not.toHaveBeenCalled();
expect(toolOutputs).toEqual([]);
@@ -385,7 +385,7 @@ describe('OpenAIToolset', () => {
} as unknown as OpenAI.Beta.Threads.Thread;
// Mock the handleAssistantMessage method
- const handleAssistantMessageSpy = vi.spyOn(toolset, 'handleAssistantMessage');
+ const handleAssistantMessageSpy = vi.spyOn(provider, 'handleAssistantMessage');
handleAssistantMessageSpy.mockResolvedValue([
{
tool_call_id: 'call-123',
@@ -401,7 +401,7 @@ describe('OpenAIToolset', () => {
.mockResolvedValue(completedRun);
// Test the method
- const result = await toolset.waitAndHandleAssistantToolCalls(
+ const result = await provider.waitAndHandleAssistantToolCalls(
userId,
client,
initialRun,
@@ -508,7 +508,7 @@ describe('OpenAIToolset', () => {
} as unknown as OpenAI.Beta.Threads.Run;
// Mock the handleAssistantMessage method
- const handleAssistantMessageSpy = vi.spyOn(toolset, 'handleAssistantMessage');
+ const handleAssistantMessageSpy = vi.spyOn(provider, 'handleAssistantMessage');
handleAssistantMessageSpy.mockResolvedValue([
{
tool_call_id: 'call-123',
@@ -522,7 +522,7 @@ describe('OpenAIToolset', () => {
// Collect the yielded events
const collectedEvents: any[] = [];
- for await (const event of toolset.waitAndHandleAssistantStreamToolCalls(
+ for await (const event of provider.waitAndHandleAssistantStreamToolCalls(
userId,
client,
mockStream,
diff --git a/packages/core/test/toolset/toolset.test.ts b/packages/core/test/provider/provider.test.ts
similarity index 73%
rename from packages/core/test/toolset/toolset.test.ts
rename to packages/core/test/provider/provider.test.ts
index 8941c8c50..acbbbf4e9 100644
--- a/packages/core/test/toolset/toolset.test.ts
+++ b/packages/core/test/provider/provider.test.ts
@@ -1,12 +1,12 @@
import { describe, it, expect, vi, beforeEach } from 'vitest';
-import { BaseAgenticToolset, BaseNonAgenticToolset } from '../../src/toolset/BaseToolset';
+import { BaseAgenticProvider, BaseNonAgenticProvider } from '../../src/provider/BaseProvider';
import { Tool, ToolExecuteParams, ToolExecuteResponse } from '../../src/types/tool.types';
-import { ExecuteToolFn } from '../../src/types/toolset.types';
+import { ExecuteToolFn } from '../../src/types/provider.types';
import { ComposioGlobalExecuteToolFnNotSetError } from '../../src/errors/ToolErrors';
// Mock implementations of the abstract classes for testing
-class MockNonAgenticToolset extends BaseNonAgenticToolset<string[], string> {
- readonly name = 'MockNonAgenticToolset';
+class MockNonAgenticProvider extends BaseNonAgenticProvider<string[], string> {
+ readonly name = 'MockNonAgenticProvider';
wrapTool = vi.fn((tool: Tool): string => {
return `wrapped-non-agentic-tool:${tool.slug}`;
@@ -17,8 +17,8 @@ class MockNonAgenticToolset extends BaseNonAgenticToolset<string[], string> {
});
}
-class MockAgenticToolset extends BaseAgenticToolset<string[], string> {
- readonly name = 'MockAgenticToolset';
+class MockAgenticProvider extends BaseAgenticProvider<string[], string> {
+ readonly name = 'MockAgenticProvider';
wrapTool = vi.fn((tool: Tool, executeTool: ExecuteToolFn): string => {
return `wrapped-agentic-tool:${tool.slug}`;
@@ -29,13 +29,13 @@ class MockAgenticToolset extends BaseAgenticToolset<string[], string> {
});
}
-describe('BaseToolset', () => {
- describe('BaseNonAgenticToolset', () => {
- let nonAgenticToolset: MockNonAgenticToolset;
+describe('BaseProvider', () => {
+ describe('BaseNonAgenticProvider', () => {
+ let nonAgenticProvider: MockNonAgenticProvider;
beforeEach(() => {
- nonAgenticToolset = new MockNonAgenticToolset();
- nonAgenticToolset._setExecuteToolFn(
+ nonAgenticProvider = new MockNonAgenticProvider();
+ nonAgenticProvider._setExecuteToolFn(
vi.fn().mockResolvedValue({
data: { result: 'success' },
error: null,
@@ -46,11 +46,11 @@ describe('BaseToolset', () => {
});
it('should have _isAgentic property set to false', () => {
- expect(nonAgenticToolset._isAgentic).toBe(false);
+ expect(nonAgenticProvider._isAgentic).toBe(false);
});
it('should have the correct name', () => {
- expect(nonAgenticToolset.name).toBe('MockNonAgenticToolset');
+ expect(nonAgenticProvider.name).toBe('MockNonAgenticProvider');
});
it('should wrap a single tool correctly', () => {
@@ -61,9 +61,9 @@ describe('BaseToolset', () => {
tags: [],
};
- const wrapped = nonAgenticToolset.wrapTool(mockTool);
+ const wrapped = nonAgenticProvider.wrapTool(mockTool);
- expect(nonAgenticToolset.wrapTool).toHaveBeenCalledWith(mockTool);
+ expect(nonAgenticProvider.wrapTool).toHaveBeenCalledWith(mockTool);
expect(wrapped).toBe('wrapped-non-agentic-tool:test-tool');
});
@@ -83,9 +83,9 @@ describe('BaseToolset', () => {
},
];
- const wrapped = nonAgenticToolset.wrapTools(mockTools);
+ const wrapped = nonAgenticProvider.wrapTools(mockTools);
- expect(nonAgenticToolset.wrapTools).toHaveBeenCalledWith(mockTools);
+ expect(nonAgenticProvider.wrapTools).toHaveBeenCalledWith(mockTools);
expect(wrapped).toEqual([
'wrapped-non-agentic-tool:tool-1',
'wrapped-non-agentic-tool:tool-2',
@@ -101,7 +101,7 @@ describe('BaseToolset', () => {
});
// Set the execute function
- nonAgenticToolset._setExecuteToolFn(mockGlobalExecute);
+ nonAgenticProvider._setExecuteToolFn(mockGlobalExecute);
// Execute a tool
const toolSlug = 'test-tool';
@@ -114,7 +114,7 @@ describe('BaseToolset', () => {
afterToolExecute: vi.fn(x => x),
};
- const result = await nonAgenticToolset.executeTool(toolSlug, toolParams, modifiers);
+ const result = await nonAgenticProvider.executeTool(toolSlug, toolParams, modifiers);
// Verify the global execute function was called with the correct parameters
expect(mockGlobalExecute).toHaveBeenCalledWith(toolSlug, toolParams, modifiers);
@@ -126,13 +126,13 @@ describe('BaseToolset', () => {
});
});
- describe('BaseAgenticToolset', () => {
- let agenticToolset: MockAgenticToolset;
+ describe('BaseAgenticProvider', () => {
+ let agenticProvider: MockAgenticProvider;
let mockExecuteTool: ExecuteToolFn;
beforeEach(() => {
- agenticToolset = new MockAgenticToolset();
- agenticToolset._setExecuteToolFn(
+ agenticProvider = new MockAgenticProvider();
+ agenticProvider._setExecuteToolFn(
vi.fn().mockResolvedValue({
data: { result: 'success' },
error: null,
@@ -148,11 +148,11 @@ describe('BaseToolset', () => {
});
it('should have _isAgentic property set to true', () => {
- expect(agenticToolset._isAgentic).toBe(true);
+ expect(agenticProvider._isAgentic).toBe(true);
});
it('should have the correct name', () => {
- expect(agenticToolset.name).toBe('MockAgenticToolset');
+ expect(agenticProvider.name).toBe('MockAgenticProvider');
});
it('should wrap a single tool correctly with execute function', () => {
@@ -163,9 +163,9 @@ describe('BaseToolset', () => {
tags: [],
};
- const wrapped = agenticToolset.wrapTool(mockTool, mockExecuteTool);
+ const wrapped = agenticProvider.wrapTool(mockTool, mockExecuteTool);
- expect(agenticToolset.wrapTool).toHaveBeenCalledWith(mockTool, mockExecuteTool);
+ expect(agenticProvider.wrapTool).toHaveBeenCalledWith(mockTool, mockExecuteTool);
expect(wrapped).toBe('wrapped-agentic-tool:test-tool');
});
@@ -185,9 +185,9 @@ describe('BaseToolset', () => {
},
];
- const wrapped = agenticToolset.wrapTools(mockTools, mockExecuteTool);
+ const wrapped = agenticProvider.wrapTools(mockTools, mockExecuteTool);
- expect(agenticToolset.wrapTools).toHaveBeenCalledWith(mockTools, mockExecuteTool);
+ expect(agenticProvider.wrapTools).toHaveBeenCalledWith(mockTools, mockExecuteTool);
expect(wrapped).toEqual(['wrapped-agentic-tool:tool-1', 'wrapped-agentic-tool:tool-2']);
});
@@ -200,7 +200,7 @@ describe('BaseToolset', () => {
});
// Set the execute function
- agenticToolset._setExecuteToolFn(mockGlobalExecute);
+ agenticProvider._setExecuteToolFn(mockGlobalExecute);
// Execute a tool
const toolSlug = 'test-tool';
@@ -213,7 +213,7 @@ describe('BaseToolset', () => {
afterToolExecute: vi.fn(x => x),
};
- const result = await agenticToolset.executeTool(toolSlug, toolParams, modifiers);
+ const result = await agenticProvider.executeTool(toolSlug, toolParams, modifiers);
// Verify the global execute function was called with the correct parameters
expect(mockGlobalExecute).toHaveBeenCalledWith(toolSlug, toolParams, modifiers);
@@ -227,7 +227,7 @@ describe('BaseToolset', () => {
describe('_setExecuteToolFn', () => {
it('should throw an error if trying to execute a tool without setting the execute function', async () => {
- const toolset = new MockNonAgenticToolset();
+ const provider = new MockNonAgenticProvider();
const toolSlug = 'test-tool';
const toolParams: ToolExecuteParams = {
@@ -237,7 +237,7 @@ describe('BaseToolset', () => {
// This should throw an error because _globalExecuteToolFn is not set
try {
- await toolset.executeTool(toolSlug, toolParams);
+ await provider.executeTool(toolSlug, toolParams);
} catch (error) {
expect(error).toBeInstanceOf(ComposioGlobalExecuteToolFnNotSetError);
}
diff --git a/packages/core/test/tools/tools.test.ts b/packages/core/test/tools/tools.test.ts
index e60c34b4f..abe94d5da 100644
--- a/packages/core/test/tools/tools.test.ts
+++ b/packages/core/test/tools/tools.test.ts
@@ -17,14 +17,14 @@ describe('Tools', () => {
describe('constructor', () => {
it('should throw an error if client is not provided', () => {
- expect(() => new Tools(null as any, context.mockToolset)).toThrow(
+ expect(() => new Tools(null as any, context.mockProvider)).toThrow(
'ComposioClient is required'
);
});
- it('should throw an error if toolset is not provided', () => {
+ it('should throw an error if provider is not provided', () => {
expect(() => new Tools(mockClient as unknown as ComposioClient, null as any)).toThrow(
- 'Toolset not passed into Tools instance'
+ 'Provider not passed into Tools instance'
);
});
@@ -194,35 +194,35 @@ describe('Tools', () => {
});
describe('get', () => {
- it('should get a single tool and wrap it with toolset', async () => {
+ it('should get a single tool and wrap it with provider', async () => {
const userId = 'test-user';
const slug = 'TOOL_SLUG';
const getComposioToolBySlugSpy = vi.spyOn(context.tools, 'getComposioToolBySlug');
getComposioToolBySlugSpy.mockResolvedValueOnce(toolMocks.transformedTool as unknown as Tool);
- context.mockToolset.wrapTool.mockReturnValueOnce('wrapped-tool');
+ context.mockProvider.wrapTool.mockReturnValueOnce('wrapped-tool');
const result = await context.tools.get(userId, slug);
expect(getComposioToolBySlugSpy).toHaveBeenCalledWith(userId, slug, undefined);
- expect(context.mockToolset.wrapTool).toHaveBeenCalled();
+ expect(context.mockProvider.wrapTool).toHaveBeenCalled();
expect(result).toEqual('wrapped-tool');
});
- it('should get multiple tools and wrap them with toolset', async () => {
+ it('should get multiple tools and wrap them with provider', async () => {
const userId = 'test-user';
const filters = { tools: ['TOOL1', 'TOOL2'] };
const getComposioToolsSpy = vi.spyOn(context.tools, 'getComposioTools');
getComposioToolsSpy.mockResolvedValueOnce([toolMocks.transformedTool as unknown as Tool]);
- context.mockToolset.wrapTools.mockReturnValueOnce('wrapped-tools');
+ context.mockProvider.wrapTools.mockReturnValueOnce('wrapped-tools');
const result = await context.tools.get(userId, filters);
expect(getComposioToolsSpy).toHaveBeenCalledWith(userId, filters, undefined);
- expect(context.mockToolset.wrapTools).toHaveBeenCalled();
+ expect(context.mockProvider.wrapTools).toHaveBeenCalled();
expect(result).toEqual('wrapped-tools');
});
diff --git a/packages/core/test/utils/mocks/provider.mock.ts b/packages/core/test/utils/mocks/provider.mock.ts
new file mode 100644
index 000000000..f5295e770
--- /dev/null
+++ b/packages/core/test/utils/mocks/provider.mock.ts
@@ -0,0 +1,9 @@
+import { vi } from 'vitest';
+import { BaseAgenticProvider } from '../../../src/provider/BaseProvider';
+
+export class MockProvider extends BaseAgenticProvider<unknown, unknown> {
+ readonly name = 'MockProvider';
+
+ wrapTool = vi.fn();
+ wrapTools = vi.fn();
+}
diff --git a/packages/core/test/utils/mocks/toolset.mock.ts b/packages/core/test/utils/mocks/toolset.mock.ts
deleted file mode 100644
index 34354f02d..000000000
--- a/packages/core/test/utils/mocks/toolset.mock.ts
+++ /dev/null
@@ -1,9 +0,0 @@
-import { vi } from 'vitest';
-import { BaseAgenticToolset } from '../../../src/toolset/BaseToolset';
-
-export class MockToolset extends BaseAgenticToolset<unknown, unknown> {
- readonly name = 'MockToolset';
-
- wrapTool = vi.fn();
- wrapTools = vi.fn();
-}
diff --git a/packages/core/test/utils/toolExecuteUtils.ts b/packages/core/test/utils/toolExecuteUtils.ts
index be60cd25b..47e0c9cba 100644
--- a/packages/core/test/utils/toolExecuteUtils.ts
+++ b/packages/core/test/utils/toolExecuteUtils.ts
@@ -1,29 +1,29 @@
import { vi, beforeEach } from 'vitest';
import { Tools } from '../../src/models/Tools';
import { mockClient } from './mocks/client.mock';
-import { MockToolset } from './mocks/toolset.mock';
+import { MockProvider } from './mocks/provider.mock';
import { connectedAccountMocks, toolkitMocks, toolMocks } from './mocks/data.mock';
import ComposioClient from '@composio/client';
import { Tool } from '../../src/types/tool.types';
-export type TestTools = Tools<unknown, unknown, MockToolset>;
+export type TestTools = Tools<unknown, unknown, MockProvider>;
export interface TestContext {
tools: TestTools;
- mockToolset: MockToolset;
+ mockProvider: MockProvider;
}
export const createTestContext = (): TestContext => {
- const mockToolset = new MockToolset();
- const tools = new Tools(mockClient as unknown as ComposioClient, mockToolset);
- return { tools, mockToolset };
+ const mockProvider = new MockProvider();
+ const tools = new Tools(mockClient as unknown as ComposioClient, mockProvider);
+ return { tools, mockProvider };
};
export const setupTest = (context: TestContext) => {
beforeEach(() => {
vi.clearAllMocks();
- context.mockToolset = new MockToolset();
- context.tools = new Tools(mockClient as unknown as ComposioClient, context.mockToolset);
+ context.mockProvider = new MockProvider();
+ context.tools = new Tools(mockClient as unknown as ComposioClient, context.mockProvider);
});
};
diff --git a/packages/toolsets/README.md b/packages/providers/README.md
similarity index 79%
rename from packages/toolsets/README.md
rename to packages/providers/README.md
index bf5c35b70..56158be15 100644
--- a/packages/toolsets/README.md
+++ b/packages/providers/README.md
@@ -1,22 +1,22 @@
-# Composio Toolsets
+# Composio Providers
-This directory contains various toolsets that implement the Composio SDK for different platforms and frameworks. Each toolset provides a way to interact with the Composio Platform using the specific platform's conventions and requirements.
+This directory contains various providers that implement the Composio SDK for different platforms and frameworks. Each provider provides a way to interact with the Composio Platform using the specific platform's conventions and requirements.
-## Types of Toolsets
+## Types of Providers
-Composio SDK supports two types of toolsets, each with different modifier capabilities:
+Composio SDK supports two types of providers, each with different modifier capabilities:
-### 1. Non-Agentic Toolsets
+### 1. Non-Agentic Providers
-These toolsets only support schema modifiers for transforming tool schemas. They are suitable for simple integrations like OpenAI, Anthropic, etc.
+These providers only support schema modifiers for transforming tool schemas. They are suitable for simple integrations like OpenAI, Anthropic, etc.
Example implementation:
```typescript
-import { BaseNonAgenticToolset } from '@composio/core';
+import { BaseNonAgenticProvider } from '@composio/core';
import type { Tool, SchemaModifiersParams } from '@composio/core';
-export class NonAgenticToolset extends BaseNonAgenticToolset {
+export class NonAgenticProvider extends BaseNonAgenticProvider {
async wrapTool(toolSlug: string, tool: Tool, modifiers?: SchemaModifiersParams): Promise<Tool> {
// Apply schema modifiers if provided
if (modifiers?.schema) {
@@ -40,9 +40,9 @@ export class NonAgenticToolset extends BaseNonAgenticToolset {
}
```
-### 2. Agentic Toolsets
+### 2. Agentic Providers
-These toolsets support full modifier capabilities, making them suitable for complex integrations like Vercel, Langchain, etc. They support:
+These providers support full modifier capabilities, making them suitable for complex integrations like Vercel, Langchain, etc. They support:
1. **Schema Modifiers**: Transform tool schemas using `TransformToolSchemaModifier`
2. **Execution Modifiers**: Transform tool execution behavior
@@ -55,10 +55,10 @@ These toolsets support full modifier capabilities, making them suitable for comp
Example implementation:
```typescript
-import { BaseAgenticToolset } from '@composio/core';
+import { BaseAgenticProvider } from '@composio/core';
import type { Tool, ModifiersParams, ToolExecuteParams, ToolExecuteResponse } from '@composio/core';
-export class AgenticToolset extends BaseAgenticToolset {
+export class AgenticProvider extends BaseAgenticProvider {
async wrapTool(toolSlug: string, tool: Tool, modifiers?: ModifiersParams): Promise<Tool> {
let wrappedTool = tool;
@@ -109,38 +109,38 @@ export class AgenticToolset extends BaseAgenticToolset {
}
```
-## Creating a New Toolset
+## Creating a New Provider
-To create a new toolset, you can use the provided script:
+To create a new provider, you can use the provided script:
```bash
-# Create a non-agentic toolset (default)
-pnpm run create-toolset <your-toolset-name>
+# Create a non-agentic provider (default)
+pnpm run create-provider <your-provider-name>
-# Create an agentic toolset
-pnpm run create-toolset <your-toolset-name> --agentic
+# Create an agentic provider
+pnpm run create-provider <your-provider-name> --agentic
```
-The script will create a new toolset with the following structure:
+The script will create a new provider with the following structure:
```
-<toolset-name>/
+<provider-name>/
├── src/
-│ └── index.ts # Toolset implementation
+│ └── index.ts # Provider implementation
├── package.json # Package configuration
├── tsconfig.json # TypeScript configuration
├── tsup.config.ts # Build configuration
-└── README.md # Toolset documentation
+└── README.md # Provider documentation
```
## Required Methods
-Each toolset must implement the following methods:
+Each provider must implement the following methods:
-### For Non-Agentic Toolsets
+### For Non-Agentic Providers
```typescript
-class NonAgenticToolset extends BaseNonAgenticToolset {
+class NonAgenticProvider extends BaseNonAgenticProvider {
// Wrap a tool with schema modifiers
async wrapTool(toolSlug: string, tool: Tool, modifiers?: SchemaModifiersParams): Promise<Tool>;
@@ -152,10 +152,10 @@ class NonAgenticToolset extends BaseNonAgenticToolset {
}
```
-### For Agentic Toolsets
+### For Agentic Providers
```typescript
-class AgenticToolset extends BaseAgenticToolset {
+class AgenticProvider extends BaseAgenticProvider {
// Wrap a tool with modifiers
async wrapTool(toolSlug: string, tool: Tool, modifiers?: ModifiersParams): Promise<Tool>;
@@ -206,21 +206,21 @@ type AfterToolExecuteModifier = (
1. **Type Safety**: Always use TypeScript and ensure proper type definitions for all methods and parameters.
2. **Error Handling**: Implement proper error handling for API calls and tool execution.
-3. **Documentation**: Document your toolset's features, requirements, and usage examples.
-4. **Testing**: Write tests for your toolset implementation.
+3. **Documentation**: Document your provider's features, requirements, and usage examples.
+4. **Testing**: Write tests for your provider implementation.
5. **Modifier Support**:
- - For non-agentic toolsets, implement schema modifiers to transform tool schemas
- - For agentic toolsets, implement both schema and execution modifiers for full control over tool behavior
+ - For non-agentic providers, implement schema modifiers to transform tool schemas
+ - For agentic providers, implement both schema and execution modifiers for full control over tool behavior
## Example Implementation
-Here's a complete example of a non-agentic toolset implementation:
+Here's a complete example of a non-agentic provider implementation:
```typescript
-import { BaseNonAgenticToolset } from '@composio/core';
+import { BaseNonAgenticProvider } from '@composio/core';
import type { Tool, SchemaModifiersParams } from '@composio/core';
-export class OpenAIToolset extends BaseNonAgenticToolset {
+export class OpenAIProvider extends BaseNonAgenticProvider {
async wrapTool(toolSlug: string, tool: Tool, modifiers?: SchemaModifiersParams): Promise<Tool> {
// Apply schema modifiers if provided
if (modifiers?.schema) {
@@ -245,13 +245,13 @@ export class OpenAIToolset extends BaseNonAgenticToolset {
}
```
-And here's a complete example of an agentic toolset implementation:
+And here's a complete example of an agentic provider implementation:
```typescript
-import { BaseAgenticToolset } from '@composio/core';
+import { BaseAgenticProvider } from '@composio/core';
import type { Tool, ModifiersParams, ToolExecuteParams, ToolExecuteResponse } from '@composio/core';
-export class VercelToolset extends BaseAgenticToolset {
+export class VercelProvider extends BaseAgenticProvider {
async wrapTool(toolSlug: string, tool: Tool, modifiers?: ModifiersParams): Promise<Tool> {
let wrappedTool = tool;
@@ -304,16 +304,16 @@ export class VercelToolset extends BaseAgenticToolset {
## Usage Examples
-### Using a Non-Agentic Toolset
+### Using a Non-Agentic Provider
```typescript
import { Composio } from '@composio/core';
-import { OpenAIToolset } from '@composio/openai-toolset';
+import { OpenAIProvider } from '@composio/openai-provider';
import type { Tool } from '@composio/core';
const composio = new Composio({
apiKey: process.env.COMPOSIO_API_KEY,
- toolset: new OpenAIToolset(),
+ provider: new OpenAIProvider(),
});
// Get a tool with schema modifiers
@@ -332,16 +332,16 @@ const tool = await composio.getToolBySlug('HACKERNEWS_SEARCH_POSTS', {
});
```
-### Using an Agentic Toolset
+### Using an Agentic Provider
```typescript
import { Composio } from '@composio/core';
-import { VercelToolset } from '@composio/vercel-toolset';
+import { VercelProvider } from '@composio/vercel-provider';
import type { Tool, ToolExecuteParams, ToolExecuteResponse } from '@composio/core';
const composio = new Composio({
apiKey: process.env.COMPOSIO_API_KEY,
- toolset: new VercelToolset(),
+ provider: new VercelProvider(),
});
// Get a tool with full modifier support
@@ -379,7 +379,7 @@ const tool = await composio.getToolBySlug('HACKERNEWS_SEARCH_POSTS', {
});
// Execute the tool with execution modifiers
-const result = await composio.toolset.executeTool(
+const result = await composio.provider.executeTool(
tool,
{
arguments: { query: 'AI', limit: 20 },
diff --git a/packages/toolsets/cloudflare/README.md b/packages/providers/cloudflare/README.md
similarity index 83%
rename from packages/toolsets/cloudflare/README.md
rename to packages/providers/cloudflare/README.md
index fde1dfa22..cea71fb5a 100644
--- a/packages/toolsets/cloudflare/README.md
+++ b/packages/providers/cloudflare/README.md
@@ -1,6 +1,6 @@
# @composio/cloudflare
-The Cloudflare AI toolset for Composio SDK, providing seamless integration with Cloudflare's AI capabilities and Workers AI.
+The Cloudflare AI provider for Composio SDK, providing seamless integration with Cloudflare's AI capabilities and Workers AI.
## Features
@@ -25,12 +25,12 @@ pnpm add @composio/cloudflare
```typescript
import { Composio } from '@composio/core';
-import { CloudflareToolset } from '@composio/cloudflare';
+import { CloudflareProvider } from '@composio/cloudflare';
-// Initialize Composio with Cloudflare toolset
+// Initialize Composio with Cloudflare provider
const composio = new Composio({
apiKey: 'your-composio-api-key',
- toolset: new CloudflareToolset({
+ provider: new CloudflareProvider({
accountId: 'your-cloudflare-account-id',
apiToken: 'your-cloudflare-api-token',
}),
@@ -49,13 +49,13 @@ const tools = await composio.tools.get('user123', {
```typescript
import { Composio } from '@composio/core';
-import { CloudflareToolset } from '@composio/cloudflare';
+import { CloudflareProvider } from '@composio/cloudflare';
import { Ai } from '@cloudflare/ai';
// Initialize Composio
const composio = new Composio({
apiKey: process.env.COMPOSIO_API_KEY,
- toolset: new CloudflareToolset(),
+ provider: new CloudflareProvider(),
});
// In your Worker
@@ -90,13 +90,13 @@ export default {
```typescript
import { Composio } from '@composio/core';
-import { CloudflareToolset } from '@composio/cloudflare';
+import { CloudflareProvider } from '@composio/cloudflare';
import { Ai } from '@cloudflare/ai';
// Initialize Composio
const composio = new Composio({
apiKey: process.env.COMPOSIO_API_KEY,
- toolset: new CloudflareToolset(),
+ provider: new CloudflareProvider(),
});
// In your Worker
@@ -139,9 +139,9 @@ export default {
## API Reference
-### CloudflareToolset Class
+### CloudflareProvider Class
-The `CloudflareToolset` class extends `BaseComposioToolset` and provides Cloudflare-specific functionality.
+The `CloudflareProvider` class extends `BaseComposioProvider` and provides Cloudflare-specific functionality.
#### Methods
@@ -150,7 +150,7 @@ The `CloudflareToolset` class extends `BaseComposioToolset` and provides Cloudfl
Executes a tool call and returns the result.
```typescript
-const result = await composio.toolset.executeToolCall(toolCall);
+const result = await composio.provider.executeToolCall(toolCall);
```
## Contributing
diff --git a/packages/toolsets/cloudflare/package.json b/packages/providers/cloudflare/package.json
similarity index 95%
rename from packages/toolsets/cloudflare/package.json
rename to packages/providers/cloudflare/package.json
index 702de1f76..5c30a6632 100644
--- a/packages/toolsets/cloudflare/package.json
+++ b/packages/providers/cloudflare/package.json
@@ -33,7 +33,7 @@
"@composio/core": "^0.1.10-alpha.0"
},
"devDependencies": {
- "@composio/core": "^0.1.10-alpha.0",
+ "@composio/core": "workspace:*",
"tsup": "^8.4.0",
"typescript": "^5.8.3",
"vitest": "^3.1.3"
diff --git a/packages/toolsets/cloudflare/src/index.ts b/packages/providers/cloudflare/src/index.ts
similarity index 90%
rename from packages/toolsets/cloudflare/src/index.ts
rename to packages/providers/cloudflare/src/index.ts
index 4faa6b06e..d7f6b5298 100644
--- a/packages/toolsets/cloudflare/src/index.ts
+++ b/packages/providers/cloudflare/src/index.ts
@@ -1,26 +1,26 @@
/**
- * Cloudflare AI Toolset
+ * Cloudflare AI Provider
*
* Author: Musthaq Ahamad <[email protected]>
* Legacy Reference: https://github.com/ComposioHQ/composio/blob/master/js/src/frameworks/cloudflare.ts
*
- * This toolset provides a set of tools for interacting with Cloudflare AI.
+ * This provider provides a set of tools for interacting with Cloudflare AI.
*
* @packageDocumentation
- * @module toolsets/cloudflare
+ * @module providers/cloudflare
*/
import { AiTextGenerationToolInput } from '@cloudflare/workers-types';
import {
Tool,
ExecuteToolModifiers,
- BaseNonAgenticToolset,
+ BaseNonAgenticProvider,
ToolExecuteParams,
ExecuteToolFnOptions,
} from '@composio/core';
type AiToolCollection = Record<string, AiTextGenerationToolInput>;
-export class CloudflareToolset extends BaseNonAgenticToolset<
+export class CloudflareProvider extends BaseNonAgenticProvider<
AiToolCollection,
AiTextGenerationToolInput
> {
diff --git a/packages/toolsets/cloudflare/test/cloudflare.test.ts b/packages/providers/cloudflare/test/cloudflare.test.ts
similarity index 87%
rename from packages/toolsets/cloudflare/test/cloudflare.test.ts
rename to packages/providers/cloudflare/test/cloudflare.test.ts
index 2c7bac3be..813dc15a4 100644
--- a/packages/toolsets/cloudflare/test/cloudflare.test.ts
+++ b/packages/providers/cloudflare/test/cloudflare.test.ts
@@ -1,5 +1,5 @@
import { describe, it, expect, vi, beforeEach } from 'vitest';
-import { CloudflareToolset } from '../src';
+import { CloudflareProvider } from '../src';
import { Tool } from '@composio/core';
// Instead of importing and mocking the actual Cloudflare types, let's define our own for testing
@@ -23,13 +23,13 @@ vi.mock('@cloudflare/workers-types', () => {
return {};
});
-describe('CloudflareToolset', () => {
- let toolset: CloudflareToolset;
+describe('CloudflareProvider', () => {
+ let provider: CloudflareProvider;
let mockTool: Tool;
let mockExecuteToolFn: any;
beforeEach(() => {
- toolset = new CloudflareToolset();
+ provider = new CloudflareProvider();
// Mock the global execute tool function
mockExecuteToolFn = vi.fn().mockResolvedValue({
@@ -37,7 +37,7 @@ describe('CloudflareToolset', () => {
error: null,
successful: true,
});
- toolset._setExecuteToolFn(mockExecuteToolFn);
+ provider._setExecuteToolFn(mockExecuteToolFn);
// Create a mock Composio tool
mockTool = {
@@ -63,19 +63,19 @@ describe('CloudflareToolset', () => {
describe('name property', () => {
it('should have the correct name', () => {
- expect(toolset.name).toBe('cloudflare');
+ expect(provider.name).toBe('cloudflare');
});
});
describe('_isAgentic property', () => {
it('should be non-agentic', () => {
- expect(toolset._isAgentic).toBe(false);
+ expect(provider._isAgentic).toBe(false);
});
});
describe('wrapTool', () => {
it('should wrap a tool in Cloudflare AiTextGenerationToolInput format', () => {
- const wrapped = toolset.wrapTool(mockTool) as MockedCloudflareToolInput;
+ const wrapped = provider.wrapTool(mockTool) as MockedCloudflareToolInput;
expect(wrapped).toEqual({
type: 'function',
@@ -95,7 +95,7 @@ describe('CloudflareToolset', () => {
// This would normally throw an error due to the type casting in the function,
// but we're testing the behavior, not the types
- const wrapped = toolset.wrapTool(toolWithoutParams) as MockedCloudflareToolInput;
+ const wrapped = provider.wrapTool(toolWithoutParams) as MockedCloudflareToolInput;
expect(wrapped).toEqual({
type: 'function',
@@ -113,7 +113,7 @@ describe('CloudflareToolset', () => {
description: undefined,
};
- const wrapped = toolset.wrapTool(toolWithoutDescription) as MockedCloudflareToolInput;
+ const wrapped = provider.wrapTool(toolWithoutDescription) as MockedCloudflareToolInput;
expect(wrapped).toEqual({
type: 'function',
@@ -135,7 +135,7 @@ describe('CloudflareToolset', () => {
};
const tools = [mockTool, anotherTool];
- const wrapped = toolset.wrapTools(tools);
+ const wrapped = provider.wrapTools(tools);
// Verify the result has the expected properties
expect(Object.keys(wrapped)).toHaveLength(2);
@@ -163,7 +163,7 @@ describe('CloudflareToolset', () => {
});
it('should return an empty object for empty tools array', () => {
- const wrapped = toolset.wrapTools([]);
+ const wrapped = provider.wrapTools([]);
expect(wrapped).toEqual({});
});
});
@@ -176,7 +176,7 @@ describe('CloudflareToolset', () => {
arguments: { input: 'test-value' },
};
- const result = await toolset.executeToolCall(userId, toolCall, {});
+ const result = await provider.executeToolCall(userId, toolCall, {});
expect(mockExecuteToolFn).toHaveBeenCalledWith(
'test-tool',
@@ -204,7 +204,7 @@ describe('CloudflareToolset', () => {
arguments: JSON.stringify({ input: 'test-value' }),
};
- const result = await toolset.executeToolCall(userId, toolCall, {});
+ const result = await provider.executeToolCall(userId, toolCall, {});
expect(mockExecuteToolFn).toHaveBeenCalledWith(
'test-tool',
@@ -244,7 +244,7 @@ describe('CloudflareToolset', () => {
afterToolExecute: vi.fn(response => response),
};
- await toolset.executeToolCall(userId, toolCall, options, modifiers);
+ await provider.executeToolCall(userId, toolCall, options, modifiers);
expect(mockExecuteToolFn).toHaveBeenCalledWith(
'test-tool',
@@ -267,7 +267,7 @@ describe('CloudflareToolset', () => {
arguments: { input: 'test-value' },
};
- const result = await toolset.executeTool(toolSlug, toolParams);
+ const result = await provider.executeTool(toolSlug, toolParams);
expect(mockExecuteToolFn).toHaveBeenCalledWith(toolSlug, toolParams, undefined);
expect(result).toEqual({
@@ -289,7 +289,7 @@ describe('CloudflareToolset', () => {
afterToolExecute: vi.fn(response => response),
};
- await toolset.executeTool(toolSlug, toolParams, modifiers);
+ await provider.executeTool(toolSlug, toolParams, modifiers);
expect(mockExecuteToolFn).toHaveBeenCalledWith(toolSlug, toolParams, modifiers);
});
@@ -297,7 +297,7 @@ describe('CloudflareToolset', () => {
describe('integration with Cloudflare AI', () => {
it('should produce tools compatible with Cloudflare AI', () => {
- const wrapped = toolset.wrapTool(mockTool) as MockedCloudflareToolInput;
+ const wrapped = provider.wrapTool(mockTool) as MockedCloudflareToolInput;
// Verify the wrapped tool has the expected structure
expect(wrapped).toHaveProperty('type', 'function');
diff --git a/packages/toolsets/cloudflare/tsconfig.json b/packages/providers/cloudflare/tsconfig.json
similarity index 100%
rename from packages/toolsets/cloudflare/tsconfig.json
rename to packages/providers/cloudflare/tsconfig.json
diff --git a/packages/toolsets/cloudflare/tsup.config.ts b/packages/providers/cloudflare/tsup.config.ts
similarity index 100%
rename from packages/toolsets/cloudflare/tsup.config.ts
rename to packages/providers/cloudflare/tsup.config.ts
diff --git a/packages/toolsets/langchain/README.md b/packages/providers/langchain/README.md
similarity index 87%
rename from packages/toolsets/langchain/README.md
rename to packages/providers/langchain/README.md
index ab2b94c16..3de5c2c37 100644
--- a/packages/toolsets/langchain/README.md
+++ b/packages/providers/langchain/README.md
@@ -1,6 +1,6 @@
# @composio/langchain
-The LangChain toolset for Composio SDK, providing seamless integration with LangChain's ecosystem and tools.
+The LangChain provider for Composio SDK, providing seamless integration with LangChain's ecosystem and tools.
## Features
@@ -25,12 +25,12 @@ pnpm add @composio/langchain
```typescript
import { Composio } from '@composio/core';
-import { LangChainToolset } from '@composio/langchain';
+import { LangChainProvider } from '@composio/langchain';
-// Initialize Composio with LangChain toolset
+// Initialize Composio with LangChain provider
const composio = new Composio({
apiKey: 'your-composio-api-key',
- toolset: new LangChainToolset(),
+ provider: new LangChainProvider(),
});
// Get available tools
@@ -49,14 +49,14 @@ const sendEmailTool = await composio.tools.get('user123', 'GMAIL_SEND_EMAIL');
```typescript
import { Composio } from '@composio/core';
-import { LangChainToolset } from '@composio/langchain';
+import { LangChainProvider } from '@composio/langchain';
import { ChatPromptTemplate } from '@langchain/core/prompts';
import { StringOutputParser } from '@langchain/core/output_parsers';
import { ChatOpenAI } from '@langchain/openai';
const composio = new Composio({
apiKey: process.env.COMPOSIO_API_KEY,
- toolset: new LangChainToolset(),
+ provider: new LangChainProvider(),
});
// Get tools for the chain
@@ -89,14 +89,14 @@ for await (const chunk of stream) {
```typescript
import { Composio } from '@composio/core';
-import { LangChainToolset } from '@composio/langchain';
+import { LangChainProvider } from '@composio/langchain';
import { ChatPromptTemplate } from '@langchain/core/prompts';
import { JsonOutputParser } from '@langchain/core/output_parsers';
import { ChatOpenAI } from '@langchain/openai';
const composio = new Composio({
apiKey: process.env.COMPOSIO_API_KEY,
- toolset: new LangChainToolset(),
+ provider: new LangChainProvider(),
});
// Get tools for the chain
@@ -129,7 +129,7 @@ for await (const event of eventStream) {
```typescript
import { Composio } from '@composio/core';
-import { LangChainToolset } from '@composio/langchain';
+import { LangChainProvider } from '@composio/langchain';
import { ChatPromptTemplate } from '@langchain/core/prompts';
import { StringOutputParser } from '@langchain/core/output_parsers';
import { MemoryVectorStore } from 'langchain/vectorstores/memory';
@@ -139,7 +139,7 @@ import { RunnableSequence, RunnablePassthrough } from '@langchain/core/runnables
const composio = new Composio({
apiKey: process.env.COMPOSIO_API_KEY,
- toolset: new LangChainToolset(),
+ provider: new LangChainProvider(),
});
// Get tools for the chain
@@ -188,9 +188,9 @@ for await (const chunk of stream) {
## API Reference
-### LangChainToolset Class
+### LangChainProvider Class
-The `LangChainToolset` class extends `BaseComposioToolset` and provides LangChain-specific functionality.
+The `LangChainProvider` class extends `BaseComposioProvider` and provides LangChain-specific functionality.
#### Methods
@@ -199,7 +199,7 @@ The `LangChainToolset` class extends `BaseComposioToolset` and provides LangChai
Executes a LangChain tool call and returns the result.
```typescript
-const result = await toolset.executeToolCall(tool);
+const result = await provider.executeToolCall(tool);
```
## Contributing
diff --git a/packages/toolsets/langchain/package.json b/packages/providers/langchain/package.json
similarity index 95%
rename from packages/toolsets/langchain/package.json
rename to packages/providers/langchain/package.json
index f7bc1b239..a7abb8d44 100644
--- a/packages/toolsets/langchain/package.json
+++ b/packages/providers/langchain/package.json
@@ -33,7 +33,7 @@
"@langchain/core": "^0.3.44"
},
"devDependencies": {
- "@composio/core": "^0.1.10-alpha.0",
+ "@composio/core": "workspace:*",
"tsup": "^8.4.0",
"typescript": "^5.8.3",
"vitest": "^3.1.3"
diff --git a/packages/toolsets/langchain/src/index.ts b/packages/providers/langchain/src/index.ts
similarity index 79%
rename from packages/toolsets/langchain/src/index.ts
rename to packages/providers/langchain/src/index.ts
index bbeb53709..461800437 100644
--- a/packages/toolsets/langchain/src/index.ts
+++ b/packages/providers/langchain/src/index.ts
@@ -1,26 +1,26 @@
/**
- * Langchain Toolset
+ * Langchain Provider
*
* Author: Musthaq Ahamad <[email protected]>
* Reference: https://github.com/ComposioHQ/composio/blob/master/js/src/frameworks/langchain.ts
*
- * This toolset provides a set of tools for interacting with Langchain.
+ * This provider provides a set of tools for interacting with Langchain.
*
* @packageDocumentation
- * @module toolsets/langchain
+ * @module providers/langchain
*/
-import { BaseAgenticToolset, jsonSchemaToModel, Tool, ExecuteToolFn } from '@composio/core';
+import { BaseAgenticProvider, jsonSchemaToModel, Tool, ExecuteToolFn } from '@composio/core';
import { DynamicStructuredTool } from '@langchain/core/tools';
export type LangChainToolCollection = Array<DynamicStructuredTool>;
-export class LangchainToolset extends BaseAgenticToolset<
+export class LangchainProvider extends BaseAgenticProvider<
LangChainToolCollection,
DynamicStructuredTool
> {
readonly name = 'langchain';
/**
- * Abstract method to wrap a tool in the toolset.
- * This method is implemented by the toolset.
+ * Abstract method to wrap a tool in the provider.
+ * This method is implemented by the provider.
* @param tool - The tool to wrap.
* @returns The wrapped tool.
*/
diff --git a/packages/toolsets/langchain/test/langchain.test.ts b/packages/providers/langchain/test/langchain.test.ts
similarity index 86%
rename from packages/toolsets/langchain/test/langchain.test.ts
rename to packages/providers/langchain/test/langchain.test.ts
index b1e244821..f9352fd63 100644
--- a/packages/toolsets/langchain/test/langchain.test.ts
+++ b/packages/providers/langchain/test/langchain.test.ts
@@ -1,5 +1,5 @@
import { describe, it, expect, vi, beforeEach } from 'vitest';
-import { LangchainToolset } from '../src';
+import { LangchainProvider } from '../src';
import { Tool } from '@composio/core';
import { DynamicStructuredTool } from '@langchain/core/tools';
@@ -34,13 +34,13 @@ vi.mock('@composio/core', async () => {
};
});
-describe('LangchainToolset', () => {
- let toolset: LangchainToolset;
+describe('LangchainProvider', () => {
+ let provider: LangchainProvider;
let mockTool: Tool;
let mockExecuteToolFn: any;
beforeEach(() => {
- toolset = new LangchainToolset();
+ provider = new LangchainProvider();
// Mock the global execute tool function
mockExecuteToolFn = vi.fn().mockResolvedValue({
@@ -48,7 +48,7 @@ describe('LangchainToolset', () => {
error: null,
successful: true,
});
- toolset._setExecuteToolFn(mockExecuteToolFn);
+ provider._setExecuteToolFn(mockExecuteToolFn);
// Create a mock Composio tool
mockTool = {
@@ -78,19 +78,19 @@ describe('LangchainToolset', () => {
describe('name property', () => {
it('should have the correct name', () => {
- expect(toolset.name).toBe('langchain');
+ expect(provider.name).toBe('langchain');
});
});
describe('_isAgentic property', () => {
it('should be agentic', () => {
- expect(toolset._isAgentic).toBe(true);
+ expect(provider._isAgentic).toBe(true);
});
});
describe('wrapTool', () => {
it('should wrap a tool in LangChain DynamicStructuredTool format', () => {
- const wrapped = toolset.wrapTool(mockTool, mockExecuteToolFn) as MockedLangChainTool;
+ const wrapped = provider.wrapTool(mockTool, mockExecuteToolFn) as MockedLangChainTool;
expect(DynamicStructuredTool).toHaveBeenCalledWith({
name: mockTool.slug,
@@ -112,7 +112,7 @@ describe('LangchainToolset', () => {
};
expect(() => {
- toolset.wrapTool(toolWithoutToolkit, mockExecuteToolFn);
+ provider.wrapTool(toolWithoutToolkit, mockExecuteToolFn);
}).toThrow('App name is not defined');
});
@@ -123,12 +123,12 @@ describe('LangchainToolset', () => {
};
expect(() => {
- toolset.wrapTool(toolWithoutParams, mockExecuteToolFn);
+ provider.wrapTool(toolWithoutParams, mockExecuteToolFn);
}).toThrow('Tool input parameters are not defined');
});
it('should create a function that executes the tool with the right parameters', async () => {
- const wrapped = toolset.wrapTool(mockTool, mockExecuteToolFn);
+ const wrapped = provider.wrapTool(mockTool, mockExecuteToolFn);
// Extract the function from the constructor call
const executeFunction = (DynamicStructuredTool as any).mock.calls[0][0].func;
@@ -160,7 +160,7 @@ describe('LangchainToolset', () => {
};
const tools = [mockTool, anotherTool];
- const wrapped = toolset.wrapTools(tools, mockExecuteToolFn);
+ const wrapped = provider.wrapTools(tools, mockExecuteToolFn);
// Verify the result is an array of the right length
expect(wrapped).toHaveLength(2);
@@ -180,7 +180,7 @@ describe('LangchainToolset', () => {
});
it('should return an empty array for empty tools array', () => {
- const wrapped = toolset.wrapTools([], mockExecuteToolFn);
+ const wrapped = provider.wrapTools([], mockExecuteToolFn);
expect(wrapped).toEqual([]);
expect(DynamicStructuredTool).not.toHaveBeenCalled();
});
@@ -194,7 +194,7 @@ describe('LangchainToolset', () => {
arguments: { input: 'test-value' },
};
- const result = await toolset.executeTool(toolSlug, toolParams);
+ const result = await provider.executeTool(toolSlug, toolParams);
expect(mockExecuteToolFn).toHaveBeenCalledWith(toolSlug, toolParams, undefined);
expect(result).toEqual({
@@ -216,7 +216,7 @@ describe('LangchainToolset', () => {
afterToolExecute: vi.fn(response => response),
};
- await toolset.executeTool(toolSlug, toolParams, modifiers);
+ await provider.executeTool(toolSlug, toolParams, modifiers);
expect(mockExecuteToolFn).toHaveBeenCalledWith(toolSlug, toolParams, modifiers);
});
@@ -224,7 +224,7 @@ describe('LangchainToolset', () => {
describe('integration with LangChain', () => {
it('should produce tools compatible with LangChain', () => {
- const wrapped = toolset.wrapTool(mockTool, mockExecuteToolFn) as MockedLangChainTool;
+ const wrapped = provider.wrapTool(mockTool, mockExecuteToolFn) as MockedLangChainTool;
// Verify the wrapped tool has the expected structure
expect(wrapped).toHaveProperty('name');
diff --git a/packages/toolsets/langchain/tsconfig.json b/packages/providers/langchain/tsconfig.json
similarity index 100%
rename from packages/toolsets/langchain/tsconfig.json
rename to packages/providers/langchain/tsconfig.json
diff --git a/packages/toolsets/langchain/tsup.config.ts b/packages/providers/langchain/tsup.config.ts
similarity index 100%
rename from packages/toolsets/langchain/tsup.config.ts
rename to packages/providers/langchain/tsup.config.ts
diff --git a/packages/toolsets/openai/README.md b/packages/providers/openai/README.md
similarity index 84%
rename from packages/toolsets/openai/README.md
rename to packages/providers/openai/README.md
index dda68bbc9..b1dfac4fc 100644
--- a/packages/toolsets/openai/README.md
+++ b/packages/providers/openai/README.md
@@ -1,6 +1,6 @@
# @composio/openai
-The OpenAI toolset for Composio SDK, providing seamless integration with OpenAI's models and function calling capabilities.
+The OpenAI provider for Composio SDK, providing seamless integration with OpenAI's models and function calling capabilities.
## Features
@@ -25,12 +25,12 @@ pnpm add @composio/openai
```typescript
import { Composio } from '@composio/core';
-import { OpenAIToolset } from '@composio/openai';
+import { OpenAIProvider } from '@composio/openai';
-// Initialize Composio with OpenAI toolset
+// Initialize Composio with OpenAI provider
const composio = new Composio({
apiKey: 'your-composio-api-key',
- toolset: new OpenAIToolset(),
+ provider: new OpenAIProvider(),
});
// Get available tools
@@ -49,12 +49,12 @@ const sendEmailTool = await composio.tools.get('user123', 'GMAIL_SEND_EMAIL');
```typescript
import { Composio } from '@composio/core';
-import { OpenAIToolset } from '@composio/openai';
+import { OpenAIProvider } from '@composio/openai';
import OpenAI from 'openai';
const composio = new Composio({
apiKey: process.env.COMPOSIO_API_KEY,
- toolset: new OpenAIToolset(),
+ provider: new OpenAIProvider(),
});
// Example API route
@@ -83,12 +83,12 @@ export async function POST(req: Request) {
```typescript
import { Composio } from '@composio/core';
-import { OpenAIToolset } from '@composio/openai';
+import { OpenAIProvider } from '@composio/openai';
import OpenAI from 'openai';
const composio = new Composio({
apiKey: process.env.COMPOSIO_API_KEY,
- toolset: new OpenAIToolset(),
+ provider: new OpenAIProvider(),
});
// Example API route that handles tool execution
@@ -110,7 +110,7 @@ export async function POST(req: Request) {
for await (const chunk of stream) {
if (chunk.choices[0]?.delta?.tool_calls) {
const toolCall = chunk.choices[0].delta.tool_calls[0];
- const result = await composio.toolset.executeToolCall(toolCall);
+ const result = await composio.provider.executeToolCall(toolCall);
// Handle tool execution result
chunks.push(result);
} else {
@@ -130,12 +130,12 @@ export async function POST(req: Request) {
```typescript
import { Composio } from '@composio/core';
-import { OpenAIToolset } from '@composio/openai';
+import { OpenAIProvider } from '@composio/openai';
import OpenAI from 'openai';
const composio = new Composio({
apiKey: process.env.COMPOSIO_API_KEY,
- toolset: new OpenAIToolset(),
+ provider: new OpenAIProvider(),
});
// Example API route that returns JSON
@@ -160,12 +160,12 @@ export async function POST(req: Request) {
```typescript
import { Composio } from '@composio/core';
-import { OpenAIToolset } from '@composio/openai';
+import { OpenAIProvider } from '@composio/openai';
import OpenAI from 'openai';
const composio = new Composio({
apiKey: process.env.COMPOSIO_API_KEY,
- toolset: new OpenAIToolset(),
+ provider: new OpenAIProvider(),
});
// Example API route that handles image analysis
@@ -199,9 +199,9 @@ export async function POST(req: Request) {
## API Reference
-### OpenAIToolset Class
+### OpenAIProvider Class
-The `OpenAIToolset` class extends `BaseComposioToolset` and provides OpenAI-specific functionality.
+The `OpenAIProvider` class extends `BaseComposioProvider` and provides OpenAI-specific functionality.
#### Methods
@@ -210,7 +210,7 @@ The `OpenAIToolset` class extends `BaseComposioToolset` and provides OpenAI-spec
Executes a tool call and returns the result.
```typescript
-const result = await toolset.executeToolCall(toolCall);
+const result = await provider.executeToolCall(toolCall);
```
## Contributing
diff --git a/packages/toolsets/openai/package.json b/packages/providers/openai/package.json
similarity index 95%
rename from packages/toolsets/openai/package.json
rename to packages/providers/openai/package.json
index fc46db871..793484e91 100644
--- a/packages/toolsets/openai/package.json
+++ b/packages/providers/openai/package.json
@@ -33,7 +33,7 @@
"openai": "^4.3.8"
},
"devDependencies": {
- "@composio/core": "^0.1.10-alpha.0",
+ "@composio/core": "workspace:*",
"tsup": "^8.4.0",
"typescript": "^5.8.3",
"vitest": "^3.1.3"
diff --git a/packages/providers/openai/src/index.ts b/packages/providers/openai/src/index.ts
new file mode 100644
index 000000000..5750988c1
--- /dev/null
+++ b/packages/providers/openai/src/index.ts
@@ -0,0 +1,15 @@
+/**
+ * OpenAI Provider
+ *
+ * Author: Musthaq Ahamad <[email protected]>
+ * Core Reference: /packages/core/src/provider/OpenAIProvider.ts
+ * Legacy Reference: https://github.com/ComposioHQ/composio/blob/master/js/src/frameworks/openai.ts
+ *
+ * This provider provides a set of tools for interacting with OpenAI's API.
+ * The provider is shipped with Composio Core and is ready to use.
+ * This export is just a convenience export for external usage, and is not required for using with Composio.
+ *
+ * @packageDocumentation
+ * @module providers/openai
+ */
+export { OpenAIProvider } from '@composio/core';
diff --git a/packages/toolsets/openai/test/openai.test.ts b/packages/providers/openai/test/openai.test.ts
similarity index 88%
rename from packages/toolsets/openai/test/openai.test.ts
rename to packages/providers/openai/test/openai.test.ts
index 71394c740..d8de60eb4 100644
--- a/packages/toolsets/openai/test/openai.test.ts
+++ b/packages/providers/openai/test/openai.test.ts
@@ -1,5 +1,5 @@
import { describe, it, expect, vi, beforeEach } from 'vitest';
-import { OpenAIToolset } from '../src';
+import { OpenAIProvider } from '../src';
import { Tool } from '@composio/core';
import { OpenAI } from 'openai';
@@ -39,13 +39,13 @@ interface MockedOpenAIChatCompletionTool {
};
}
-describe('OpenAIToolset', () => {
- let toolset: OpenAIToolset;
+describe('OpenAIProvider', () => {
+ let provider: OpenAIProvider;
let mockTool: Tool;
let mockExecuteToolFn: any;
beforeEach(() => {
- toolset = new OpenAIToolset();
+ provider = new OpenAIProvider();
// Mock the global execute tool function
mockExecuteToolFn = vi.fn().mockResolvedValue({
@@ -53,7 +53,7 @@ describe('OpenAIToolset', () => {
error: null,
successful: true,
});
- toolset._setExecuteToolFn(mockExecuteToolFn);
+ provider._setExecuteToolFn(mockExecuteToolFn);
// Create a mock Composio tool
mockTool = {
@@ -79,19 +79,19 @@ describe('OpenAIToolset', () => {
describe('name property', () => {
it('should have the correct name', () => {
- expect(toolset.name).toBe('openai');
+ expect(provider.name).toBe('openai');
});
});
describe('_isAgentic property', () => {
it('should be non-agentic', () => {
- expect(toolset._isAgentic).toBe(false);
+ expect(provider._isAgentic).toBe(false);
});
});
describe('wrapTool', () => {
it('should wrap a tool in OpenAI function format', () => {
- const wrapped = toolset.wrapTool(mockTool) as MockedOpenAIChatCompletionTool;
+ const wrapped = provider.wrapTool(mockTool) as MockedOpenAIChatCompletionTool;
expect(wrapped).toEqual({
type: 'function',
@@ -109,7 +109,7 @@ describe('OpenAIToolset', () => {
inputParameters: undefined,
};
- const wrapped = toolset.wrapTool(toolWithoutParams) as MockedOpenAIChatCompletionTool;
+ const wrapped = provider.wrapTool(toolWithoutParams) as MockedOpenAIChatCompletionTool;
expect(wrapped).toEqual({
type: 'function',
@@ -131,7 +131,7 @@ describe('OpenAIToolset', () => {
};
const tools = [mockTool, anotherTool];
- const wrapped = toolset.wrapTools(tools);
+ const wrapped = provider.wrapTools(tools);
// Verify the result is an array of the right length
expect(wrapped).toHaveLength(2);
@@ -157,7 +157,7 @@ describe('OpenAIToolset', () => {
});
it('should return an empty array for empty tools array', () => {
- const wrapped = toolset.wrapTools([]);
+ const wrapped = provider.wrapTools([]);
expect(wrapped).toEqual([]);
});
});
@@ -174,7 +174,7 @@ describe('OpenAIToolset', () => {
},
} as OpenAI.ChatCompletionMessageToolCall;
- const result = await toolset.executeToolCall(userId, toolCall);
+ const result = await provider.executeToolCall(userId, toolCall);
expect(mockExecuteToolFn).toHaveBeenCalledWith(
'test-tool',
@@ -218,7 +218,7 @@ describe('OpenAIToolset', () => {
afterToolExecute: vi.fn(response => response),
};
- await toolset.executeToolCall(userId, toolCall, options, modifiers);
+ await provider.executeToolCall(userId, toolCall, options, modifiers);
expect(mockExecuteToolFn).toHaveBeenCalledWith(
'test-tool',
@@ -268,10 +268,10 @@ describe('OpenAIToolset', () => {
},
} as OpenAI.ChatCompletion;
- const executeToolCallSpy = vi.spyOn(toolset, 'executeToolCall');
+ const executeToolCallSpy = vi.spyOn(provider, 'executeToolCall');
executeToolCallSpy.mockResolvedValue(JSON.stringify({ result: 'success' }));
- const results = await toolset.handleToolCall(userId, chatCompletion);
+ const results = await provider.handleToolCall(userId, chatCompletion);
expect(executeToolCallSpy).toHaveBeenCalledWith(
userId,
@@ -334,12 +334,12 @@ describe('OpenAIToolset', () => {
},
} as OpenAI.ChatCompletion;
- const executeToolCallSpy = vi.spyOn(toolset, 'executeToolCall');
+ const executeToolCallSpy = vi.spyOn(provider, 'executeToolCall');
executeToolCallSpy
.mockResolvedValueOnce(JSON.stringify({ result: 'success-1' }))
.mockResolvedValueOnce(JSON.stringify({ result: 'success-2' }));
- const results = await toolset.handleToolCall(userId, chatCompletion);
+ const results = await provider.handleToolCall(userId, chatCompletion);
expect(executeToolCallSpy).toHaveBeenCalledTimes(2);
expect(executeToolCallSpy).toHaveBeenNthCalledWith(
@@ -384,10 +384,10 @@ describe('OpenAIToolset', () => {
},
} as unknown as OpenAI.Beta.Threads.Run;
- const executeToolCallSpy = vi.spyOn(toolset, 'executeToolCall');
+ const executeToolCallSpy = vi.spyOn(provider, 'executeToolCall');
executeToolCallSpy.mockResolvedValue(JSON.stringify({ result: 'success' }));
- const toolOutputs = await toolset.handleAssistantMessage(userId, run);
+ const toolOutputs = await provider.handleAssistantMessage(userId, run);
expect(executeToolCallSpy).toHaveBeenCalledWith(
userId,
@@ -410,9 +410,9 @@ describe('OpenAIToolset', () => {
id: 'run-123',
} as OpenAI.Beta.Threads.Run;
- const executeToolCallSpy = vi.spyOn(toolset, 'executeToolCall');
+ const executeToolCallSpy = vi.spyOn(provider, 'executeToolCall');
- const toolOutputs = await toolset.handleAssistantMessage(userId, run);
+ const toolOutputs = await provider.handleAssistantMessage(userId, run);
expect(executeToolCallSpy).not.toHaveBeenCalled();
expect(toolOutputs).toEqual([]);
@@ -427,7 +427,7 @@ describe('OpenAIToolset', () => {
arguments: { input: 'test-value' },
};
- const result = await toolset.executeTool(toolSlug, toolParams);
+ const result = await provider.executeTool(toolSlug, toolParams);
expect(mockExecuteToolFn).toHaveBeenCalledWith(toolSlug, toolParams, undefined);
expect(result).toEqual({
@@ -449,7 +449,7 @@ describe('OpenAIToolset', () => {
afterToolExecute: vi.fn(response => response),
};
- await toolset.executeTool(toolSlug, toolParams, modifiers);
+ await provider.executeTool(toolSlug, toolParams, modifiers);
expect(mockExecuteToolFn).toHaveBeenCalledWith(toolSlug, toolParams, modifiers);
});
@@ -479,7 +479,7 @@ describe('OpenAIToolset', () => {
},
} as OpenAI.Beta.Threads.Run;
- const handleAssistantMessageSpy = vi.spyOn(toolset, 'handleAssistantMessage');
+ const handleAssistantMessageSpy = vi.spyOn(provider, 'handleAssistantMessage');
handleAssistantMessageSpy.mockResolvedValue([
{
tool_call_id: 'tool-call-123',
@@ -487,7 +487,7 @@ describe('OpenAIToolset', () => {
},
]);
- const result = await toolset.waitAndHandleAssistantToolCalls(userId, client, run, thread);
+ const result = await provider.waitAndHandleAssistantToolCalls(userId, client, run, thread);
expect(handleAssistantMessageSpy).toHaveBeenCalledWith(userId, run, undefined, undefined);
expect(client.beta.threads.runs.submitToolOutputs).toHaveBeenCalledWith(thread.id, run.id, {
diff --git a/packages/toolsets/openai/tsconfig.json b/packages/providers/openai/tsconfig.json
similarity index 100%
rename from packages/toolsets/openai/tsconfig.json
rename to packages/providers/openai/tsconfig.json
diff --git a/packages/toolsets/openai/tsup.config.ts b/packages/providers/openai/tsup.config.ts
similarity index 100%
rename from packages/toolsets/openai/tsup.config.ts
rename to packages/providers/openai/tsup.config.ts
diff --git a/packages/toolsets/vercel/README.md b/packages/providers/vercel/README.md
similarity index 83%
rename from packages/toolsets/vercel/README.md
rename to packages/providers/vercel/README.md
index 0e71a456c..7f4631adf 100644
--- a/packages/toolsets/vercel/README.md
+++ b/packages/providers/vercel/README.md
@@ -1,6 +1,6 @@
# @composio/vercel
-The Vercel AI SDK toolset for Composio SDK, providing seamless integration with Vercel's AI SDK and tools.
+The Vercel AI SDK provider for Composio SDK, providing seamless integration with Vercel's AI SDK and tools.
## Features
@@ -25,12 +25,12 @@ pnpm add @composio/vercel
```typescript
import { Composio } from '@composio/core';
-import { VercelToolset } from '@composio/vercel';
+import { VercelProvider } from '@composio/vercel';
-// Initialize Composio with Vercel toolset
+// Initialize Composio with Vercel provider
const composio = new Composio({
apiKey: 'your-composio-api-key',
- toolset: new VercelToolset(),
+ provider: new VercelProvider(),
});
// Get available tools
@@ -49,13 +49,13 @@ const sendEmailTool = await composio.tools.get('user123', 'GMAIL_SEND_EMAIL');
```typescript
import { Composio } from '@composio/core';
-import { VercelToolset } from '@composio/vercel';
+import { VercelProvider } from '@composio/vercel';
import { useChat } from 'ai/react';
-// Initialize Composio with Vercel toolset
+// Initialize Composio with Vercel provider
const composio = new Composio({
apiKey: process.env.COMPOSIO_API_KEY,
- toolset: new VercelToolset()
+ provider: new VercelProvider()
});
// In your React component
@@ -109,12 +109,12 @@ export async function POST(req: Request) {
```typescript
import { Composio } from '@composio/core';
-import { VercelToolset } from '@composio/vercel';
+import { VercelProvider } from '@composio/vercel';
import { streamText } from 'ai';
const composio = new Composio({
apiKey: process.env.COMPOSIO_API_KEY,
- toolset: new VercelToolset(),
+ provider: new VercelProvider(),
});
// Example API route that handles tool execution
@@ -131,7 +131,7 @@ export async function POST(req: Request) {
callbacks: {
onToolCall: async tool => {
// Execute the tool and return result
- return await composio.toolset.executeToolCall(tool);
+ return await composio.provider.executeToolCall(tool);
},
},
});
@@ -144,12 +144,12 @@ export async function POST(req: Request) {
```typescript
import { Composio } from '@composio/core';
-import { VercelToolset } from '@composio/vercel';
+import { VercelProvider } from '@composio/vercel';
import { streamObject } from 'ai';
const composio = new Composio({
apiKey: process.env.COMPOSIO_API_KEY,
- toolset: new VercelToolset(),
+ provider: new VercelProvider(),
});
// Example API route that returns structured data
@@ -180,9 +180,9 @@ export async function POST(req: Request) {
## API Reference
-### VercelToolset Class
+### VercelProvider Class
-The `VercelToolset` class extends `BaseComposioToolset` and provides Vercel AI SDK-specific functionality.
+The `VercelProvider` class extends `BaseComposioProvider` and provides Vercel AI SDK-specific functionality.
#### Methods
@@ -191,7 +191,7 @@ The `VercelToolset` class extends `BaseComposioToolset` and provides Vercel AI S
Executes a tool call and returns the result.
```typescript
-const result = await toolset.executeToolCall(toolCall);
+const result = await provider.executeToolCall(toolCall);
```
##### `handleToolCalls(stream: AIStream): AsyncGenerator<AIStreamEvent>`
@@ -199,7 +199,7 @@ const result = await toolset.executeToolCall(toolCall);
Handles tool calls from a stream and yields events.
```typescript
-for await (const event of toolset.handleToolCalls(stream)) {
+for await (const event of provider.handleToolCalls(stream)) {
// Handle events
}
```
diff --git a/packages/toolsets/vercel/package.json b/packages/providers/vercel/package.json
similarity index 95%
rename from packages/toolsets/vercel/package.json
rename to packages/providers/vercel/package.json
index b0870e4f4..cd9a85dc3 100644
--- a/packages/toolsets/vercel/package.json
+++ b/packages/providers/vercel/package.json
@@ -33,7 +33,7 @@
"ai": "^4.3.8"
},
"devDependencies": {
- "@composio/core": "^0.1.10-alpha.0",
+ "@composio/core": "workspace:*",
"tsup": "^8.4.0",
"typescript": "^5.8.3",
"vitest": "^3.1.3"
diff --git a/packages/toolsets/vercel/src/index.ts b/packages/providers/vercel/src/index.ts
similarity index 82%
rename from packages/toolsets/vercel/src/index.ts
rename to packages/providers/vercel/src/index.ts
index 1da1c5703..2a5cbb256 100644
--- a/packages/toolsets/vercel/src/index.ts
+++ b/packages/providers/vercel/src/index.ts
@@ -1,21 +1,21 @@
/**
- * Vercel AI Toolset
+ * Vercel AI Provider
* To be used with the Vercel AI SDK
*
* Author: Musthaq Ahamad <[email protected]>
* Legacy Reference: https://github.com/ComposioHQ/composio/blob/master/js/src/frameworks/vercel.ts
*
- * This toolset provides a set of tools for interacting with Vercel AI SDK.
+ * This provider provides a set of tools for interacting with Vercel AI SDK.
*
* @packageDocumentation
- * @module toolsets/vercel
+ * @module providers/vercel
*/
-import { BaseAgenticToolset, Tool as ComposioTool, ExecuteToolFn } from '@composio/core';
+import { BaseAgenticProvider, Tool as ComposioTool, ExecuteToolFn } from '@composio/core';
import type { Tool as VercelTool } from 'ai';
import { jsonSchema, tool } from 'ai';
type VercelToolCollection = Record<string, VercelTool>;
-export class VercelToolset extends BaseAgenticToolset<VercelToolCollection, VercelTool> {
+export class VercelProvider extends BaseAgenticProvider<VercelToolCollection, VercelTool> {
readonly name = 'vercel';
/**
diff --git a/packages/toolsets/vercel/test/vercel.test.ts b/packages/providers/vercel/test/vercel.test.ts
similarity index 86%
rename from packages/toolsets/vercel/test/vercel.test.ts
rename to packages/providers/vercel/test/vercel.test.ts
index cf89397a0..9456e6b35 100644
--- a/packages/toolsets/vercel/test/vercel.test.ts
+++ b/packages/providers/vercel/test/vercel.test.ts
@@ -1,5 +1,5 @@
import { describe, it, expect, vi, beforeEach } from 'vitest';
-import { VercelToolset } from '../src';
+import { VercelProvider } from '../src';
import { Tool } from '@composio/core';
import { jsonSchema, tool } from 'ai';
@@ -24,13 +24,13 @@ vi.mock('ai', () => {
};
});
-describe('VercelToolset', () => {
- let toolset: VercelToolset;
+describe('VercelProvider', () => {
+ let provider: VercelProvider;
let mockTool: Tool;
let mockExecuteToolFn: any;
beforeEach(() => {
- toolset = new VercelToolset();
+ provider = new VercelProvider();
// Mock the global execute tool function
mockExecuteToolFn = vi.fn().mockResolvedValue({
@@ -38,7 +38,7 @@ describe('VercelToolset', () => {
error: null,
successful: true,
});
- toolset._setExecuteToolFn(mockExecuteToolFn);
+ provider._setExecuteToolFn(mockExecuteToolFn);
// Create a mock Composio tool
mockTool = {
@@ -64,19 +64,19 @@ describe('VercelToolset', () => {
describe('name property', () => {
it('should have the correct name', () => {
- expect(toolset.name).toBe('vercel');
+ expect(provider.name).toBe('vercel');
});
});
describe('_isAgentic property', () => {
it('should be agentic', () => {
- expect(toolset._isAgentic).toBe(true);
+ expect(provider._isAgentic).toBe(true);
});
});
describe('wrapTool', () => {
it('should wrap a tool in Vercel tool format', () => {
- const wrapped = toolset.wrapTool(mockTool, mockExecuteToolFn) as unknown as MockedVercelTool;
+ const wrapped = provider.wrapTool(mockTool, mockExecuteToolFn) as unknown as MockedVercelTool;
expect(tool).toHaveBeenCalledWith({
description: mockTool.description,
@@ -94,7 +94,7 @@ describe('VercelToolset', () => {
inputParameters: undefined,
};
- const wrapped = toolset.wrapTool(
+ const wrapped = provider.wrapTool(
toolWithoutParams,
mockExecuteToolFn
) as unknown as MockedVercelTool;
@@ -104,7 +104,7 @@ describe('VercelToolset', () => {
});
it('should create a function that executes the tool with the right parameters', async () => {
- toolset.wrapTool(mockTool, mockExecuteToolFn) as unknown as MockedVercelTool;
+ provider.wrapTool(mockTool, mockExecuteToolFn) as unknown as MockedVercelTool;
// Extract the execute function from the call to tool()
const executeFunction = (tool as any).mock.calls[0][0].execute;
@@ -133,7 +133,7 @@ describe('VercelToolset', () => {
};
const tools = [mockTool, anotherTool];
- const wrapped = toolset.wrapTools(tools, mockExecuteToolFn);
+ const wrapped = provider.wrapTools(tools, mockExecuteToolFn);
// Verify the result has the expected properties
expect(Object.keys(wrapped)).toHaveLength(2);
@@ -155,7 +155,7 @@ describe('VercelToolset', () => {
});
it('should return an empty object for empty tools array', () => {
- const wrapped = toolset.wrapTools([], mockExecuteToolFn);
+ const wrapped = provider.wrapTools([], mockExecuteToolFn);
expect(wrapped).toEqual({});
expect(tool).not.toHaveBeenCalled();
});
@@ -169,7 +169,7 @@ describe('VercelToolset', () => {
arguments: { input: 'test-value' },
};
- const result = await toolset.executeTool(toolSlug, toolParams);
+ const result = await provider.executeTool(toolSlug, toolParams);
expect(mockExecuteToolFn).toHaveBeenCalledWith(toolSlug, toolParams, undefined);
expect(result).toEqual({
@@ -191,7 +191,7 @@ describe('VercelToolset', () => {
afterToolExecute: vi.fn(response => response),
};
- await toolset.executeTool(toolSlug, toolParams, modifiers);
+ await provider.executeTool(toolSlug, toolParams, modifiers);
expect(mockExecuteToolFn).toHaveBeenCalledWith(toolSlug, toolParams, modifiers);
});
@@ -199,7 +199,7 @@ describe('VercelToolset', () => {
describe('integration with Vercel AI SDK', () => {
it('should produce tools compatible with Vercel AI SDK', () => {
- const wrapped = toolset.wrapTool(mockTool, mockExecuteToolFn) as unknown as MockedVercelTool;
+ const wrapped = provider.wrapTool(mockTool, mockExecuteToolFn) as unknown as MockedVercelTool;
// Verify the wrapped tool has the expected structure
expect(wrapped).toHaveProperty('description');
diff --git a/packages/toolsets/vercel/tsconfig.json b/packages/providers/vercel/tsconfig.json
similarity index 100%
rename from packages/toolsets/vercel/tsconfig.json
rename to packages/providers/vercel/tsconfig.json
diff --git a/packages/toolsets/vercel/tsup.config.ts b/packages/providers/vercel/tsup.config.ts
similarity index 100%
rename from packages/toolsets/vercel/tsup.config.ts
rename to packages/providers/vercel/tsup.config.ts
diff --git a/packages/toolsets/openai/src/index.ts b/packages/toolsets/openai/src/index.ts
deleted file mode 100644
index b4c083480..000000000
--- a/packages/toolsets/openai/src/index.ts
+++ /dev/null
@@ -1,15 +0,0 @@
-/**
- * OpenAI Toolset
- *
- * Author: Musthaq Ahamad <[email protected]>
- * Core Reference: /packages/core/src/toolset/OpenAIToolset.ts
- * Legacy Reference: https://github.com/ComposioHQ/composio/blob/master/js/src/frameworks/openai.ts
- *
- * This toolset provides a set of tools for interacting with OpenAI's API.
- * The toolset is shipped with Composio Core and is ready to use.
- * This export is just a convenience export for external usage, and is not required for using with Composio.
- *
- * @packageDocumentation
- * @module toolsets/openai
- */
-export { OpenAIToolset } from '@composio/core';
diff --git a/packages/wrappers/README.md b/packages/wrappers/README.md
index 1f61bfcf3..e92f1b241 100644
--- a/packages/wrappers/README.md
+++ b/packages/wrappers/README.md
@@ -17,7 +17,7 @@ Composio Wrappers provide runtime-specific implementations of Composio Core func
### Core Components
- **@composio/core**: The main package containing core functionality and interfaces
-- **BaseComposioToolset**: Abstract base class for creating custom toolsets
+- **BaseComposioProvider**: Abstract base class for creating custom providers
### Telemetry
@@ -53,7 +53,7 @@ class BrowserRuntimeWrapper {
...config,
// Add browser-specific configurations
allowTracking: true,
- telemetryTransport: new BrowserTelemetryTransport()
+ telemetryTransport: new BrowserTelemetryTransport(),
});
}
@@ -84,7 +84,7 @@ const config = {
runtime: 'browser',
userId: 'user-id',
connectedAccountIds: {},
- telemetryTransport: new RuntimeSpecificTelemetryTransport()
+ telemetryTransport: new RuntimeSpecificTelemetryTransport(),
};
```
@@ -113,7 +113,7 @@ class BrowserWrapper {
this.composio = new Composio({
...config,
runtime: 'browser',
- telemetryTransport: new BrowserTelemetryTransport()
+ telemetryTransport: new BrowserTelemetryTransport(),
});
}
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
index 3c56181ca..0af468b68 100644
--- a/pnpm-lock.yaml
+++ b/pnpm-lock.yaml
@@ -65,7 +65,7 @@ importers:
version: link:../../packages/core
'@composio/langchain':
specifier: workspace:*
- version: link:../../packages/toolsets/langchain
+ version: link:../../packages/providers/langchain
'@langchain/core':
specifier: ^0.3.56
@@ -99,7 +99,7 @@ importers:
version: link:../../packages/core
'@composio/vercel':
specifier: workspace:*
- version: link:../../packages/toolsets/vercel
+ version: link:../../packages/providers/vercel
ai:
specifier: ^4.3.8
@@ -140,7 +140,7 @@ importers:
version: link:../../packages/core
'@composio/vercel':
specifier: workspace:*
- version: link:../../packages/toolsets/vercel
+ version: link:../../packages/providers/vercel
ai:
specifier: ^4.3.8
@@ -162,7 +162,7 @@ importers:
version: link:../../packages/core
'@composio/vercel':
specifier: workspace:*
- version: link:../../packages/toolsets/vercel
+ version: link:../../packages/providers/vercel
ai:
specifier: ^4.3.8
@@ -211,15 +211,15 @@ importers:
specifier: ^3.1.3
- packages/toolsets/cloudflare:
+ packages/providers/cloudflare:
dependencies:
'@cloudflare/workers-types':
specifier: ^4.20250416.0
version: 4.20250515.0
devDependencies:
'@composio/core':
- specifier: ^0.1.10-alpha.0
- version: 0.1.10-alpha.0([email protected])
+ specifier: workspace:*
+ version: link:../../core
tsup:
specifier: ^8.4.0
@@ -230,15 +230,15 @@ importers:
specifier: ^3.1.3
- packages/toolsets/langchain:
+ packages/providers/langchain:
dependencies:
'@langchain/core':
specifier: ^0.3.44
devDependencies:
'@composio/core':
- specifier: ^0.1.10-alpha.0
- version: 0.1.10-alpha.0([email protected])
+ specifier: workspace:*
+ version: link:../../core
tsup:
specifier: ^8.4.0
@@ -249,15 +249,15 @@ importers:
specifier: ^3.1.3
- packages/toolsets/openai:
+ packages/providers/openai:
dependencies:
openai:
specifier: ^4.3.8
devDependencies:
'@composio/core':
- specifier: ^0.1.10-alpha.0
- version: 0.1.10-alpha.0([email protected])
+ specifier: workspace:*
+ version: link:../../core
tsup:
specifier: ^8.4.0
@@ -268,15 +268,15 @@ importers:
specifier: ^3.1.3
- packages/toolsets/vercel:
+ packages/providers/vercel:
dependencies:
ai:
specifier: ^4.3.8
devDependencies:
'@composio/core':
- specifier: ^0.1.10-alpha.0
- version: 0.1.10-alpha.0([email protected])
+ specifier: workspace:*
+ version: link:../../core
tsup:
specifier: ^8.4.0
@@ -338,9 +338,6 @@ packages:
'@composio/[email protected]':
resolution: {integrity: sha512-ieaVXwx9A0zKvLS6yFEr7YZCAoBHQrPzFK8jTjN8QDjqLdQEuufuFfzM5ZUEN5UCX2bckR77OplZZjAn3TikWA==}
- '@composio/[email protected]':
- resolution: {integrity: sha512-PMXrHEIg7rLGtd0dqvU1lSNRoQOGSIU4XWSu1u6hL/6W/mekO0ZEQnwZLEKaYQMT6Nq3ALvnzV3CVX4IP+5XCg==}
-
'@emnapi/[email protected]':
resolution: {integrity: sha512-4m62DuCE07lw01soJwPiBGC0nAww0Q+RY70VZ+n49yDIO13yyinhbWCeNnaob0lakDtWQzSdtNWzJeOJt2ma+g==}
@@ -4011,18 +4008,6 @@ snapshots:
'@composio/[email protected]': {}
- dependencies:
- '@composio/client': 0.1.0-alpha.10
- pusher-js: 8.4.0
- uuid: 11.1.0
- zod: 3.24.4
- zod-to-json-schema: 3.24.5([email protected])
- transitivePeerDependencies:
- - encoding
- - ws
-
'@emnapi/[email protected]':
dependencies:
'@emnapi/wasi-threads': 1.0.2
diff --git a/pnpm-workspace.yaml b/pnpm-workspace.yaml
index 5c64f4ba2..fb8d6cc8f 100644
--- a/pnpm-workspace.yaml
+++ b/pnpm-workspace.yaml
@@ -1,4 +1,4 @@
packages:
- 'packages/core'
- - 'packages/toolsets/*'
- - 'examples/*'
\ No newline at end of file
+ - 'packages/providers/*'
+ - 'examples/*'
diff --git a/scripts/check-peer-deps.ts b/scripts/check-peer-deps.ts
index 1d92709ea..7526da337 100644
--- a/scripts/check-peer-deps.ts
+++ b/scripts/check-peer-deps.ts
@@ -3,34 +3,34 @@ import path from 'path';
import semver from 'semver';
const corePkgPackageJson = path.resolve(__dirname, '../packages/core/package.json');
-const toolsetsDir = path.resolve(__dirname, '../packages/toolsets');
+const providersDir = path.resolve(__dirname, '../packages/providers');
const corePkg = JSON.parse(fs.readFileSync(corePkgPackageJson, 'utf-8'));
const coreVersion = corePkg.version;
-const toolsetDirs = fs.readdirSync(toolsetsDir).filter(name => {
- const fullPath = path.resolve(toolsetsDir, name);
+const providerDirs = fs.readdirSync(providersDir).filter(name => {
+ const fullPath = path.resolve(providersDir, name);
return fs.existsSync(path.join(fullPath, 'package.json'));
});
let hasError = false;
-for (const dir of toolsetDirs) {
- const pkgPath = path.resolve(toolsetsDir, dir, 'package.json');
+for (const dir of providerDirs) {
+ const pkgPath = path.resolve(providersDir, dir, 'package.json');
const pkg = JSON.parse(fs.readFileSync(pkgPath, 'utf-8'));
const peerDeps = pkg.peerDependencies || {};
const declaredCoreVersion = peerDeps['@composio/core'];
if (!declaredCoreVersion) {
- console.error(`[ERROR] Toolset ${dir} does not declare @composio/core as a peerDependency`);
+ console.error(`[ERROR] Provider ${dir} does not declare @composio/core as a peerDependency`);
hasError = true;
continue;
}
if (!semver.satisfies(coreVersion, declaredCoreVersion)) {
console.error(
- `[ERROR] Toolset ${dir} declares incompatible core version range: ${declaredCoreVersion} (current: ${coreVersion})`
+ `[ERROR] Provider ${dir} declares incompatible core version range: ${declaredCoreVersion} (current: ${coreVersion})`
);
hasError = true;
}
@@ -39,5 +39,5 @@ for (const dir of toolsetDirs) {
if (hasError) {
process.exit(1);
} else {
- console.log('✅ All toolsets declare compatible @composio/core peerDependencies.');
+ console.log('✅ All providers declare compatible @composio/core peerDependencies.');
}
diff --git a/scripts/create-toolset.sh b/scripts/create-provider.sh
similarity index 75%
rename from scripts/create-toolset.sh
rename to scripts/create-provider.sh
index f4b1ee408..ea88dce17 100644
--- a/scripts/create-toolset.sh
+++ b/scripts/create-provider.sh
@@ -1,17 +1,17 @@
#!/bin/bash
-# Check if toolset name is provided
+# Check if provider name is provided
if [ -z "$1" ]; then
- echo "Please provide a toolset name"
- echo "Usage: npm run create-toolset <toolset-name> [--agentic]"
+ echo "Please provide a provider name"
+ echo "Usage: npm run create-provider <provider-name> [--agentic]"
exit 1
fi
TOOLSET_NAME=$1
-TOOLSET_PATH="packages/toolsets/$TOOLSET_NAME"
+TOOLSET_PATH="packages/providers/$TOOLSET_NAME"
CAPITAL_TOOLSET_NAME="$(tr '[:lower:]' '[:upper:]' <<< ${TOOLSET_NAME:0:1})${TOOLSET_NAME:1}"
-# Check if toolset should be agentic
+# Check if provider should be agentic
IS_AGENTIC=false
if [ "$2" = "--agentic" ]; then
IS_AGENTIC=true
@@ -25,7 +25,7 @@ cat > "$TOOLSET_PATH/package.json" << EOL
{
"name": "@composio/${TOOLSET_NAME}",
"version": "0.1.0",
- "description": "${IS_AGENTIC:+Agentic }Toolset for ${TOOLSET_NAME} in Composio SDK",
+ "description": "${IS_AGENTIC:+Agentic }Provider for ${TOOLSET_NAME} in Composio SDK",
"main": "src/index.ts",
"type": "module",
"publishConfig": {
@@ -48,7 +48,7 @@ cat > "$TOOLSET_PATH/package.json" << EOL
"build": "tsup",
"test": "echo \\"Error: no test specified\\" && exit 1"
},
- "keywords": ["composio", "toolset", "${TOOLSET_NAME}"],
+ "keywords": ["composio", "provider", "${TOOLSET_NAME}"],
"author": "",
"license": "ISC",
"packageManager": "[email protected]",
@@ -100,14 +100,14 @@ EOL
# Create src/index.ts
cat > "$TOOLSET_PATH/src/index.ts" << EOL
/**
- * ${CAPITAL_TOOLSET_NAME} Toolset
+ * ${CAPITAL_TOOLSET_NAME} Provider
*
- * This toolset provides a set of tools for interacting with ${CAPITAL_TOOLSET_NAME}.
+ * This provider provides a set of tools for interacting with ${CAPITAL_TOOLSET_NAME}.
*
* @packageDocumentation
- * @module toolsets/${TOOLSET_NAME}
+ * @module providers/${TOOLSET_NAME}
*/
-import { ${IS_AGENTIC:+BaseAgenticToolset}${!IS_AGENTIC:+BaseNonAgenticToolset}, Tool${IS_AGENTIC:+, ExecuteToolFn} } from '@composio/core';
+import { ${IS_AGENTIC:+BaseAgenticProvider}${!IS_AGENTIC:+BaseNonAgenticProvider}, Tool${IS_AGENTIC:+, ExecuteToolFn} } from '@composio/core';
${IS_AGENTIC:+interface ${CAPITAL_TOOLSET_NAME}Tool {
// Add your tool type here
@@ -119,7 +119,7 @@ ${IS_AGENTIC:+interface ${CAPITAL_TOOLSET_NAME}ToolCollection {
// Add your tool collection type here
}}${!IS_AGENTIC:+type ${CAPITAL_TOOLSET_NAME}ToolCollection = Array<${CAPITAL_TOOLSET_NAME}Tool>}
-export class ${CAPITAL_TOOLSET_NAME}Toolset extends ${IS_AGENTIC:+BaseAgenticToolset}${!IS_AGENTIC:+BaseNonAgenticToolset}<${CAPITAL_TOOLSET_NAME}ToolCollection, ${CAPITAL_TOOLSET_NAME}Tool> {
+export class ${CAPITAL_TOOLSET_NAME}Provider extends ${IS_AGENTIC:+BaseAgenticProvider}${!IS_AGENTIC:+BaseNonAgenticProvider}<${CAPITAL_TOOLSET_NAME}ToolCollection, ${CAPITAL_TOOLSET_NAME}Tool> {
readonly name = '${TOOLSET_NAME}';
/**
@@ -157,7 +157,7 @@ EOL
cat > "$TOOLSET_PATH/README.md" << EOL
# @composio/${TOOLSET_NAME}
-${IS_AGENTIC:+Agentic }Toolset for ${CAPITAL_TOOLSET_NAME} in Composio SDK.
+${IS_AGENTIC:+Agentic }Provider for ${CAPITAL_TOOLSET_NAME} in Composio SDK.
## Features
@@ -180,12 +180,12 @@ pnpm add @composio/${TOOLSET_NAME}
\`\`\`typescript
import { Composio } from '@composio/core';
-import { ${CAPITAL_TOOLSET_NAME}Toolset } from '@composio/${TOOLSET_NAME}';
+import { ${CAPITAL_TOOLSET_NAME}Provider } from '@composio/${TOOLSET_NAME}';
-// Initialize Composio with ${CAPITAL_TOOLSET_NAME} toolset
+// Initialize Composio with ${CAPITAL_TOOLSET_NAME} provider
const composio = new Composio({
apiKey: 'your-composio-api-key',
- toolset: new ${CAPITAL_TOOLSET_NAME}Toolset(),
+ provider: new ${CAPITAL_TOOLSET_NAME}Provider(),
});
// Get available tools
@@ -201,12 +201,12 @@ const tools = await composio.tools.get('user123', {
\`\`\`typescript
import { Composio } from '@composio/core';
-import { ${CAPITAL_TOOLSET_NAME}Toolset } from '@composio/${TOOLSET_NAME}';
+import { ${CAPITAL_TOOLSET_NAME}Provider } from '@composio/${TOOLSET_NAME}';
// Initialize Composio
const composio = new Composio({
apiKey: process.env.COMPOSIO_API_KEY,
- toolset: new ${CAPITAL_TOOLSET_NAME}Toolset(),
+ provider: new ${CAPITAL_TOOLSET_NAME}Provider(),
});
// Get tools
@@ -220,9 +220,9 @@ const tools = await composio.tools.get('user123', {
## API Reference
-### ${CAPITAL_TOOLSET_NAME}Toolset Class
+### ${CAPITAL_TOOLSET_NAME}Provider Class
-The \`${CAPITAL_TOOLSET_NAME}Toolset\` class extends \`${IS_AGENTIC:+BaseAgenticToolset}${!IS_AGENTIC:+BaseNonAgenticToolset}\` and provides ${TOOLSET_NAME}-specific functionality.
+The \`${CAPITAL_TOOLSET_NAME}Provider\` class extends \`${IS_AGENTIC:+BaseAgenticProvider}${!IS_AGENTIC:+BaseNonAgenticProvider}\` and provides ${TOOLSET_NAME}-specific functionality.
#### Methods
@@ -231,7 +231,7 @@ The \`${CAPITAL_TOOLSET_NAME}Toolset\` class extends \`${IS_AGENTIC:+BaseAgentic
Wraps a tool in the ${TOOLSET_NAME} format.
\`\`\`typescript
-const tool = toolset.wrapTool(composioTool${IS_AGENTIC:+, executeTool});
+const tool = provider.wrapTool(composioTool${IS_AGENTIC:+, executeTool});
\`\`\`
## Contributing
@@ -253,5 +253,5 @@ chmod +x "$TOOLSET_PATH"
# Install dependencies using pnpm
cd "$TOOLSET_PATH" && pnpm install
-echo "✨ Created new ${IS_AGENTIC:+agentic }toolset at $TOOLSET_PATH"
+echo "✨ Created new ${IS_AGENTIC:+agentic }provider at $TOOLSET_PATH"
echo "✨ Dependencies installed successfully"
\ No newline at end of file
diff --git a/scripts/update-peer-deps.ts b/scripts/update-peer-deps.ts
index 4e1ee93ea..9758afbcb 100644
--- a/scripts/update-peer-deps.ts
+++ b/scripts/update-peer-deps.ts
@@ -1,5 +1,5 @@
/**
- * This script updates the peer dependencies of all toolsets to the latest version of the core package.
+ * This script updates the peer dependencies of all providers to the latest version of the core package.
* It reads the core package version from the core package's package.json file.
*/
@@ -19,18 +19,18 @@ if (coreVersion.includes('rc') || coreVersion.includes('alpha') || coreVersion.i
process.exit(0);
}
-const toolsetsDir = path.resolve(__dirname, '../packages/toolsets');
-const toolsetDirs = fs.readdirSync(toolsetsDir).filter(name => {
- const fullPath = path.resolve(toolsetsDir, name);
+const providersDir = path.resolve(__dirname, '../packages/providers');
+const providerDirs = fs.readdirSync(providersDir).filter(name => {
+ const fullPath = path.resolve(providersDir, name);
return fs.existsSync(path.join(fullPath, 'package.json'));
});
-for (const toolset of toolsetDirs) {
- const toolsetPackageJson = path.resolve(toolsetsDir, toolset, 'package.json');
- const toolsetPkg = JSON.parse(fs.readFileSync(toolsetPackageJson, 'utf-8'));
- toolsetPkg.peerDependencies['@composio/core'] = `^${coreVersion}`;
- fs.writeFileSync(toolsetPackageJson, JSON.stringify(toolsetPkg, null, 2));
+for (const provider of providerDirs) {
+ const providerPackageJson = path.resolve(providersDir, provider, 'package.json');
+ const providerPkg = JSON.parse(fs.readFileSync(providerPackageJson, 'utf-8'));
+ providerPkg.peerDependencies['@composio/core'] = `^${coreVersion}`;
+ fs.writeFileSync(providerPackageJson, JSON.stringify(providerPkg, null, 2));
console.log(
- `✅ Updated peer dependency for ${toolset} from ${toolsetPkg.peerDependencies['@composio/core']} -> ^${coreVersion}`
+ `✅ Updated peer dependency for ${provider} from ${providerPkg.peerDependencies['@composio/core']} -> ^${coreVersion}`
);
}