Merge pull request #60 from browserbase/kj/smithery

[feature]: dockerfile and smithery setup

Author: Kylejeong2

browserbase/Dockerfile

@@ -1,22 +1,46 @@
-# Basic Node.js Dockerfile
-FROM node:20-slim
+# Build stage
+FROM node:20-slim AS builder
 
-WORKDIR /usr/src/app
+WORKDIR /app
 
-# Install dependencies
-COPY package*.json ./
-RUN npm ci --only=production
+# Copy package files first for better layer caching
+COPY package.json package-lock.json ./
 
-# Copy application code
-COPY dist ./dist
-COPY src ./src
+# Install all dependencies including dev dependencies for building
+# --ignore-scripts prevents the prepare script from running prematurely
+RUN npm ci --ignore-scripts
 
-# Define environment variables (can be overridden)
+# Copy all source files
+COPY . .
+
+# Build the TypeScript source code manually instead of using the npm script
+RUN npx tsc && npx shx chmod +x dist/*.js 2>/dev/null || echo "No executable JS files found"
+
+# Production stage
+FROM node:18-alpine
+
+# Set the working directory
+WORKDIR /app
+
+# Copy package files
+COPY package.json package-lock.json ./
+
+# Install only production dependencies
+# --ignore-scripts prevents the prepare script from running
+RUN npm ci --omit=dev --ignore-scripts
+
+# Copy built files from builder stage
+COPY --from=builder /app/dist /app/dist
+COPY --from=builder /app/cli.js /app/cli.js
+COPY --from=builder /app/index.js /app/index.js
+COPY --from=builder /app/index.d.ts /app/index.d.ts
+COPY --from=builder /app/config.d.ts /app/config.d.ts
+
+# Define environment variables (will be provided by Smithery)
 ENV NODE_ENV=production
-# ENV BROWSERBASE_API_KEY=your_api_key
-# ENV BROWSERBASE_PROJECT_ID=your_project_id
 
-# Expose a default port (useful if deploying as a service, though stdio is used now)
-EXPOSE 8080
+# Expose a default port (useful if deploying as a service)
+EXPOSE 8931
 
-CMD [ "node", "dist/index.js" ] 
+# Command to run the application
+CMD [ "node", "cli.js", "--port", "8931" ] 

browserbase/README.md

@@ -35,7 +35,28 @@ to provide browser automation tools.
 
 ## Local Dev
 
-To run locally we can self-host over SSE. 
+To run locally we can use STDIO or self-host over SSE. 
+
+### STDIO: 
+
+To your MCP Config JSON file add the following: 
+
+```json
+{
+  "mcpServers": {
+    "playwright": {
+      "command" : "node",
+      "args" : ["/path/to/mcp-server-browserbase/browserbase/cli.js"],
+      "env": {
+        "BROWSERBASE_API_KEY": "",
+        "BROWSERBASE_PROJECT_ID": ""
+      }
+    }
+  }
+}
+```
+
+### SSE: 
 
 ```bash
    node cli.js --port 8931

browserbase/smithery.yaml

@@ -0,0 +1,52 @@
+# Smithery configuration file: https://smithery.ai/docs/config#smitheryyaml
+
+startCommand:
+  # Using stdio type which is the most common for MCPs
+  type: stdio
+  configSchema:
+    # JSON Schema defining the configuration options for the MCP.
+    type: object
+    required:
+      - browserbaseApiKey
+      - browserbaseProjectId
+    properties:
+      browserbaseApiKey:
+        type: string
+        description: The API key for Browserbase.
+      browserbaseProjectId:
+        type: string
+        description: The project ID for Browserbase.
+      port:
+        type: number
+        description: The port to listen on.
+      host:
+        type: string
+        description: The host to listen on.
+      contextId:
+        type: string
+        description: The context ID to use for the session.
+      persist:
+        type: boolean
+        description: Whether to persist the context.
+      proxies:
+        type: boolean
+        description: Whether to use proxies.
+      cookies:
+        type: object
+        description: Cookies to use for the session.
+      browserWidth:
+        type: number
+        description: Width of the browser window.
+      browserHeight:
+        type: number
+        description: Height of the browser window.
+      
+  commandFunction: |
+    config => ({
+      command: 'node',
+      args: ['cli.js'],
+      env: {
+        BROWSERBASE_API_KEY: config.browserbaseApiKey,
+        BROWSERBASE_PROJECT_ID: config.browserbaseProjectId
+      }
+    })