matimo-examples 0.1.0-alpha.7

package/read/read-langchain.ts

@@ -0,0 +1,253 @@
+#!/usr/bin/env node
+/**
+ * ============================================================================
+ * READ TOOL - LANGCHAIN AI AGENT EXAMPLE
+ * ============================================================================
+ *
+ * PATTERN: True AI Agent with OpenAI + LangChain
+ * ─────────────────────────────────────────────────────────────────────────
+ * This is a REAL AI agent that:
+ * 1. Takes natural language user requests
+ * 2. Uses OpenAI LLM (GPT-4o-mini) to decide when to read files
+ * 3. Generates appropriate file paths and line ranges based on context
+ * 4. Executes tools autonomously
+ * 5. Processes results and responds naturally
+ *
+ * SETUP:
+ * ─────────────────────────────────────────────────────────────────────────
+ * 1. Create .env file in examples/tools/:
+ *    OPENAI_API_KEY=sk-xxxxxxxxxxxxx
+ *
+ * 2. Install dependencies:
+ *    cd examples/tools && npm install
+ *
+ * USAGE:
+ * ─────────────────────────────────────────────────────────────────────────
+ *   # From root directory:
+ *   pnpm read:langchain
+ *
+ *   # Or from examples/tools directory:
+ *   npm run read:langchain
+ *
+ * ============================================================================
+ */
+
+import 'dotenv/config';
+import fs from 'fs';
+import path from 'path';
+import { fileURLToPath } from 'url';
+import readline from 'readline';
+import { createAgent } from 'langchain';
+import { ChatOpenAI } from '@langchain/openai';
+import {
+  MatimoInstance,
+  convertToolsToLangChain,
+  type ToolDefinition,
+  getPathApprovalManager,
+} from '@matimo/core';
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+
+// Create readline interface for interactive approval prompts
+const rl = readline.createInterface({
+  input: process.stdin,
+  output: process.stdout,
+});
+
+let isReadlineClosed = false;
+
+// Track when readline closes (e.g., piped input ends)
+rl.on('close', () => {
+  isReadlineClosed = true;
+});
+
+/**
+ * Prompt user for approval decision
+ */
+async function promptForApproval(
+  filePath: string,
+  mode: 'read' | 'write' | 'search'
+): Promise<boolean> {
+  return new Promise((resolve) => {
+    // If readline is closed (e.g., non-TTY/piped input), auto-approve
+    if (isReadlineClosed) {
+      console.info(
+        `[${mode.toUpperCase()}] Access to ${filePath} auto-approved (non-interactive mode)`
+      );
+      resolve(true);
+      return;
+    }
+    rl.question(`[${mode.toUpperCase()}] Approve access to ${filePath}? (y/n): `, (answer) => {
+      resolve(answer.toLowerCase() === 'y' || answer.toLowerCase() === 'yes');
+    });
+  });
+}
+
+/**
+ * Run AI Agent with Read tool
+ * The agent receives natural language requests and decides which files to read
+ */
+async function runReadAIAgent() {
+  console.info('\n╔════════════════════════════════════════════════════════╗');
+  console.info('║     Read Tool AI Agent - LangChain + OpenAI            ║');
+  console.info('║     True autonomous agent with LLM reasoning           ║');
+  console.info('╚════════════════════════════════════════════════════════╝\n');
+
+  // Check required environment variables
+  const openaiKey = process.env.OPENAI_API_KEY;
+  if (!openaiKey) {
+    console.error('❌ Error: OPENAI_API_KEY not set in .env');
+    console.info('   Set it: export OPENAI_API_KEY="sk-..."');
+    process.exit(1);
+  }
+
+  console.info('🤖 Using OpenAI (GPT-4o-mini) as the AI agent\n');
+
+  // Create a sample file for the agent to read
+  const sampleFile = path.join(__dirname, 'sample-code.ts');
+  fs.writeFileSync(
+    sampleFile,
+    `// Sample TypeScript file
+interface User {
+  id: string;
+  name: string;
+  email: string;
+}
+
+function getUserInfo(userId: string): User {
+  // Fetch user from database
+  return {
+    id: userId,
+    name: 'John Doe',
+    email: 'john@example.com',
+  };
+}
+
+function validateEmail(email: string): boolean {
+  const pattern = /^[^@]+@[^@]+\\.[^@]+$/;
+  return pattern.test(email);
+}
+
+export { getUserInfo, validateEmail };
+`
+  );
+
+  try {
+    // Initialize Matimo with auto-discovery
+    console.info('🚀 Initializing Matimo...');
+    const matimo = await MatimoInstance.init({ autoDiscover: true });
+
+    // Set up approval callback for interactive approval
+    const approvalManager = getPathApprovalManager();
+    approvalManager.setApprovalCallback(promptForApproval);
+
+    // Get read tool
+    console.info('💬 Loading read tool...');
+    const matimoTools = matimo.listTools();
+    const readTools = matimoTools.filter((t) => t.name === 'read') as ToolDefinition[];
+    console.info(`✅ Loaded ${readTools.length} read tool(s)\n`);
+
+    if (readTools.length === 0) {
+      console.error('❌ Read tool not found');
+      process.exit(1);
+    }
+
+    // Convert to LangChain tools using the built-in converter
+    const langchainTools = await convertToolsToLangChain(readTools, matimo);
+
+    // Initialize OpenAI LLM
+    console.info('🤖 Initializing OpenAI (GPT-4o-mini) LLM...');
+    const model = new ChatOpenAI({
+      modelName: 'gpt-4o-mini',
+      temperature: 0.7,
+    });
+
+    // Create agent
+    console.info('🔧 Creating agent...\n');
+    const agent = await createAgent({
+      model,
+      tools: langchainTools as any,
+    });
+
+    // Define agent tasks (natural language requests)
+    const userRequests = [
+      {
+        title: 'Example 1: Read function definition',
+        request: `Read the getUserInfo function from file ${sampleFile}`,
+      },
+      {
+        title: 'Example 2: Read specific lines',
+        request: `Read lines 1-10 from file ${sampleFile} and tell me what interfaces are defined`,
+      },
+      {
+        title: 'Example 3: Read entire file',
+        request: `Show me the complete content of file ${sampleFile}`,
+      },
+    ];
+
+    console.info('🧪 Running AI Agent Tasks');
+    console.info('═'.repeat(60) + '\n');
+
+    // Run each task through the agent
+    for (const task of userRequests) {
+      console.info(`${task.title}`);
+      console.info('─'.repeat(60));
+      console.info(`👤 User: "${task.request}"\n`);
+
+      try {
+        const response = await agent.invoke({
+          messages: [
+            {
+              role: 'user',
+              content: task.request,
+            },
+          ],
+        });
+
+        // Get the last message from the agent
+        const lastMessage = response.messages[response.messages.length - 1];
+        if (lastMessage) {
+          const content =
+            typeof lastMessage.content === 'string'
+              ? lastMessage.content
+              : String(lastMessage.content);
+
+          if (content && content.trim()) {
+            console.info(`🤖 Agent: ${content}\n`);
+          } else {
+            console.info('🤖 Agent: (File read successfully)\n');
+          }
+        }
+      } catch (error) {
+        const errorMsg = error instanceof Error ? error.message : String(error);
+        console.info(`⚠️  Agent error: ${errorMsg}\n`);
+      }
+    }
+
+    console.info('═'.repeat(60));
+    console.info('\n✨ AI Agent Examples Complete!\n');
+    console.info('Key Features:');
+    console.info('  ✅ Real LLM (OpenAI) decides which tools to use');
+    console.info('  ✅ Natural language requests, not API calls');
+    console.info('  ✅ LLM determines file paths and line ranges');
+    console.info('  ✅ Agentic reasoning and decision-making\n');
+  } catch (error) {
+    console.error('❌ Error:', error instanceof Error ? error.message : String(error));
+    if (error instanceof Error && error.stack) {
+      console.error('Stack:', error.stack);
+    }
+    process.exit(1);
+  } finally {
+    // Clean up
+    if (fs.existsSync(sampleFile)) {
+      fs.unlinkSync(sampleFile);
+    }
+    if (!isReadlineClosed) {
+      rl.close();
+      isReadlineClosed = true;
+    }
+  }
+}
+
+// Run the AI agent
+runReadAIAgent().catch(console.error);

