Merge branch 'main' of https://github.com/ferrislucas/iterm-mcp into main

Author: ferrislucas

.github/images/demo.png

@@ -1,4 +1,4 @@
-![Main Image](.github/images/robot-hand.jpg)
+![Main Image](.github/images/demo.png)
 
 # iterm-mcp 
 [![smithery badge](https://smithery.ai/badge/iterm-mcp)](https://smithery.ai/server/iterm-mcp)
@@ -10,7 +10,8 @@ iterm-mcp will execute commands in the currently active tab of iTerm.
 <a href="https://glama.ai/mcp/servers/h89lr05ty6"><img width="380" height="200" src="https://glama.ai/mcp/servers/h89lr05ty6/badge" alt="iTerm Server MCP server" /></a>
 
 ### Tools
-- `execute_shell_command` - Executes a command in the current iTerm session
+- `write_to_terminal` - Writes to the active iTerm terminal - often used to run a command
+- `read_terminal_output` - Reads the output from the active iTerm terminal
 
 ## Installation
 

.github/images/robot-hand.jpg

@@ -3,6 +3,7 @@ import { promisify } from 'node:util';
 import { openSync, closeSync } from 'node:fs';
 import { isatty } from 'node:tty';
 import TTYProcessTracker from './TTYProcessTracker.js';
+import TtyOutputReader from './TtyOutputReader.js';
 
 const execPromise = promisify(exec);
 const sleep = promisify(setTimeout);
@@ -42,7 +43,7 @@ class CommandExecutor {
 
     try {
       // Retrieve the buffer before executing the command
-      const initialBuffer = await this.retrieveBuffer();
+      const initialBuffer = await TtyOutputReader.retrieveBuffer();
 
       await execPromise(`osascript -e '${ascript}'`);
 
@@ -59,7 +60,7 @@ class CommandExecutor {
       // Give a small delay for output to settle
       await new Promise(resolve => setTimeout(resolve, 200));
 
-      const afterCommandBuffer = await this.retrieveBuffer();
+      const afterCommandBuffer = await TtyOutputReader.retrieveBuffer();
 
       // Extract only the new content by comparing buffers
       const commandOutput = this.extractCommandOutput(initialBuffer, afterCommandBuffer, command);
@@ -121,23 +122,6 @@ class CommandExecutor {
     }
   }
 
-  private async retrieveBuffer(): Promise<string> {
-    const ascript = `
-      tell application "iTerm2"
-        tell front window
-          tell current session of current tab
-            set numRows to number of rows
-            set allContent to contents
-            return allContent
-          end tell
-        end tell
-      end tell
-    `;
-    
-    const { stdout: finalContent } = await execPromise(`osascript -e '${ascript}'`);
-    return finalContent.trim();
-  }
-
   private async retrieveTtyPath(): Promise<string> {
     const ascript = `
       tell application "iTerm2"

README.md

@@ -0,0 +1,29 @@
+import { exec } from 'node:child_process';
+import { promisify } from 'node:util';
+
+const execPromise = promisify(exec);
+
+export default class TtyOutputReader {
+  static async call(linesOfOutput: number) {
+    const buffer = await this.retrieveBuffer();
+    const lines = buffer.split('\n');
+    return lines.slice(-linesOfOutput).join('\n');
+  }
+
+  static async retrieveBuffer(): Promise<string> {
+    const ascript = `
+      tell application "iTerm2"
+        tell front window
+          tell current session of current tab
+            set numRows to number of rows
+            set allContent to contents
+            return allContent
+          end tell
+        end tell
+      end tell
+    `;
+    
+    const { stdout: finalContent } = await execPromise(`osascript -e '${ascript}'`);
+    return finalContent.trim();
+  }
+}

src/CommandExecutor.ts

@@ -16,7 +16,7 @@ import {
   ListToolsRequestSchema,
 } from "@modelcontextprotocol/sdk/types.js";
 import CommandExecutor from "./CommandExecutor.js";
-
+import TtyOutputReader from "./TtyOutputReader.js";
 
 /**
  * Type alias for a note object.
@@ -50,7 +50,6 @@ const server = new Server(
   }
 );
 
-
 /**
  * Handler that lists available tools.
  * Exposes a single "create_note" tool that lets clients create new notes.
@@ -59,18 +58,32 @@ server.setRequestHandler(ListToolsRequestSchema, async () => {
   return {
     tools: [
       {
-        name: "execute_shell_command",
-        description: "Execute a shell command in the active iIterm session",
+        name: "write_to_terminal",
+        description: "Writes text to the active iTerm terminal - often used to run a command in the terminal",
         inputSchema: {
           type: "object",
           properties: {
             command: {
               type: "string",
-              description: "The command to run"
+              description: "The command to run or text to write to the terminal"
             },
           },
           required: ["command"]
         }
+      },
+      {
+        name: "read_terminal_output",
+        description: "Reads the output from the active iTerm terminal",
+        inputSchema: {
+          type: "object",
+          properties: {
+            linesOfOutput: {
+              type: "number",
+              description: "The number of lines of output to read. Default is the most recent 25 lines of output"
+            },
+          },
+          required: ["linesOfOutput"]
+        }
       }
     ]
   };
@@ -82,7 +95,7 @@ server.setRequestHandler(ListToolsRequestSchema, async () => {
  */
 server.setRequestHandler(CallToolRequestSchema, async (request) => {
   switch (request.params.name) {
-    case "execute_shell_command": {
+    case "write_to_terminal": {
       let executor = new CommandExecutor()
       const command = String(request.params.arguments?.command)
       const output = await executor.executeCommand(command)
@@ -94,7 +107,17 @@ server.setRequestHandler(CallToolRequestSchema, async (request) => {
         }]
       };
     }
+    case "read_terminal_output": {
+      const linesOfOutput = Number(request.params.arguments?.linesOfOutput) || 25
+      const output = await TtyOutputReader.call(linesOfOutput)
 
+      return {
+        content: [{
+          type: "text",
+          text: output
+        }]
+      };
+    }
     default:
       throw new Error("Unknown tool");
   }