@composio/llamaindex 0.1.53

package/README.md

@@ -0,0 +1,243 @@
+# @composio/llamaindex
+
+Agentic Provider for Llamaindex in Composio SDK.
+
+## Features
+
+- **Seamless LlamaIndex Integration**: Tools are automatically compatible with LlamaIndex agents and workflows
+- **Full Modifier Support**: Support for both schema and execution modifiers with beforeExecute/afterExecute hooks
+- **Streaming Support**: Works with LlamaIndex streaming agents using `agentStreamEvent`
+- **Tool Execution**: Execute tools with proper parameter handling and JSON schema validation
+- **Type Safety**: Full TypeScript support with proper type definitions
+- **Zod Schema Integration**: Automatic conversion from JSON Schema to Zod for LlamaIndex compatibility
+
+## Installation
+
+```bash
+npm install @composio/llamaindex
+# or
+yarn add @composio/llamaindex
+# or
+pnpm add @composio/llamaindex
+```
+
+## Quick Start
+
+```typescript
+import { Composio } from '@composio/core';
+import { LlamaindexProvider } from '@composio/llamaindex';
+
+// Initialize Composio with Llamaindex provider
+const composio = new Composio({
+  apiKey: 'your-composio-api-key',
+  provider: new LlamaindexProvider(),
+});
+
+// Get available tools
+const tools = await composio.tools.get('user123', {
+  toolkits: ['gmail', 'googlecalendar'],
+  limit: 10,
+});
+```
+
+## Prerequisites
+
+Before using the LlamaIndex provider, make sure you have:
+
+1. **Composio API Key**: Get your API key from [Composio Dashboard](https://app.composio.dev)
+2. **Environment Setup**: Set up your environment variables
+3. **LlamaIndex Dependencies**: Install required LlamaIndex packages
+
+```bash
+# Install LlamaIndex dependencies
+npm install @llamaindex/openai @llamaindex/workflow
+```
+
+```bash
+# Set up environment variables
+export COMPOSIO_API_KEY="your-composio-api-key"
+export OPENAI_API_KEY="your-openai-api-key"  # For LlamaIndex OpenAI integration
+```
+
+## Usage Examples
+
+### Basic Example
+
+```typescript
+import { Composio } from '@composio/core';
+import { LlamaindexProvider } from '@composio/llamaindex';
+
+// Initialize Composio
+const composio = new Composio({
+  apiKey: process.env.COMPOSIO_API_KEY,
+  provider: new LlamaindexProvider(),
+});
+
+// Get tools
+const tools = await composio.tools.get('default', {
+  toolkits: ['gmail'],
+  limit: 10,
+});
+
+console.log(`Found ${tools.length} tools`);
+```
+
+### Complete Agent Example with HackerNews
+
+```typescript
+import { Composio } from '@composio/core';
+import { LlamaindexProvider } from '@composio/llamaindex';
+import { openai } from '@llamaindex/openai';
+import { agent, agentStreamEvent } from '@llamaindex/workflow';
+import 'dotenv/config';
+
+// Initialize Composio with LlamaIndex provider
+const composio = new Composio({
+  apiKey: process.env.COMPOSIO_API_KEY,
+  provider: new LlamaindexProvider(),
+});
+
+async function main() {
+  try {
+    console.log('🚀 Starting LlamaIndex Example...');
+
+    // Get available tools with modifiers
+    const tools = await composio.tools.get(
+      'default',
+      {
+        toolkits: ['hackernews'],
+        limit: 10,
+      },
+      {
+        beforeExecute: ({ toolSlug, toolkitSlug, params }) => {
+          console.log(`🔄 Executing tool ${toolSlug}/${toolkitSlug} with params:`, { params });
+          return params;
+        },
+        afterExecute: ({ toolSlug, toolkitSlug, result }) => {
+          console.log(`✅ Executed tool ${toolSlug}/${toolkitSlug} with result:`, { result });
+          return result;
+        },
+      }
+    );
+
+    console.log(`✅ Found ${tools.length} tools`);
+
+    // Create LlamaIndex agent with Composio tools
+    const hackernewsAgent = agent({
+      name: 'Hackernews Agent',
+      description: 'A helpful hackernews assistant',
+      llm: openai({ model: 'gpt-4o-mini' }),
+      systemPrompt:
+        'You are a helpful hackernews assistant that helps users with their queries related to hackernews',
+      tools, // Composio tools are automatically compatible with LlamaIndex
+    });
+
+    // Run the agent with streaming
+    const stream = await hackernewsAgent.runStream('Summarize the front page of hackernews');
+
+    for await (const event of stream) {
+      if (agentStreamEvent.include(event)) {
+        process.stdout.write(event.data.delta);
+      }
+    }
+  } catch (error) {
+    console.error('❌ Error running example:', error);
+  }
+}
+
+main().catch(console.error);
+```
+
+### Using Tools with Different Toolkits
+
+```typescript
+import { Composio } from '@composio/core';
+import { LlamaindexProvider } from '@composio/llamaindex';
+import { openai } from '@llamaindex/openai';
+import { agent } from '@llamaindex/workflow';
+
+const composio = new Composio({
+  apiKey: process.env.COMPOSIO_API_KEY,
+  provider: new LlamaindexProvider(),
+});
+
+// Get tools from multiple toolkits
+const tools = await composio.tools.get('default', {
+  toolkits: ['gmail', 'googlecalendar', 'slack'],
+  limit: 20,
+});
+
+// Create a multi-purpose agent
+const assistantAgent = agent({
+  name: 'Personal Assistant',
+  description: 'A helpful personal assistant',
+  llm: openai({ model: 'gpt-4' }),
+  systemPrompt:
+    'You are a helpful personal assistant that can manage emails, calendar events, and slack messages.',
+  tools,
+});
+
+// Use the agent
+const response = await assistantAgent.run(
+  'Schedule a meeting for tomorrow at 2 PM and send a slack message about it'
+);
+console.log(response);
+```
+
+## API Reference
+
+### LlamaindexProvider Class
+
+The `LlamaindexProvider` class extends `BaseAgenticProvider` and provides llamaindex-specific functionality.
+
+#### Methods
+
+##### `wrapTool(tool: Tool, executeTool: ExecuteToolFn): LlamaindexTool`
+
+Wraps a single Composio tool in the LlamaIndex format with proper Zod schema conversion.
+
+```typescript
+const llamaindexTool = provider.wrapTool(composioTool, executeTool);
+
+// The wrapped tool has LlamaIndex-compatible structure:
+// - metadata.name: Tool slug
+// - metadata.description: Tool description
+// - metadata.parameters: Zod schema for parameters
+// - call(): Function to execute the tool
+```
+
+##### `wrapTools(tools: Tool[], executeTool: ExecuteToolFn): LlamaindexTool[]`
+
+Wraps multiple Composio tools for use with LlamaIndex agents.
+
+```typescript
+const llamaindexTools = provider.wrapTools(composioTools, executeTool);
+
+// Use directly with LlamaIndex agents
+const agent = agent({
+  name: 'My Agent',
+  llm: openai({ model: 'gpt-4' }),
+  tools: llamaindexTools, // Ready to use!
+});
+```
+
+##### `wrapMcpServerResponse(data: McpUrlResponse): McpServerGetResponse`
+
+Transforms MCP URL responses into the standard format with URL objects.
+
+```typescript
+const mcpServers = provider.wrapMcpServerResponse(urlResponse);
+// Returns: [{ url: URL, name: string }, ...]
+```
+
+## Contributing
+
+We welcome contributions! Please see our [Contributing Guide](../../CONTRIBUTING.md) for more details.
+
+## License
+
+ISC License
+
+## Support
+
+For support, please visit our [Documentation](https://docs.composio.dev) or join our [Discord Community](https://discord.gg/composio).

package/dist/index.cjs

@@ -0,0 +1,74 @@
+"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, {
+  LlamaindexProvider: () => LlamaindexProvider
+});
+module.exports = __toCommonJS(index_exports);
+var import_core = require("@composio/core");
+var import_llamaindex = require("llamaindex");
+var LlamaindexProvider = class extends import_core.BaseAgenticProvider {
+  name = "llamaindex";
+  /**
+   * Wrap a tool in the llamaindex format.
+   * @param tool - The tool to wrap.
+   * @returns The wrapped tool.
+   */
+  wrapTool(tool, executeTool) {
+    const inputParams = tool.inputParameters;
+    const inputParametersSchema = (0, import_core.jsonSchemaToZodSchema)(inputParams ?? {});
+    return (0, import_llamaindex.tool)({
+      name: tool.slug,
+      description: tool.description ?? tool.name ?? "",
+      parameters: inputParametersSchema,
+      execute: async (input) => {
+        const result = await executeTool(tool.slug, input);
+        return JSON.stringify(result);
+      }
+    });
+  }
+  /**
+   * Wrap a list of tools in the llamaindex format.
+   * @param tools - The tools to wrap.
+   * @returns The wrapped tools.
+   */
+  wrapTools(tools, executeTool) {
+    return tools.map((tool) => this.wrapTool(tool, executeTool));
+  }
+  /**
+   * Transform MCP URL response into Anthropic-specific format.
+   * By default, Anthropic uses the standard format (same as default),
+   * but this method is here to show providers can customize if needed.
+   *
+   * @param data - The MCP URL response data
+   * @returns Standard MCP server response format
+   */
+  wrapMcpServerResponse(data) {
+    return data.map((item) => ({
+      url: new URL(item.url),
+      name: item.name
+    }));
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  LlamaindexProvider
+});