package/search/search-decorator.ts

@@ -0,0 +1,154 @@
+import {
+  MatimoInstance,
+  setGlobalMatimoInstance,
+  tool,
+  getPathApprovalManager,
+} from '@matimo/core';
+import path from 'path';
+import { fileURLToPath } from 'url';
+import readline from 'readline';
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+
+// Create readline interface for interactive approval prompts
+const rl = readline.createInterface({
+  input: process.stdin,
+  output: process.stdout,
+});
+
+let isReadlineClosed = false;
+
+// Track when readline closes (e.g., piped input ends)
+rl.on('close', () => {
+  isReadlineClosed = true;
+});
+
+/**
+ * Prompt user for approval decision
+ */
+async function promptForApproval(
+  filePath: string,
+  mode: 'read' | 'write' | 'search'
+): Promise<boolean> {
+  return new Promise((resolve) => {
+    // If readline is closed (e.g., non-TTY/piped input), auto-approve
+    if (isReadlineClosed) {
+      console.info(
+        `[${mode.toUpperCase()}] Access to ${filePath} auto-approved (non-interactive mode)`
+      );
+      resolve(true);
+      return;
+    }
+    rl.question(`[${mode.toUpperCase()}] Approve access to ${filePath}? (y/n): `, (answer) => {
+      resolve(answer.toLowerCase() === 'y' || answer.toLowerCase() === 'yes');
+    });
+  });
+}
+
+/**
+ * Example: Search tool using @tool decorator pattern
+ * Demonstrates class-based file search with automatic decoration
+ */
+class FileSearcher {
+  @tool('search')
+  async findPattern(
+    query: string,
+    directory: string,
+    filePattern: string,
+    maxResults?: number
+  ): Promise<unknown> {
+    // Decorator automatically intercepts and executes via Matimo with:
+    // { query, directory, filePattern, maxResults }
+    // Positional args map to parameters in tool definition order
+    return undefined;
+  }
+
+  @tool('search')
+  async searchInDirectory(
+    query: string,
+    directory: string,
+    filePattern?: string
+  ): Promise<unknown> {
+    // Decorator automatically intercepts and executes via Matimo with:
+    // { query, directory, filePattern }
+    return undefined;
+  }
+
+  @tool('search')
+  async regexSearch(
+    query: string,
+    directory: string,
+    filePattern: string,
+    isRegex: boolean = true,
+    maxResults?: number
+  ): Promise<unknown> {
+    // Decorator automatically intercepts and executes via Matimo with:
+    // { query, directory, filePattern, isRegex, maxResults }
+    return undefined;
+  }
+}
+
+async function decoratorExample() {
+  // Set up decorator support with autoDiscover
+  const matimo = await MatimoInstance.init({ autoDiscover: true });
+  setGlobalMatimoInstance(matimo);
+
+  // Set up approval callback for interactive approval
+  const approvalManager = getPathApprovalManager();
+  approvalManager.setApprovalCallback(promptForApproval);
+
+  console.info('=== Search Tool - Decorator Pattern (Interactive Approval) ===\n');
+
+  // Get the workspace root (parent of examples directory)
+  // File is in examples/tools/search/, so go up 3 levels
+  const workspaceRoot = path.resolve(__dirname, '../../..');
+
+  const searcher = new FileSearcher();
+
+  try {
+    // Example 1: Find pattern through decorated method
+    console.info('1. Finding "export" in TypeScript files\n');
+    const result1 = await searcher.findPattern(
+      'export',
+      path.join(workspaceRoot, 'packages/core/src'),
+      '*.ts',
+      5
+    );
+    console.info('Total matches:', (result1 as any).totalMatches);
+    console.info('Matches found:', (result1 as any).matches?.length);
+    console.info('---\n');
+
+    // Example 2: Search in specific directory
+    console.info('2. Searching in examples directory\n');
+    const result2 = await searcher.searchInDirectory(
+      'async',
+      path.join(workspaceRoot, 'examples/tools'),
+      '*.ts'
+    );
+    console.info('Total matches:', (result2 as any).totalMatches);
+    console.info('Matches found:', (result2 as any).matches?.length);
+    console.info('---\n');
+
+    // Example 3: Regex search
+    console.info('3. Using regex to find patterns\n');
+    const result3 = await searcher.regexSearch(
+      'console\\.info',
+      path.join(workspaceRoot, 'packages/core/src'),
+      '*.ts',
+      true,
+      5
+    );
+    console.info('Total matches:', (result3 as any).totalMatches);
+    console.info('Matches found:', (result3 as any).matches?.length);
+    console.info('---\n');
+  } catch (error: any) {
+    console.error('Error:', error.message);
+  } finally {
+    if (!isReadlineClosed) {
+      rl.close();
+      isReadlineClosed = true;
+    }
+  }
+}
+
+decoratorExample();

