matimo-examples 0.1.0-alpha.7

package/agents/langchain-agent.ts

@@ -0,0 +1,146 @@
+#!/usr/bin/env node
+/**
+ * Matimo + LangChain Agent - Proper ReAct Agent Pattern
+ *
+ * This demonstrates a complete agent loop:
+ * 1. LLM decides which tool to use based on goal
+ * 2. Tool is executed via Matimo
+ * 3. Result is fed back to LLM
+ * 4. Process repeats until agent reaches conclusion
+ *
+ * Key advantages:
+ * - Shows real agent reasoning loop
+ * - Single source of truth (Matimo YAML definitions)
+ * - How to integrate Matimo with any LangChain setup
+ * - Demonstrates tool selection and execution
+ *
+ * Run: npm run agent:langchain
+ */
+
+import 'dotenv/config';
+import path from 'path';
+import { fileURLToPath } from 'url';
+import { ChatOpenAI } from '@langchain/openai';
+import { BaseMessage, HumanMessage, ToolMessage } from '@langchain/core/messages';
+import { MatimoInstance, convertToolsToLangChain, ToolDefinition } from 'matimo';
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+
+/**
+ * Run LangChain ReAct Agent with Matimo Tools
+ */
+async function runLangChainAgent() {
+  console.info('\n╔════════════════════════════════════════════════════════╗');
+  console.info('║   Matimo + LangChain Agent (ReAct Pattern)              ║');
+  console.info('║   Demonstrates real agent reasoning loop                ║');
+  console.info('╚════════════════════════════════════════════════════════╝\n');
+
+  try {
+    // Initialize Matimo
+    console.info('🚀 Initializing Matimo...');
+    const matimo = await MatimoInstance.init({ autoDiscover: true });
+
+    const matimoTools = matimo.listTools();
+    console.info(`📦 Loaded ${matimoTools.length} tools:\n`);
+    matimoTools.forEach((t) => {
+      console.info(`  • ${t.name}`);
+      console.info(`    ${t.description}\n`);
+    });
+
+    // ✅ Convert Matimo tools to LangChain tools
+    console.info('🔧 Converting Matimo tools to LangChain format...\n');
+    const langchainTools = await convertToolsToLangChain(matimoTools as ToolDefinition[], matimo);
+
+    console.info(`✅ Successfully converted ${langchainTools.length} tools!\n`);
+
+    // 🤖 Create GPT-4o-mini LLM with tool binding
+    console.info('🧠 Creating GPT-4o-mini LLM with tool binding...\n');
+    const llm = new ChatOpenAI({
+      model: 'gpt-4o-mini',
+      temperature: 0,
+    });
+
+    const llmWithTools = llm.bindTools(langchainTools as any);
+
+    // 🎯 Agent Loop - ReAct Pattern
+    console.info('🧪 Starting Agent Loop (ReAct Pattern)\n');
+    console.info('═'.repeat(60));
+
+    const userQuery = 'What is 42 plus 58?';
+    console.info(`\n❓ User Query: "${userQuery}"\n`);
+
+    const messages: BaseMessage[] = [new HumanMessage(userQuery)];
+
+    let iterationCount = 0;
+    const maxIterations = 10;
+    let continueLoop = true;
+
+    while (continueLoop && iterationCount < maxIterations) {
+      iterationCount++;
+      console.info(`\n[Iteration ${iterationCount}]`);
+      console.info('─'.repeat(60));
+
+      // Step 1: Call LLM with tools
+      console.info('🤔 LLM Thinking...');
+      const response = await llmWithTools.invoke(messages);
+      console.info(`LLM Response Content: ${response.content || '(no text content)'}`);
+
+      // Step 2: Check if LLM wants to use tools
+      if (response.tool_calls && response.tool_calls.length > 0) {
+        // Add assistant message to conversation
+        messages.push(response);
+
+        // Step 3: Execute each tool call
+        for (const toolCall of response.tool_calls) {
+          console.info(`\n🔧 Executing Tool: ${toolCall.name}`);
+          console.info(`   Input: ${JSON.stringify(toolCall.args)}`);
+
+          try {
+            // Execute via Matimo
+            const result = await matimo.execute(toolCall.name, toolCall.args);
+            console.info(`   ✅ Result: ${JSON.stringify(result)}`);
+
+            // Add tool result to conversation
+            messages.push(
+              new ToolMessage({
+                tool_call_id: toolCall.id || '',
+                content: JSON.stringify(result),
+                name: toolCall.name,
+              })
+            );
+          } catch (toolError) {
+            const msg = toolError instanceof Error ? toolError.message : String(toolError);
+            console.info(`   ❌ Error: ${msg}`);
+
+            // Add error to conversation
+            messages.push(
+              new ToolMessage({
+                tool_call_id: toolCall.id || '',
+                content: `Error: ${msg}`,
+                name: toolCall.name,
+              })
+            );
+          }
+        }
+      } else {
+        // Step 4: No more tools - agent reached conclusion
+        console.info('\n✅ Agent Reached Conclusion');
+        console.info(`\n📝 Final Response:\n${response.content || '(no response)'}`);
+        continueLoop = false;
+      }
+    }
+
+    if (iterationCount >= maxIterations) {
+      console.info('\n⚠️  Max iterations reached');
+    }
+
+    console.info('\n' + '═'.repeat(60));
+    console.info(`\n✨ Agent Loop Complete (${iterationCount} iterations)\n`);
+  } catch (error) {
+    console.error('❌ Agent failed:', error instanceof Error ? error.message : String(error));
+    process.exit(1);
+  }
+}
+
+// Run the agent
+runLangChainAgent().catch(console.error);

