* docs: overhaul READMEs across all major packages - Root README: restructure with feature table, LLM provider table, comparison matrix, architecture map, and docs link - New: packages/browseros/README.md (Chromium fork build system) - New: apps/server/README.md (MCP server + agent loop) - New: packages/cdp-protocol/README.md (CDP type bindings) - Polish: agent-sdk (badges, prerequisites, multi-step example, links) - Polish: cli (badges, install section, MCP server section, links) - Polish: agent extension (badges, WXT mention, architecture context) - Polish: eval (badges, paper links) * fix: address review — consistent tool count and correct default port - CLI README: "54 MCP tools" → "53+ MCP tools" to match root and server docs - Agent SDK README: localhost:3000 → localhost:9100 to match documented default * docs: add detailed comparison links to How We Compare section * docs: update comparison table with verified competitor data Research all 5 competitors via official websites and docs: - Chrome: no AI agent, Gemini Nano only, MV3 weakening ad blocking - Brave: BYOM feature, local models via BYOM, Shields ad blocking, MV2+MV3 - Dia: Skills-based AI, no BYOK, cloud AI, acquired by Atlassian - Comet: full cloud-based agent, built-in ad blocking, extensions on desktop - Atlas: standalone Chromium browser with Agent Mode, 30-day cloud memory Renamed Arc/Dia column to just Dia (Arc is sunset). * docs: simplify comparison table with clean checkmarks and key differentiators * docs: update browseros-agent README — remove submodule note, add missing packages
5.7 KiB
BrowserOS Agent Extension
The built-in browser extension that powers BrowserOS's AI interface — new tab with unified search, side panel chat, onboarding, and settings. Built with WXT and React.
For user-facing feature documentation, see docs.browseros.com.
Features
- AI-Powered New Tab: Custom new tab page with unified search across Google and AI assistants
- Side Panel Chat: Full-featured chat interface for interacting with BrowserOS
- Multi-Provider Support: Connect to various LLM providers (OpenAI, Anthropic, Azure, Bedrock, and more)
- MCP Integration: Model Context Protocol support for extending AI capabilities
- Visual Feedback: Animated glow effect on tabs during AI agent operations
- Privacy-First: Local data handling with configurable provider settings
How It Connects
The extension communicates with the BrowserOS Server running locally. The server handles the AI agent loop, MCP tools, and CDP connections — the extension provides the UI layer.
Project Structure
entrypoints/
├── background.ts # Service worker for extension lifecycle
├── content.ts # Content script (Google pages)
├── glow.content/ # Visual glow effect for active AI operations
├── newtab/ # Custom new tab page
├── sidepanel/ # AI chat side panel
├── onboarding/ # First-time user onboarding flow
└── options/ # Extension settings dashboard
components/
└── ui/ # Shadcn UI components
lib/ # Shared utilities and hooks
Entrypoints
Background (background.ts)
The service worker that manages:
- Side panel toggling via browser action
- BrowserOS Core health checks
- MCP tools fetching
- LLM provider configuration backup
- Extension installation triggers (opens onboarding)
New Tab (newtab/)
Custom new tab replacement featuring:
- Unified Search Bar: Search Google or ask AI directly
- Tab Context: Attach open tabs to provide context for AI queries
- Search Suggestions: Real-time suggestions from multiple providers (Google, Bing, DuckDuckGo, Yahoo, Yandex)
- AI Suggestions: Context-aware BrowserOS action suggestions
- Top Sites: Quick access to frequently visited sites
- Theme Toggle: Light/dark mode support
Side Panel (sidepanel/)
The main chat interface for BrowserOS:
- Chat Modes: Switch between chat and agent modes
- Provider Selector: Choose from configured LLM providers
- Tab Attachment: Include browser tab content as context
- Tool Calls: Visual display of MCP tool invocations
- Message Actions: Like/dislike feedback, copy responses
- Conversation Management: Start new conversations, view history
Onboarding (onboarding/)
Multi-step onboarding flow for new users:
- Welcome screen with product highlights
- Feature showcase with animated cards
- Step-by-step setup wizard
- Provider configuration guidance
Options (options/)
Settings dashboard with multiple sections:
- AI Settings: Configure LLM providers (API keys, models, base URLs)
- LLM Hub: Manage chat-specific provider settings
- MCP Settings: View and manage MCP server connections
- Connect MCP: Add managed or custom MCP servers
Glow Content (glow.content/)
Content script that creates a visual indicator (pulsing orange glow) around the browser viewport when an AI agent is actively working on a tab.
Development
Prerequisites
- Bun installed
- Chrome or Chromium-based browser
- BrowserOS Server running locally (for full functionality)
Setup
# Copy environment file
cp .env.example .env.development
# Install dependencies
bun install
# Start development server
bun run dev
# Build for production
bun run build
# Create distributable zip
bun run zip
Loading the Extension
- Run
bun run devto start the development server - Open Chrome and navigate to
chrome://extensions - Enable "Developer mode"
- Click "Load unpacked" and select the
dist/directory
Environment Variables
Create a .env.development file for local development:
SENTRY_ORG=your-org
SENTRY_PROJECT=your-project
SENTRY_AUTH_TOKEN=your-token
GraphQL Schema
Codegen requires a GraphQL schema. By default it uses the bundled schema/schema.graphql, so no extra setup is needed. If you have access to the original API source, you can set the following environment variable:
GRAPHQL_SCHEMA_PATH=/path/to/api-repo/.../schema.graphql
Development Tooling
Bun
Bun is the exclusive runtime and package manager:
- All scripts use
bun run <script>instead of npm - Package installation via
bun install - Environment files automatically loaded (no dotenv needed)
- Enforced via
enginesfield inpackage.json
Biome
Unified linter and formatter configured in biome.json:
- Formatting: 2-space indentation, single quotes, no semicolons
- Linting: Recommended rules plus custom rules for unused imports/variables
- CSS Support: Tailwind directives parsing enabled
- Import Organization: Automatic import sorting via assist actions
Scripts
| Script | Description |
|---|---|
bun run dev |
Start development mode with hot reload |
bun run build |
Build production extension |
bun run zip |
Create distributable zip file |
bun run lint |
Run Biome linter |
bun run lint:fix |
Auto-fix linting issues |
bun run typecheck |
Run TypeScript type checking |
bun run codegen |
Generate GraphQL types |
bun run clean:cache |
Clear build caches |