docs

Harbor Documentation

Find the right docs for what you're trying to do.

---

I want to...

Understand what this is

→ Web Agent API Overview — Why this exists, the problem it solves, and how it works

Try the demos

→ Quickstart — Install Harbor and run demos in 5 minutes

Build an app using the API

→ Quickstart Part 2 — Write your first AI-powered web app

→ Web Agents API Reference — Complete API documentation

→ Building on the Web Agents API — Portable guide for other projects (copy into your repo; examples, API summary, capabilities)

Test my app that uses the API

→ Testing your app — Generate a test harness (mock + Playwright E2E) with node scripts/generate-test-harness.mjs <target-dir> from the Harbor repo

Create custom tools (MCP servers)

→ Quickstart Part 3 — Build your first MCP server in 15 minutes

→ MCP Authoring Guide — Complete guide to writing MCP servers

Understand the full specification

→ Explainer — Full spec with Web IDL and security model

Contribute to Harbor

→ Contributing Guide — Build, test, and submit changes

---

Documentation Index

For Everyone

Document	Description
README	Project overview and quick links
Quickstart	Build, install, run demos, create your first app
Firefox Setup	Detailed Firefox setup (primary browser)
Chrome Setup	Detailed Chrome/Chromium setup
Safari Setup	Safari setup (experimental)

For Developers (Building ON the API)

Document	Description
Web Agents API Reference	Complete window.ai and window.agent docs
Building on the Web Agents API	Portable guide for other projects — copy into your repo for examples, API summary, capabilities
Testing your app	Unit tests with mock, E2E with Playwright + Harbor extensions — generate harness via scripts/generate-test-harness.mjs
JS API Reference	Detailed API with TypeScript types
Sessions Guide	When to use window.ai vs agent.sessions
Working Examples	Copy-paste ready code
Demo Source	Full demo implementations

For Tool Creators (Building MCP Servers)

Document	Description
Quickstart Part 3	Create your first tool in 15 minutes
MCP Authoring Guide	Complete guide (JS and WASM)
OAuth Guide	OAuth setup, integration, and troubleshooting
JS Template	Copy-paste JavaScript starter
Rust/WASM Template	Copy-paste Rust starter
MCP Manifest Spec	Full manifest reference
Example: Gmail	Real-world OAuth integration

For AI Coding Assistants

Building with Claude, Cursor, Copilot, or another AI assistant? Point your AI to LLMS.txt — it's specifically designed for AI tools to quickly understand and build with the Web Agents API.

Document	Description
LLMS.txt	Compact, token-efficient API reference for AI coding assistants

The Specification

Document	Description
Specification Overview	What and why
Full Explainer	Complete spec with Web IDL
Security & Privacy	Threat model and mitigations

For Contributors (Building Harbor Itself)

Document	Description
Architecture	System design and components
Contributing Guide	Development setup and workflow
MCP Host	MCP execution environment internals
Test Suite	Run and write Harbor's unit and E2E tests
Testing your app	Test your Web Agents API app (mock + E2E harness)

Reference

Document	Description
User Guide	End-user installation and configuration
OAuth Guide	OAuth setup, configuration, and troubleshooting
MCP Manifest Spec	MCP server manifest format
MCP WASM Manifest	WASM server manifest format

---

Document Audience

                         ┌─────────────────────────────┐
                         │    Understand the Vision    │
                         │  spec/README.md             │
                         └─────────────┬───────────────┘
                                       │
                         ┌─────────────▼───────────────┐
                         │       Try the Demos         │
                         │  QUICKSTART.md (Part 1)     │
                         └─────────────┬───────────────┘
                                       │
       ┌───────────────────────────────┼───────────────────────────────┐
       │                               │                               │
       ▼                               ▼                               ▼
┌─────────────────────┐   ┌─────────────────────┐   ┌─────────────────────┐
│   Build with API    │   │  Create MCP Tools   │   │  Contribute/Hack    │
│                     │   │                     │   │                     │
│ QUICKSTART (Part 2) │   │ QUICKSTART (Part 3) │   │ CONTRIBUTING.md     │
│ WEB_AGENTS_API.md   │   │ AUTHORING_GUIDE.md  │   │ ARCHITECTURE.md     │
│ JS_AI_PROVIDER_API  │   │ templates/          │   │ MCP_HOST.md         │
└─────────────────────┘   └─────────────────────┘   └─────────────────────┘

---

Quick Links by Task

Task	Document
Install Harbor	User Guide
Set up Ollama	User Guide
Request permissions	Web Agents API
Create a chat session	Web Agents API
Call MCP tools	Web Agents API
Run autonomous agents	Web Agents API
Understand feature flags	Web Agents API
Test your app (mock + E2E)	Testing your app
Create a JS MCP server	Quickstart Part 3
Create a WASM MCP server	MCP Authoring Guide
Add OAuth to MCP server	OAuth Guide
Set up OAuth credentials	OAuth Guide
Read the permission model	Explainer
Build from source	Contributing