package/edit/edit-decorator.ts

@@ -0,0 +1,128 @@
+import {
+  MatimoInstance,
+  setGlobalMatimoInstance,
+  tool,
+  getPathApprovalManager,
+} from '@matimo/core';
+import fs from 'fs';
+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: Edit tool using @tool decorator pattern
+ * Demonstrates class-based file editing with automatic decoration
+ */
+class FileEditor {
+  @tool('edit')
+  async replaceContent(
+    filePath: string,
+    operation: string,
+    content: string,
+    startLine: number,
+    endLine: number
+  ): Promise<unknown> {
+    // Decorator automatically intercepts and executes via Matimo
+    return undefined;
+  }
+
+  @tool('edit')
+  async insertContent(
+    filePath: string,
+    operation: string,
+    content: string,
+    startLine: number,
+    endLine: number
+  ): Promise<unknown> {
+    // Decorator automatically intercepts and executes via Matimo
+    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('=== Edit Tool - Decorator Pattern (Interactive Approval) ===\n');
+
+  const editor = new FileEditor();
+
+  // Create a temp file for demonstration
+  const tempFile = path.join(__dirname, 'temp-demo-decorator.txt');
+  fs.writeFileSync(tempFile, 'Original line\nAnother line\nThird line\n');
+
+  try {
+    // Example 1: Replace through decorated method
+    console.info('1. Replacing content via decorator\n');
+    const result1 = await editor.replaceContent(tempFile, 'replace', 'Updated line', 1, 1);
+    console.info('Edit Result:', (result1 as any).success);
+    console.info('Lines Affected:', (result1 as any).linesAffected);
+    console.info('File content:');
+    console.info(fs.readFileSync(tempFile, 'utf-8'));
+    console.info('---\n');
+
+    // Example 2: Insert through decorated method
+    console.info('2. Inserting content via decorator\n');
+    const result2 = await editor.insertContent(tempFile, 'insert', 'Inserted line', 1, 0);
+    console.info('Insert Result:', (result2 as any).success);
+    console.info('Lines Affected:', (result2 as any).linesAffected);
+    console.info('File content:');
+    console.info(fs.readFileSync(tempFile, 'utf-8'));
+    console.info('---\n');
+  } catch (error: any) {
+    console.error('Error:', error.message);
+  } finally {
+    // Clean up temp file
+    if (fs.existsSync(tempFile)) {
+      fs.unlinkSync(tempFile);
+    }
+    if (!isReadlineClosed) {
+      rl.close();
+      isReadlineClosed = true;
+    }
+  }
+}
+
+decoratorExample();

package/edit/edit-factory.ts

@@ -0,0 +1,120 @@
+import { MatimoInstance } from '@matimo/core';
+import { getPathApprovalManager } from '@matimo/core';
+import fs from 'fs';
+import path from 'path';
+import { fileURLToPath } from 'url';
+import readline from 'readline';
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+
+// Reusable readline interface kept open for 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;
+});
+
+/**
+ * Interactive prompt helper for approval decisions
+ */
+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: Edit tool using factory pattern
+ * Demonstrates editing and modifying file contents with interactive approval
+ */
+async function editExample() {
+  // 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('=== Edit Tool - Factory Pattern (Interactive Approval) ===\n');
+
+  // Create a temp file for demonstration
+  const tempFile = path.join(__dirname, 'temp-demo.txt');
+  fs.writeFileSync(tempFile, 'Line 1\nLine 2\nLine 3\n');
+
+  try {
+    // Example 1: Replace text in file (replace line 2)
+    console.info('1. Replacing content in file\n');
+    console.info('Original content:');
+    console.info(fs.readFileSync(tempFile, 'utf-8'));
+    console.info('---\n');
+
+    const result = await matimo.execute('edit', {
+      filePath: tempFile,
+      operation: 'replace',
+      content: 'Line 2 (Modified)',
+      startLine: 2,
+      endLine: 2,
+    });
+
+    if ((result as any).success) {
+      console.info('Edit Result:', (result as any).success);
+      console.info('Lines Affected:', (result as any).linesAffected);
+      console.info('\nModified content:');
+      console.info(fs.readFileSync(tempFile, 'utf-8'));
+    } else {
+      console.info('Edit denied:', (result as any).error);
+    }
+    console.info('---\n');
+
+    // Example 2: Insert new content
+    console.info('2. Inserting new line\n');
+    const insertResult = await matimo.execute('edit', {
+      filePath: tempFile,
+      operation: 'insert',
+      content: 'New inserted line',
+      startLine: 2,
+    });
+
+    if ((insertResult as any).success) {
+      console.info('Insert Result:', (insertResult as any).success);
+      console.info('Lines Affected:', (insertResult as any).linesAffected);
+      console.info('\nFinal content:');
+      console.info(fs.readFileSync(tempFile, 'utf-8'));
+    } else {
+      console.info('Insert denied:', (insertResult as any).error);
+    }
+    console.info('---\n');
+  } catch (error: any) {
+    console.error('Error editing file:', error.message);
+  } finally {
+    // Clean up temp file
+    if (fs.existsSync(tempFile)) {
+      fs.unlinkSync(tempFile);
+    }
+    if (!isReadlineClosed) {
+      rl.close();
+      isReadlineClosed = true;
+    }
+  }
+}
+
+editExample();