package/dist/index.d.cts

@@ -0,0 +1,40 @@
+import { BaseAgenticProvider, McpServerGetResponse, Tool, ExecuteToolFn, McpUrlResponse } from '@composio/core';
+import { tool } from 'llamaindex';
+
+/**
+ * Llamaindex Provider
+ *
+ * This provider provides a set of tools for interacting with Llamaindex.
+ *
+ * @packageDocumentation
+ * @module providers/llamaindex
+ */
+
+type LlamaindexTool = ReturnType<typeof tool>;
+type LlamaindexToolCollection = Array<LlamaindexTool>;
+declare class LlamaindexProvider extends BaseAgenticProvider<Array<LlamaindexTool>, LlamaindexTool, McpServerGetResponse> {
+    readonly name = "llamaindex";
+    /**
+     * Wrap a tool in the llamaindex format.
+     * @param tool - The tool to wrap.
+     * @returns The wrapped tool.
+     */
+    wrapTool(tool: Tool, executeTool: ExecuteToolFn): LlamaindexTool;
+    /**
+     * Wrap a list of tools in the llamaindex format.
+     * @param tools - The tools to wrap.
+     * @returns The wrapped tools.
+     */
+    wrapTools(tools: Tool[], executeTool: ExecuteToolFn): LlamaindexToolCollection;
+    /**
+     * Transform MCP URL response into Anthropic-specific format.
+     * By default, Anthropic uses the standard format (same as default),
+     * but this method is here to show providers can customize if needed.
+     *
+     * @param data - The MCP URL response data
+     * @returns Standard MCP server response format
+     */
+    wrapMcpServerResponse(data: McpUrlResponse): McpServerGetResponse;
+}
+
+export { LlamaindexProvider, type LlamaindexTool, type LlamaindexToolCollection };

