Merge pull request #69 from browserbase/kj/cleanup

General clean up

Author: Kylejeong2

browserbase/package.json

@@ -1,8 +1,7 @@
 {
   "name": "@browserbasehq/mcp",
-  "version": "1.0.4",
+  "version": "1.0.5",
   "description": "MCP server for browser automation using browserbase",
-  "license": "MIT",
   "author": "Browserbase, Inc. (https://browserbase.com)",
   "homepage": "https://browserbase.com",
   "type": "module",
@@ -11,6 +10,7 @@
     "node": ">=18"
   },
   "files": [
+    "../assets/browserbase-mcp.png",
     "dist",
     "cli.js",
     "index.d.ts",

browserbase/src/config.ts

@@ -4,11 +4,11 @@ import path from 'path';
 import { sanitizeForFilePath } from './tools/utils.js'; 
 import type { Cookie } from "playwright-core";
 
-export type ToolCapability = 'core' | string; // Example capabilities
+export type ToolCapability = 'core' | string; 
 
 export interface Config {
-  browserbaseApiKey?: string; // Make optional for easier merging
-  browserbaseProjectId?: string; // Make optional for easier merging
+  browserbaseApiKey?: string; 
+  browserbaseProjectId?: string; 
   server?: {
     port?: number;
     host?: string;

browserbase/src/context.ts

@@ -3,49 +3,28 @@ import type { BrowserSession } from "./sessionManager.js";
 import {
   getSession,
   defaultSessionId,
-  closeAllSessions,
 } from "./sessionManager.js";
-import type { Tool, ToolContext, ToolResult } from "./tools/tool.js";
+import type { Tool, ToolResult } from "./tools/tool.js";
 import type { Config } from "../config.js";
 import {
   Resource,
   CallToolResult,
   TextContent,
   ImageContent,
-  ResourceListChangedNotificationSchema,
 } from "@modelcontextprotocol/sdk/types.js";
 import { z } from "zod";
 import { PageSnapshot } from "./pageSnapshot.js";
-import { Writable } from "stream"; // Import Writable for process.stderr
-import type { Page, Locator } from "playwright"; // Import Page and Locator types
+import type { Page, Locator } from "playwright"; 
 
-// Define ToolActionResult locally if not exported
 export type ToolActionResult =
   | { content?: (ImageContent | TextContent)[] }
   | undefined
   | void;
 
 /**
  * Manages the context for tool execution within a specific Browserbase session.
- *
- * Role Analogy:
- * This class holds session-specific state (like latest snapshots, resources)
- * and provides access to the active page/browser for the current session.
- * This is somewhat analogous to the role of the `Tab` class in the Playwright
- * MCP example, which encapsulates state for a single page.
- *
- * Differences from Playwright MCP Context Example:
- * - Browser Lifecycle: This Context does NOT manage the browser launch/
- *   connection lifecycle; that is handled by `sessionManager` (sessionManager.ts) interacting
- *   with the Browserbase API.
- * - Tab Management: This Context focuses on a single active session determined
- *   by `currentSessionId`, unlike the Playwright example which explicitly
- *   manages an array of `Tab` objects.
- * - Execution Model: This Context uses a `run`/`CallToolResult` pattern. Its `run`
- *   method calls `tool.run`, which performs the action and returns the final
- *   result structure. The Playwright example uses a `handle`/`ToolActionResult`
- *   pattern where the Context interprets the result to perform actions.
  */
+
 export class Context {
   private server: Server;
   public readonly config: Config;

browserbase/src/index.ts

@@ -1,10 +1,6 @@
-#!/usr/bin/env node
-
-// Load environment variables early
 import dotenv from "dotenv";
 dotenv.config();
 
-import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
 import { Config } from "../config.js";
 import type { Tool } from "./tools/tool.js";
 
@@ -15,6 +11,7 @@ import getText from "./tools/getText.js";
 import session from "./tools/session.js";
 import common from "./tools/common.js";
 import contextTools from "./tools/context.js";
+
 import { Server } from "@modelcontextprotocol/sdk/server/index.js";
 import { CallToolRequestSchema, ListResourcesRequestSchema, ListToolsRequestSchema, ReadResourceRequestSchema } from "@modelcontextprotocol/sdk/types.js";
 import { z } from "zod";
@@ -32,8 +29,6 @@ Object.entries(requiredEnvVars).forEach(([name, value]) => {
   if (!value) throw new Error(`${name} environment variable is required`);
 });
 
-// const serverVersion = "0.5.1";
-
 export async function createServer(config: Config): Promise<Server> {
   // Create the server
   const server = new Server(
@@ -139,10 +134,9 @@ export async function createServer(config: Config): Promise<Server> {
   // Wrap server close to also close context
   const originalClose = server.close.bind(server);
   server.close = async () => {
-    // await context.closeSession();
     await originalClose();
   };
 
-  // Return the configured server instance, DO NOT connect here
+  // Return the configured server instance
   return server;
 } 

browserbase/src/pageSnapshot.ts

@@ -1,32 +1,11 @@
-/**
- * Copyright (c) Microsoft Corporation.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-// Use types from playwright-core consistent with the project
 import type { Page, FrameLocator, Locator } from 'playwright-core';
 import yaml from 'yaml';
-// Import specific YAML types, remove Scalar from type-only
-// Removed YAML types no longer needed by this version
-import { Writable } from 'stream'; // Import Writable for process.stderr - KEEPING this as it might be used elsewhere implicitly, though not directly in this class version
 
 type PageOrFrameLocator = Page | FrameLocator;
 
 export class PageSnapshot {
   private _frameLocators: PageOrFrameLocator[] = [];
   private _text!: string;
-  // Removed _snapshotDoc as it's not used in this version
 
   constructor() {
   }
@@ -42,7 +21,6 @@ export class PageSnapshot {
   }
 
   private async _build(page: Page) {
-    // Removed storing to _snapshotDoc
     const yamlDocument = await this._snapshotFrame(page);
     this._text = [
       `- Page Snapshot`,
@@ -53,15 +31,12 @@ export class PageSnapshot {
     ].join('\n');
   }
 
-  // Reverted _snapshotFrame to match the provided example exactly
   private async _snapshotFrame(frame: Page | FrameLocator) {
     const frameIndex = this._frameLocators.push(frame) - 1;
-    // Removed logging from this version
     let snapshotString = '';
     try {
         snapshotString = await (frame.locator('body') as any).ariaSnapshot({ ref: true, emitGeneric: true });
     } catch (e) {
-        // Simple error string, removed logging
         snapshotString = `error: Could not take snapshot. Error: ${e instanceof Error ? e.message : String(e)}`;
     }
 
@@ -79,21 +54,17 @@ export class PageSnapshot {
       } else if (yaml.isScalar(node)) {
         if (typeof node.value === 'string') {
           const value = node.value;
-          // Simplified frame prefixing logic from example
           if (frameIndex > 0)
             node.value = value.replace('[ref=', `[ref=f${frameIndex}`);
 
           if (value.startsWith('iframe ')) {
-            const ref = value.match(/\[ref=(.*)\]/)?.[1]; // Original regex from example
+            const ref = value.match(/\[ref=(.*)\]/)?.[1]; 
             if (ref) {
               try {
-                // Original iframe locator strategy from example
                 const childFrameLocator = frame.frameLocator(`aria-ref=${ref}`);
                 const childSnapshot = await this._snapshotFrame(childFrameLocator);
-                // Original createPair structure
                 return snapshot.createPair(node.value, childSnapshot);
               } catch (error) {
-                 // Original error handling
                 return snapshot.createPair(node.value, '<could not take iframe snapshot>');
               }
             }
@@ -107,20 +78,12 @@ export class PageSnapshot {
     if (snapshot.contents) {
         await visit(snapshot.contents);
     } else {
-        // Handle empty snapshot doc contents like original
         const emptyMapDoc = yaml.parseDocument('{}');
         snapshot.contents = emptyMapDoc.contents;
     }
-    // Removed logging
-    return snapshot; // Return the processed document
+    return snapshot; 
   }
 
-  // Removed findNodeByRef helper
-
-  // Removed extractRoleAndName helper
-
-
-  // Reverted refLocator to match the provided example exactly
   refLocator(ref: string): Locator {
     let frameIndex = 0;
     let frame: PageOrFrameLocator;
@@ -144,8 +107,6 @@ export class PageSnapshot {
     if (!frame)
       throw new Error(`Frame (index ${frameIndex}) could not be determined. Provide ref from the most current snapshot.`);
 
-    // Removed console warnings and complex strategy
-    // Use the exact locator strategy from the Playwright MCP example
     return frame.locator(`aria-ref=${targetRef}`);
   }
 }

browserbase/src/sessionManager.ts

@@ -17,8 +17,10 @@ export type BrowserSession = {
 
 // Global state for managing browser sessions
 const browsers = new Map<string, BrowserSession>();
+
 // Keep track of the default session explicitly
 let defaultBrowserSession: BrowserSession | null = null;
+
 // Define a specific ID for the default session
 export const defaultSessionId = "browserbase_session_main";
 
@@ -181,9 +183,7 @@ export async function createNewBrowserSession(
           ? creationError.message
           : String(creationError)
       }`
-    ); // Keep ERROR comment if useful, but removed from output
-    // Attempt to clean up partially created resources if possible (e.g., close browser if connection succeeded but context/page failed)
-    // This part is complex, might need more state tracking. For now, just log and re-throw.
+    ); 
     throw new Error(
       `Failed to create/connect session ${newSessionId}: ${errorMessage}`
     );

browserbase/src/tools/common.ts

@@ -1,22 +1,9 @@
-// import { AccessibilitySnapshot, AccessibilityNode } from "@modelcontextprotocol/sdk/types.js"; // Type might not be exported
-
-// Common state and helpers for tools, moved from handlers.ts
-
-// Store latest snapshot per session - MOVED TO Context
-// export const latestSnapshots = new Map<string, any>(); 
-
-// findNodeByRef helper removed as interaction tools now use aria-ref selector directly. 
-
-// No common state remains here for now.
 export {}; // Ensure file is treated as a module 
 
 import { z } from 'zod';
-import type { Tool, ToolSchema, ToolResult } from "./tool.js"; // Assuming ToolContext is needed if handle uses context
-import type { Context } from '../context.js'; // Import main Context for handle
-import type { ToolActionResult } from '../context.js'; // Import ToolActionResult
-
-// Assuming createSuccessResult/createErrorResult exist in toolUtils.js
-// import type { CallToolResult } from '@modelcontextprotocol/sdk/types.js';
+import type { Tool, ToolSchema, ToolResult } from "./tool.js"; 
+import type { Context } from '../context.js'; 
+import type { ToolActionResult } from '../context.js'; 
 
 // --- Tool: Wait ---
 const WaitInputSchema = z.object({
@@ -121,10 +108,4 @@ export default [
     waitTool,
     closeTool,
     resizeTool,
-];
-
-// Remove old direct exports
-// export const waitTool: Tool<WaitInput> = { ... };
-// export const closeTool: Tool<CloseInput> = { ... };
-// export const resizeTool: Tool<ResizeInput> = { ... };
-// export function common(): Tool[] { ... }; 
+];

browserbase/src/tools/context.ts

@@ -1,13 +1,11 @@
 import { z } from "zod";
-import type { Tool, ToolSchema, ToolContext, ToolResult } from "./tool.js";
-// import { createSuccessResult, createErrorResult } from "./toolUtils.js";
+import type { Tool, ToolSchema, ToolResult } from "./tool.js";
 import type { Context } from "../context.js";
 import type { ToolActionResult } from "../context.js";
 import { Browserbase } from "@browserbasehq/sdk";
 
 // Store contexts in memory 
-// In a production app, these should be persisted to a database
-const contexts = new Map<string, string>();
+const contexts = new Map<string, string>(); 
 
 // --- Tool: Create Context ---
 const CreateContextInputSchema = z.object({
@@ -120,8 +118,7 @@ async function handleDeleteContext(
 
     console.error(`Deleting Browserbase context: ${contextId}`);
 
-    // Delete from Browserbase API
-    // The SDK may not have a delete method directly, so we use the REST API
+    // Delete using Browserbase API
     const response = await fetch(`https://api.browserbase.com/v1/contexts/${contextId}`, {
       method: 'DELETE',
       headers: {

browserbase/src/tools/getText.ts

@@ -1,9 +1,7 @@
 import { z } from 'zod';
-// Import ToolResult and adjust Tool type usage
-import type { Tool, ToolSchema, ToolContext, ToolResult } from "./tool.js";
-import { createSuccessResult, createErrorResult } from "./toolUtils.js"; // Assuming these exist
-import type { Context } from '../context.js'; // For handle signature
-import type { ToolActionResult } from '../context.js'; // For action return type
+import type { Tool, ToolSchema, ToolResult } from "./tool.js";
+import type { Context } from '../context.js'; 
+import type { ToolActionResult } from '../context.js'; 
 
 // --- Tool: Get Text ---
 const GetTextInputSchema = z.object({
@@ -34,7 +32,6 @@ async function handleGetText(context: Context, params: GetTextInput): Promise<To
             }
             return { content: [{ type: 'text', text: textContent ?? "" }] };
         } catch (error) {
-            // Log error? Throw? Action results don't easily convey errors back to Context.run
             console.error(`GetText action failed: ${error}`);
             throw error; // Rethrow to be caught by Context.run's try/catch around handle/action
         }
@@ -55,5 +52,4 @@ const getTextTool: Tool<typeof GetTextInputSchema> = {
     handle: handleGetText,
 };
 
-// Export the single tool object as default
-export default [getTextTool]; // Export as an array containing the tool 
+export default [getTextTool];