package/edit/edit-langchain.ts

@@ -0,0 +1,272 @@
+#!/usr/bin/env node
+/**
+ * ============================================================================
+ * EDIT 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 which edit operations to use
+ * 3. Generates appropriate parameters based on context
+ * 4. Executes tools autonomously
+ * 5. Processes results and responds naturally
+ *
+ * Use this pattern when:
+ * ✅ Building true autonomous AI agents
+ * ✅ LLM should decide which tools to use
+ * ✅ Complex workflows with LLM reasoning
+ * ✅ Multi-step agentic processes
+ * ✅ User gives high-level instructions (not low-level API calls)
+ *
+ * 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 edit:langchain
+ *
+ *   # Or from examples/tools directory:
+ *   npm run edit:langchain
+ *
+ * WHAT IT DOES:
+ * ─────────────────────────────────────────────────────────────────────────
+ * This example shows an AI agent that can:
+ * 1. Replace text in files
+ * 2. Insert new content
+ * 3. Delete lines
+ * 4. Append to files
+ * 5. Respond naturally in conversation style
+ *
+ * Example conversation:
+ *   User: "Update the TODO list - mark first item as DONE and add error handling"
+ *   AI Agent: "I'll help you update the TODO list..."
+ *   [AI Agent calls edit tool multiple times]
+ *   AI Agent: "Done! I've updated the file with your changes."
+ *
+ * ============================================================================
+ */
+
+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));
+
+/**
+ * Run AI Agent with Edit tools
+ * The agent receives natural language requests and decides which edit operations to use
+ */
+// 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');
+    });
+  });
+}
+
+async function runEditAIAgent() {
+  console.info('\n╔════════════════════════════════════════════════════════╗');
+  console.info('║     Edit 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-..."');
+    console.info('   Get one from: https://platform.openai.com/api-keys');
+    process.exit(1);
+  }
+
+  console.info('🤖 Using OpenAI (GPT-4o-mini) as the AI agent\n');
+
+  // Create a temp file for the agent to work with
+  const tempFile = path.join(__dirname, 'temp-agent-edit-demo.txt');
+  fs.writeFileSync(
+    tempFile,
+    `Project TODO List
+================
+- TODO: Implement authentication module
+- TODO: Add database migrations
+- TODO: Write API documentation
+- TODO: Set up CI/CD pipeline
+`
+  );
+
+  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 edit tool
+    console.info('💬 Loading edit tool...');
+    const matimoTools = matimo.listTools();
+    const editTools = matimoTools.filter((t) => t.name === 'edit') as ToolDefinition[];
+    console.info(`✅ Loaded ${editTools.length} edit tool(s)\n`);
+
+    if (editTools.length === 0) {
+      console.error('❌ Edit tool not found');
+      process.exit(1);
+    }
+
+    // Convert to LangChain tools using the built-in converter
+    const langchainTools = await convertToolsToLangChain(editTools, 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: Replace TODO with DONE',
+        request: `Mark the first authentication TODO as DONE in file ${tempFile}. Then describe what you did.`,
+      },
+      {
+        title: 'Example 2: Insert new item',
+        request: `Add a new TODO "Set up error logging" after line 5 in file ${tempFile}. Confirm the action and tell me how many lines were affected.`,
+      },
+      {
+        title: 'Example 3: List file content',
+        request: `Show me the current content of file ${tempFile} (use read tool if available, or describe the final state after your edits)`,
+      },
+    ];
+
+    console.info('🧪 Running AI Agent Tasks');
+    console.info('═'.repeat(60));
+    console.info(`📁 Working with: ${tempFile}\n`);
+
+    // Show initial file content
+    console.info('📄 Initial file content:');
+    console.info('─'.repeat(60));
+    console.info(fs.readFileSync(tempFile, 'utf-8'));
+    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);
+
+          console.info(`🤖 Agent: ${content || '(Tool executed 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📄 Final file content:');
+    console.info('─'.repeat(60));
+    console.info(fs.readFileSync(tempFile, 'utf-8'));
+    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 generates tool parameters based on context');
+    console.info('  ✅ Agentic reasoning and decision-making\n');
+    console.info('⚠️  Note on agent responses:');
+    console.info('  The agent DOES call the real LLM to decide which tool to use.');
+    console.info('  However, LangChain agents generate minimal responses when tools succeed.');
+    console.info('  The agent autonomously executes tools without verbose narration.\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(tempFile)) {
+      fs.unlinkSync(tempFile);
+    }
+    if (!isReadlineClosed) {
+      rl.close();
+      isReadlineClosed = true;
+    }
+  }
+}
+
+// Run the AI agent
+runEditAIAgent().catch(console.error);