package/dist/index.d.ts

@@ -0,0 +1,40 @@
+import { BaseAgenticProvider, McpServerGetResponse, Tool, ExecuteToolFn, McpUrlResponse } from '@composio/core';
+import { tool } from 'llamaindex';
+
+/**
+ * Llamaindex Provider
+ *
+ * This provider provides a set of tools for interacting with Llamaindex.
+ *
+ * @packageDocumentation
+ * @module providers/llamaindex
+ */
+
+type LlamaindexTool = ReturnType<typeof tool>;
+type LlamaindexToolCollection = Array<LlamaindexTool>;
+declare class LlamaindexProvider extends BaseAgenticProvider<Array<LlamaindexTool>, LlamaindexTool, McpServerGetResponse> {
+    readonly name = "llamaindex";
+    /**
+     * Wrap a tool in the llamaindex format.
+     * @param tool - The tool to wrap.
+     * @returns The wrapped tool.
+     */
+    wrapTool(tool: Tool, executeTool: ExecuteToolFn): LlamaindexTool;
+    /**
+     * Wrap a list of tools in the llamaindex format.
+     * @param tools - The tools to wrap.
+     * @returns The wrapped tools.
+     */
+    wrapTools(tools: Tool[], executeTool: ExecuteToolFn): LlamaindexToolCollection;
+    /**
+     * Transform MCP URL response into Anthropic-specific format.
+     * By default, Anthropic uses the standard format (same as default),
+     * but this method is here to show providers can customize if needed.
+     *
+     * @param data - The MCP URL response data
+     * @returns Standard MCP server response format
+     */
+    wrapMcpServerResponse(data: McpUrlResponse): McpServerGetResponse;
+}
+
+export { LlamaindexProvider, type LlamaindexTool, type LlamaindexToolCollection };

