@composio/openai-agents 0.1.22

package/README.md

@@ -0,0 +1,78 @@
+# @composio/openai-agents
+
+The OpenAI Agents API provider for Composio SDK, providing seamless integration with OpenAI's Agents API and tools.
+
+## Features
+
+- **OpenAI Agents Integration**: Seamless integration with OpenAI's Agents SDK
+- **Tool Integration**: Easy integration of Composio tools with OpenAI Agents
+- **Type Safety**: Full TypeScript support with proper type definitions
+- **Strict Mode**: Support for strict mode tool parameter validation
+
+## Installation
+
+```bash
+npm install @composio/openai-agents @openai/agents
+# or
+yarn add @composio/openai-agents @openai/agents
+# or
+pnpm add @composio/openai-agents @openai/agents
+```
+
+## Environment Variables
+
+Required environment variables:
+
+- `COMPOSIO_API_KEY`: Your Composio API key
+- `OPENAI_API_KEY`: Your OpenAI API key
+
+## Example
+
+```typescript
+import { OpenAIAgentsProvider } from '@composio/openai-agents';
+import { Composio } from '@composio/core';
+import { Agent, run } from '@openai/agents';
+
+const composio = new Composio({
+  provider: new OpenAIAgentsProvider(),
+});
+
+// Fetch tools from Composio
+const tools = await composio.tools.get('default', 'HACKERNEWS_GET_USER', {
+  beforeExecute: async (toolSlug, toolkitSlug, params) => {
+    console.log(`🔄 Executing tool ${toolSlug} from toolkit ${toolkitSlug}...`);
+    return params;
+  },
+  afterExecute: async (toolSlug, toolkitSlug, result) => {
+    console.log(`✅ Tool ${toolSlug} executed`);
+    return result;
+  },
+});
+
+// Create an agent with the tools
+const agent = new Agent({
+  name: 'Hackernews assistant',
+  tools: tools,
+});
+
+// Run the agent with a query
+const result = await run(agent, 'Tell me about the user `pg` in hackernews');
+```
+
+## Provider Configuration
+
+The OpenAI Agents provider can be configured with various options:
+
+```typescript
+const provider = new OpenAIAgentsProvider({
+  strict: true, // Enable strict mode for tool parameters
+});
+```
+
+## Documentation
+
+For more information about OpenAI Agents and how to use them, see:
+
+- [OpenAI Strict Mode](https://openai.github.io/openai-agents-js/guides/tools/#options-reference)
+- [OpenAI Agents SDK Documentation](https://openai.github.io/openai-agents-js/)
+- [OpenAI Agents SDK GitHub](https://github.com/openai/openai-agents-js)

package/dist/index.cjs

@@ -0,0 +1,169 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  OpenAIAgentsProvider: () => OpenAIAgentsProvider
+});
+module.exports = __toCommonJS(index_exports);
+var import_core = require("@composio/core");
+var import_agents = require("@openai/agents");
+var OpenAIAgentsProvider = class extends import_core.BaseAgenticProvider {
+  name = "openai-agents";
+  strict;
+  /**
+   * Creates a new instance of the OpenAIAgentsProvider.
+   *
+   * This provider enables integration with the @openai/agents package,
+   * allowing Composio tools to be used with OpenAI Agents.
+   *
+   * @example
+   * ```typescript
+   * // Initialize the OpenAIAgentsProvider
+   * const provider = new OpenAIAgentsProvider();
+   *
+   * // Use with Composio
+   * const composio = new Composio({
+   *   apiKey: 'your-api-key',
+   *   provider: new OpenAIAgentsProvider()
+   * });
+   *
+   * // Use the provider to wrap tools for @openai/agents
+   * const vercelTools = provider.wrapTools(composioTools, composio.tools.execute);
+   * ```
+   */
+  constructor(options) {
+    super();
+    this.strict = options?.strict ?? false;
+  }
+  /**
+   * Wraps a Composio tool in a OpenAI Agents tool format.
+   *
+   * This method transforms a Composio tool definition into the format
+   * expected by @openai/agents for function calling.
+   *
+   * @param {ComposioTool} composioTool - The Composio tool to wrap
+   * @param {ExecuteToolFn} executeTool - Function to execute the tool
+   * @returns {OpenAIAgentsTool} The wrapped OpenAI Agents tool
+   *
+   * @example
+   * ```typescript
+   * // Wrap a single tool for use with Vercel AI SDK
+   * const composioTool = {
+   *   slug: 'SEARCH_TOOL',
+   *   description: 'Search for information',
+   *   inputParameters: {
+   *     type: 'object',
+   *     properties: {
+   *       query: { type: 'string' }
+   *     },
+   *     required: ['query']
+   *   }
+   * };
+   *
+   * // Create a Vercel tool using the provider
+   * const vercelTool = provider.wrapTool(
+   *   composioTool,
+   *   composio.tools.execute
+   * );
+   *
+   * // Use with Vercel AI SDK
+   * import { StreamingTextResponse, Message } from 'ai';
+   * import { OpenAI } from 'openai';
+   *
+   * export async function POST(req: Request) {
+   *   const { messages } = await req.json();
+   *   const openai = new OpenAI();
+   *
+   *   const response = await openai.chat.completions.create({
+   *     model: 'gpt-4',
+   *     messages,
+   *     tools: [vercelTool]
+   *   });
+   *
+   *   return new StreamingTextResponse(response.choices[0].message);
+   * }
+   * ```
+   */
+  wrapTool(composioTool, executeTool) {
+    return (0, import_agents.tool)({
+      name: composioTool.slug,
+      description: composioTool.description ?? "",
+      parameters: (0, import_core.jsonSchemaToZodSchema)(
+        composioTool.inputParameters ?? {},
+        {
+          strict: this.strict ? true : false
+        }
+      ),
+      execute: async (params) => {
+        const input = typeof params === "string" ? JSON.parse(params) : params;
+        return await executeTool(composioTool.slug, input);
+      }
+    });
+  }
+  /**
+   * Wraps a list of Composio tools as a OpenAI Agents tool collection.
+   *
+   * This method transforms multiple Composio tool definitions into the format
+   * expected by OpenAI Agents for function calling, organizing them
+   * into a dictionary keyed by tool slug.
+   *
+   * @param {ComposioTool[]} tools - Array of Composio tools to wrap
+   * @param {ExecuteToolFn} executeTool - Function to execute the tools
+   * @returns {OpenAIAgentsToolCollection} Dictionary of wrapped tools in OpenAI Agents format
+   *
+   * @example
+   * ```typescript
+   * // Get OpenAI Agents tools from Composio
+   * const composio = new Composio({
+   *   apiKey: 'your-api-key',
+   *   provider: new OpenAIAgentsProvider()
+   * });
+   *
+   * const tools = await composio.tools.get('default', {
+   *  toolkits: ['github'],
+   * });
+   *
+   * import { OpenAI } from '@openai/agents';
+   *
+   * export async function POST(req: Request) {
+   *   const { messages } = await req.json();
+   *   const openai = new OpenAI();
+   *
+   *   const response = await openai.chat.completions.create({
+   *     model: 'gpt-4',
+   *     messages,
+   *     tools: openaiAgentsTools
+   *   });
+   *
+   *   return new StreamingTextResponse(response.choices[0].message);
+   * }
+   * ```
+   */
+  wrapTools(tools, executeTool) {
+    return tools.map((tool) => {
+      return this.wrapTool(tool, executeTool);
+    });
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  OpenAIAgentsProvider
+});

package/dist/index.d.cts

@@ -0,0 +1,137 @@
+import { BaseAgenticProvider, Tool as Tool$1, ExecuteToolFn } from '@composio/core';
+import { Tool } from '@openai/agents';
+
+/**
+ * OpenAI Agents Provider
+ * To be used with the @openai/agents package
+ *
+ * Author: Musthaq Ahamad <musthaq@composio.dev>
+ * Reference: https://openai.github.io/openai-agents-js/
+ *
+ * This provider provides a set of tools for interacting with Vercel AI SDK.
+ *
+ * @packageDocumentation
+ * @module providers/openai-agents
+ */
+
+type OpenAIAgentsToolCollection = Array<Tool>;
+declare class OpenAIAgentsProvider extends BaseAgenticProvider<OpenAIAgentsToolCollection, Tool> {
+    readonly name = "openai-agents";
+    private strict;
+    /**
+     * Creates a new instance of the OpenAIAgentsProvider.
+     *
+     * This provider enables integration with the @openai/agents package,
+     * allowing Composio tools to be used with OpenAI Agents.
+     *
+     * @example
+     * ```typescript
+     * // Initialize the OpenAIAgentsProvider
+     * const provider = new OpenAIAgentsProvider();
+     *
+     * // Use with Composio
+     * const composio = new Composio({
+     *   apiKey: 'your-api-key',
+     *   provider: new OpenAIAgentsProvider()
+     * });
+     *
+     * // Use the provider to wrap tools for @openai/agents
+     * const vercelTools = provider.wrapTools(composioTools, composio.tools.execute);
+     * ```
+     */
+    constructor(options?: {
+        strict?: boolean;
+    });
+    /**
+     * Wraps a Composio tool in a OpenAI Agents tool format.
+     *
+     * This method transforms a Composio tool definition into the format
+     * expected by @openai/agents for function calling.
+     *
+     * @param {ComposioTool} composioTool - The Composio tool to wrap
+     * @param {ExecuteToolFn} executeTool - Function to execute the tool
+     * @returns {OpenAIAgentsTool} The wrapped OpenAI Agents tool
+     *
+     * @example
+     * ```typescript
+     * // Wrap a single tool for use with Vercel AI SDK
+     * const composioTool = {
+     *   slug: 'SEARCH_TOOL',
+     *   description: 'Search for information',
+     *   inputParameters: {
+     *     type: 'object',
+     *     properties: {
+     *       query: { type: 'string' }
+     *     },
+     *     required: ['query']
+     *   }
+     * };
+     *
+     * // Create a Vercel tool using the provider
+     * const vercelTool = provider.wrapTool(
+     *   composioTool,
+     *   composio.tools.execute
+     * );
+     *
+     * // Use with Vercel AI SDK
+     * import { StreamingTextResponse, Message } from 'ai';
+     * import { OpenAI } from 'openai';
+     *
+     * export async function POST(req: Request) {
+     *   const { messages } = await req.json();
+     *   const openai = new OpenAI();
+     *
+     *   const response = await openai.chat.completions.create({
+     *     model: 'gpt-4',
+     *     messages,
+     *     tools: [vercelTool]
+     *   });
+     *
+     *   return new StreamingTextResponse(response.choices[0].message);
+     * }
+     * ```
+     */
+    wrapTool(composioTool: Tool$1, executeTool: ExecuteToolFn): Tool;
+    /**
+     * Wraps a list of Composio tools as a OpenAI Agents tool collection.
+     *
+     * This method transforms multiple Composio tool definitions into the format
+     * expected by OpenAI Agents for function calling, organizing them
+     * into a dictionary keyed by tool slug.
+     *
+     * @param {ComposioTool[]} tools - Array of Composio tools to wrap
+     * @param {ExecuteToolFn} executeTool - Function to execute the tools
+     * @returns {OpenAIAgentsToolCollection} Dictionary of wrapped tools in OpenAI Agents format
+     *
+     * @example
+     * ```typescript
+     * // Get OpenAI Agents tools from Composio
+     * const composio = new Composio({
+     *   apiKey: 'your-api-key',
+     *   provider: new OpenAIAgentsProvider()
+     * });
+     *
+     * const tools = await composio.tools.get('default', {
+     *  toolkits: ['github'],
+     * });
+     *
+     * import { OpenAI } from '@openai/agents';
+     *
+     * export async function POST(req: Request) {
+     *   const { messages } = await req.json();
+     *   const openai = new OpenAI();
+     *
+     *   const response = await openai.chat.completions.create({
+     *     model: 'gpt-4',
+     *     messages,
+     *     tools: openaiAgentsTools
+     *   });
+     *
+     *   return new StreamingTextResponse(response.choices[0].message);
+     * }
+     * ```
+     */
+    wrapTools(tools: Tool$1[], executeTool: ExecuteToolFn): OpenAIAgentsToolCollection;
+}
+
+export { OpenAIAgentsProvider };

package/dist/index.d.ts

@@ -0,0 +1,137 @@
+import { BaseAgenticProvider, Tool as Tool$1, ExecuteToolFn } from '@composio/core';
+import { Tool } from '@openai/agents';
+
+/**
+ * OpenAI Agents Provider
+ * To be used with the @openai/agents package
+ *
+ * Author: Musthaq Ahamad <musthaq@composio.dev>
+ * Reference: https://openai.github.io/openai-agents-js/
+ *
+ * This provider provides a set of tools for interacting with Vercel AI SDK.
+ *
+ * @packageDocumentation
+ * @module providers/openai-agents
+ */
+
+type OpenAIAgentsToolCollection = Array<Tool>;
+declare class OpenAIAgentsProvider extends BaseAgenticProvider<OpenAIAgentsToolCollection, Tool> {
+    readonly name = "openai-agents";
+    private strict;
+    /**
+     * Creates a new instance of the OpenAIAgentsProvider.
+     *
+     * This provider enables integration with the @openai/agents package,
+     * allowing Composio tools to be used with OpenAI Agents.
+     *
+     * @example
+     * ```typescript
+     * // Initialize the OpenAIAgentsProvider
+     * const provider = new OpenAIAgentsProvider();
+     *
+     * // Use with Composio
+     * const composio = new Composio({
+     *   apiKey: 'your-api-key',
+     *   provider: new OpenAIAgentsProvider()
+     * });
+     *
+     * // Use the provider to wrap tools for @openai/agents
+     * const vercelTools = provider.wrapTools(composioTools, composio.tools.execute);
+     * ```
+     */
+    constructor(options?: {
+        strict?: boolean;
+    });
+    /**
+     * Wraps a Composio tool in a OpenAI Agents tool format.
+     *
+     * This method transforms a Composio tool definition into the format
+     * expected by @openai/agents for function calling.
+     *
+     * @param {ComposioTool} composioTool - The Composio tool to wrap
+     * @param {ExecuteToolFn} executeTool - Function to execute the tool
+     * @returns {OpenAIAgentsTool} The wrapped OpenAI Agents tool
+     *
+     * @example
+     * ```typescript
+     * // Wrap a single tool for use with Vercel AI SDK
+     * const composioTool = {
+     *   slug: 'SEARCH_TOOL',
+     *   description: 'Search for information',
+     *   inputParameters: {
+     *     type: 'object',
+     *     properties: {
+     *       query: { type: 'string' }
+     *     },
+     *     required: ['query']
+     *   }
+     * };
+     *
+     * // Create a Vercel tool using the provider
+     * const vercelTool = provider.wrapTool(
+     *   composioTool,
+     *   composio.tools.execute
+     * );
+     *
+     * // Use with Vercel AI SDK
+     * import { StreamingTextResponse, Message } from 'ai';
+     * import { OpenAI } from 'openai';
+     *
+     * export async function POST(req: Request) {
+     *   const { messages } = await req.json();
+     *   const openai = new OpenAI();
+     *
+     *   const response = await openai.chat.completions.create({
+     *     model: 'gpt-4',
+     *     messages,
+     *     tools: [vercelTool]
+     *   });
+     *
+     *   return new StreamingTextResponse(response.choices[0].message);
+     * }
+     * ```
+     */
+    wrapTool(composioTool: Tool$1, executeTool: ExecuteToolFn): Tool;
+    /**
+     * Wraps a list of Composio tools as a OpenAI Agents tool collection.
+     *
+     * This method transforms multiple Composio tool definitions into the format
+     * expected by OpenAI Agents for function calling, organizing them
+     * into a dictionary keyed by tool slug.
+     *
+     * @param {ComposioTool[]} tools - Array of Composio tools to wrap
+     * @param {ExecuteToolFn} executeTool - Function to execute the tools
+     * @returns {OpenAIAgentsToolCollection} Dictionary of wrapped tools in OpenAI Agents format
+     *
+     * @example
+     * ```typescript
+     * // Get OpenAI Agents tools from Composio
+     * const composio = new Composio({
+     *   apiKey: 'your-api-key',
+     *   provider: new OpenAIAgentsProvider()
+     * });
+     *
+     * const tools = await composio.tools.get('default', {
+     *  toolkits: ['github'],
+     * });
+     *
+     * import { OpenAI } from '@openai/agents';
+     *
+     * export async function POST(req: Request) {
+     *   const { messages } = await req.json();
+     *   const openai = new OpenAI();
+     *
+     *   const response = await openai.chat.completions.create({
+     *     model: 'gpt-4',
+     *     messages,
+     *     tools: openaiAgentsTools
+     *   });
+     *
+     *   return new StreamingTextResponse(response.choices[0].message);
+     * }
+     * ```
+     */
+    wrapTools(tools: Tool$1[], executeTool: ExecuteToolFn): OpenAIAgentsToolCollection;
+}
+
+export { OpenAIAgentsProvider };

package/dist/index.js

@@ -0,0 +1,147 @@
+// src/index.ts
+import {
+  BaseAgenticProvider,
+  jsonSchemaToZodSchema
+} from "@composio/core";
+import { tool as createOpenAIAgentTool } from "@openai/agents";
+var OpenAIAgentsProvider = class extends BaseAgenticProvider {
+  name = "openai-agents";
+  strict;
+  /**
+   * Creates a new instance of the OpenAIAgentsProvider.
+   *
+   * This provider enables integration with the @openai/agents package,
+   * allowing Composio tools to be used with OpenAI Agents.
+   *
+   * @example
+   * ```typescript
+   * // Initialize the OpenAIAgentsProvider
+   * const provider = new OpenAIAgentsProvider();
+   *
+   * // Use with Composio
+   * const composio = new Composio({
+   *   apiKey: 'your-api-key',
+   *   provider: new OpenAIAgentsProvider()
+   * });
+   *
+   * // Use the provider to wrap tools for @openai/agents
+   * const vercelTools = provider.wrapTools(composioTools, composio.tools.execute);
+   * ```
+   */
+  constructor(options) {
+    super();
+    this.strict = options?.strict ?? false;
+  }
+  /**
+   * Wraps a Composio tool in a OpenAI Agents tool format.
+   *
+   * This method transforms a Composio tool definition into the format
+   * expected by @openai/agents for function calling.
+   *
+   * @param {ComposioTool} composioTool - The Composio tool to wrap
+   * @param {ExecuteToolFn} executeTool - Function to execute the tool
+   * @returns {OpenAIAgentsTool} The wrapped OpenAI Agents tool
+   *
+   * @example
+   * ```typescript
+   * // Wrap a single tool for use with Vercel AI SDK
+   * const composioTool = {
+   *   slug: 'SEARCH_TOOL',
+   *   description: 'Search for information',
+   *   inputParameters: {
+   *     type: 'object',
+   *     properties: {
+   *       query: { type: 'string' }
+   *     },
+   *     required: ['query']
+   *   }
+   * };
+   *
+   * // Create a Vercel tool using the provider
+   * const vercelTool = provider.wrapTool(
+   *   composioTool,
+   *   composio.tools.execute
+   * );
+   *
+   * // Use with Vercel AI SDK
+   * import { StreamingTextResponse, Message } from 'ai';
+   * import { OpenAI } from 'openai';
+   *
+   * export async function POST(req: Request) {
+   *   const { messages } = await req.json();
+   *   const openai = new OpenAI();
+   *
+   *   const response = await openai.chat.completions.create({
+   *     model: 'gpt-4',
+   *     messages,
+   *     tools: [vercelTool]
+   *   });
+   *
+   *   return new StreamingTextResponse(response.choices[0].message);
+   * }
+   * ```
+   */
+  wrapTool(composioTool, executeTool) {
+    return createOpenAIAgentTool({
+      name: composioTool.slug,
+      description: composioTool.description ?? "",
+      parameters: jsonSchemaToZodSchema(
+        composioTool.inputParameters ?? {},
+        {
+          strict: this.strict ? true : false
+        }
+      ),
+      execute: async (params) => {
+        const input = typeof params === "string" ? JSON.parse(params) : params;
+        return await executeTool(composioTool.slug, input);
+      }
+    });
+  }
+  /**
+   * Wraps a list of Composio tools as a OpenAI Agents tool collection.
+   *
+   * This method transforms multiple Composio tool definitions into the format
+   * expected by OpenAI Agents for function calling, organizing them
+   * into a dictionary keyed by tool slug.
+   *
+   * @param {ComposioTool[]} tools - Array of Composio tools to wrap
+   * @param {ExecuteToolFn} executeTool - Function to execute the tools
+   * @returns {OpenAIAgentsToolCollection} Dictionary of wrapped tools in OpenAI Agents format
+   *
+   * @example
+   * ```typescript
+   * // Get OpenAI Agents tools from Composio
+   * const composio = new Composio({
+   *   apiKey: 'your-api-key',
+   *   provider: new OpenAIAgentsProvider()
+   * });
+   *
+   * const tools = await composio.tools.get('default', {
+   *  toolkits: ['github'],
+   * });
+   *
+   * import { OpenAI } from '@openai/agents';
+   *
+   * export async function POST(req: Request) {
+   *   const { messages } = await req.json();
+   *   const openai = new OpenAI();
+   *
+   *   const response = await openai.chat.completions.create({
+   *     model: 'gpt-4',
+   *     messages,
+   *     tools: openaiAgentsTools
+   *   });
+   *
+   *   return new StreamingTextResponse(response.choices[0].message);
+   * }
+   * ```
+   */
+  wrapTools(tools, executeTool) {
+    return tools.map((tool) => {
+      return this.wrapTool(tool, executeTool);
+    });
+  }
+};
+export {
+  OpenAIAgentsProvider
+};

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "@composio/openai-agents",
+  "version": "0.1.22",
+  "description": "",
+  "main": "dist/index.js",
+  "type": "module",
+  "publishConfig": {
+    "access": "public"
+  },
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "files": [
+    "README.md",
+    "dist"
+  ],
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "peerDependencies": {
+    "@composio/core": "0.1.22",
+    "@openai/agents": "^0.0.7"
+  },
+  "devDependencies": {
+    "tsup": "^8.4.0",
+    "typescript": "^5.8.3",
+    "vitest": "^3.1.4",
+    "@composio/core": "0.1.22"
+  },
+  "gitHead": "4fae6e54d5c150fba955cc5fa314281da5a1e064",
+  "scripts": {
+    "build": "tsup",
+    "test": "vitest run"
+  },
+  "types": "dist/index.d.ts"
+}