package/search/search-factory.ts

@@ -0,0 +1,129 @@
+import { MatimoInstance } from '@matimo/core';
+import { getPathApprovalManager } from '@matimo/core';
+import path from 'path';
+import { fileURLToPath } from 'url';
+import readline from 'readline';
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+
+// Create readline interface once for reuse across multiple prompts
+const rl = readline.createInterface({
+  input: process.stdin,
+  output: process.stdout,
+});
+
+let isReadlineClosed = false;
+
+// Track when readline closes (e.g., piped input ends)
+rl.on('close', () => {
+  isReadlineClosed = true;
+});
+
+/**
+ * Prompt user for approval decision
+ */
+async function promptForApproval(
+  filePath: string,
+  mode: 'read' | 'write' | 'search'
+): Promise<boolean> {
+  return new Promise((resolve) => {
+    // If readline is closed (e.g., non-TTY/piped input), auto-approve
+    if (isReadlineClosed) {
+      console.info(
+        `[${mode.toUpperCase()}] Access to ${filePath} auto-approved (non-interactive mode)`
+      );
+      resolve(true);
+      return;
+    }
+    rl.question(`[${mode.toUpperCase()}] Approve access to ${filePath}? (y/n): `, (answer) => {
+      resolve(answer.toLowerCase() === 'y' || answer.toLowerCase() === 'yes');
+    });
+  });
+}
+
+/**
+ * Example: Search tool using factory pattern
+ * Demonstrates searching files for patterns and content with interactive approval
+ */
+async function searchExample() {
+  // Initialize Matimo with autoDiscover to find all tools (core + providers)
+  const matimo = await MatimoInstance.init({ autoDiscover: true });
+
+  // Set up approval callback for examples with INTERACTIVE PROMPTS
+  const approvalManager = getPathApprovalManager();
+  approvalManager.setApprovalCallback(promptForApproval);
+
+  console.info('=== Search Tool - Factory Pattern (Interactive Approval) ===\n');
+
+  // Get the workspace root (parent of examples directory)
+  // File is in examples/tools/search/, so go up 3 levels
+  const workspaceRoot = path.resolve(__dirname, '../../..');
+
+  try {
+    // Example 1: Search for pattern in TypeScript files
+    console.info('1. Searching for "import" in examples\n');
+    const result1 = await matimo.execute('search', {
+      query: 'import',
+      directory: path.join(workspaceRoot, 'examples/tools'),
+      filePattern: '*.ts',
+      maxResults: 5,
+    });
+
+    if ((result1 as any).success) {
+      console.info('Total matches:', (result1 as any).totalMatches);
+      console.info('Matches found:', (result1 as any).matches?.length);
+      if ((result1 as any).matches) {
+        (result1 as any).matches.slice(0, 3).forEach((match: any) => {
+          console.info(`  - ${match.filePath}:${match.lineNumber}: ${match.lineContent}`);
+        });
+      }
+    } else {
+      console.info('Search denied:', (result1 as any).error);
+    }
+    console.info('---\n');
+
+    // Example 2: Search for function definitions
+    console.info('2. Searching for function definitions\n');
+    const result2 = await matimo.execute('search', {
+      query: 'export function',
+      directory: path.join(workspaceRoot, 'packages/core/src'),
+      filePattern: '*.ts',
+      maxResults: 10,
+    });
+
+    if ((result2 as any).success) {
+      console.info('Total matches:', (result2 as any).totalMatches);
+      console.info('Matches found:', (result2 as any).matches?.length);
+    } else {
+      console.info('Search denied:', (result2 as any).error);
+    }
+    console.info('---\n');
+
+    // Example 3: Search in specific directory with regex
+    console.info('3. Searching for "console.info" patterns\n');
+    const result3 = await matimo.execute('search', {
+      query: 'console\\.info',
+      directory: path.join(workspaceRoot, 'packages/core/src'),
+      filePattern: '*.ts',
+      isRegex: true,
+      maxResults: 5,
+    });
+
+    if ((result3 as any).success) {
+      console.info('Total matches:', (result3 as any).totalMatches);
+      console.info('Matches found:', (result3 as any).matches?.length);
+    } else {
+      console.info('Search denied:', (result3 as any).error);
+    }
+    console.info('---\n');
+  } catch (error: any) {
+    console.error('Error searching files:', error.message);
+  } finally {
+    if (!isReadlineClosed) {
+      rl.close();
+      isReadlineClosed = true;
+    }
+  }
+}
+
+searchExample();