package/dist/index.js

@@ -0,0 +1,52 @@
+// src/index.ts
+import {
+  BaseAgenticProvider,
+  jsonSchemaToZodSchema
+} from "@composio/core";
+import { tool as createLlamaindexTool } from "llamaindex";
+var LlamaindexProvider = class extends BaseAgenticProvider {
+  name = "llamaindex";
+  /**
+   * Wrap a tool in the llamaindex format.
+   * @param tool - The tool to wrap.
+   * @returns The wrapped tool.
+   */
+  wrapTool(tool, executeTool) {
+    const inputParams = tool.inputParameters;
+    const inputParametersSchema = jsonSchemaToZodSchema(inputParams ?? {});
+    return createLlamaindexTool({
+      name: tool.slug,
+      description: tool.description ?? tool.name ?? "",
+      parameters: inputParametersSchema,
+      execute: async (input) => {
+        const result = await executeTool(tool.slug, input);
+        return JSON.stringify(result);
+      }
+    });
+  }
+  /**
+   * Wrap a list of tools in the llamaindex format.
+   * @param tools - The tools to wrap.
+   * @returns The wrapped tools.
+   */
+  wrapTools(tools, executeTool) {
+    return tools.map((tool) => this.wrapTool(tool, executeTool));
+  }
+  /**
+   * Transform MCP URL response into Anthropic-specific format.
+   * By default, Anthropic uses the standard format (same as default),
+   * but this method is here to show providers can customize if needed.
+   *
+   * @param data - The MCP URL response data
+   * @returns Standard MCP server response format
+   */
+  wrapMcpServerResponse(data) {
+    return data.map((item) => ({
+      url: new URL(item.url),
+      name: item.name
+    }));
+  }
+};
+export {
+  LlamaindexProvider
+};

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@composio/llamaindex",
+  "version": "0.1.53",
+  "description": "Agentic Provider for llamaindex in Composio SDK",
+  "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": [
+    "composio",
+    "provider",
+    "llamaindex"
+  ],
+  "author": "",
+  "license": "ISC",
+  "peerDependencies": {
+    "@composio/core": "0.1.53",
+    "llamaindex": "^0.12.0"
+  },
+  "devDependencies": {
+    "tsup": "^8.5.0",
+    "typescript": "^5.9.2",
+    "@composio/core": "0.1.53"
+  },
+  "scripts": {
+    "build": "tsup",
+    "test": "vitest run"
+  },
+  "types": "dist/index.d.ts"
+}