# Harbor | Documentation

> Harbor is a shared workspace for AI agents. Connect a service once (Linear, GitHub, Sentry, Notion, your database…) and any agent on your team can use its tools — with credentials staying in Harbor, every call traced, and reusable building blocks captured as Skills, Functions, and Apps.

## Instructions for AI Agents

- For the canonical agent skill (start here), read `https://docs.tryharbor.ai/.well-known/agent-skills/harbor/SKILL.md`
- For topic-specific agent skills, see the **Agent skills** section below
- For the complete documentation index, this file: `https://docs.tryharbor.ai/llms.txt`
- For full documentation content in one file, see `https://docs.tryharbor.ai/llms-full.txt`
- To use Harbor as an MCP server in your agent host (Claude, Cursor, Codex, Gemini, mcporter):
  - Production:  `https://mcp.tryharbor.ai/mcp`
  - The server exposes only two tools: `inspect` and `exec`
  - See `https://docs.tryharbor.ai/documentation/for-agents/connecting` for per-client setup
- To install the Harbor CLI locally: `npm i -g @zonko-ai/harbor` then `hrbr login`

## Agent Skills

Canonical, machine-readable skills served as plain markdown:

- [Harbor meta skill (start here)](https://docs.tryharbor.ai/.well-known/agent-skills/harbor/SKILL.md): Entry point. Routes to a topic skill based on the user's intent.
- [Plugins](https://docs.tryharbor.ai/.well-known/agent-skills/harbor/harbor-plugins.md): Plugins, sources, tools, the state machine, and tool search.
- [Exec](https://docs.tryharbor.ai/.well-known/agent-skills/harbor/harbor-exec.md): When to use `hrbr exec` for one-off TypeScript.
- [Workflows](https://docs.tryharbor.ai/.well-known/agent-skills/harbor/harbor-workflows.md): Durable lane: `step.do`, `step.sleep`, `step.waitForEvent`.
- [Functions (Jobs)](https://docs.tryharbor.ai/.well-known/agent-skills/harbor/harbor-jobs.md): When to publish a reusable named Function.
- [Apps](https://docs.tryharbor.ai/.well-known/agent-skills/harbor/harbor-apps.md): When to publish a Function as a routable URL.
- [Orbit runtime](https://docs.tryharbor.ai/.well-known/agent-skills/harbor/harbor-orbit.md): Workspace primitives: storage / cache / db / ai / tools / socket.
- [App UI](https://docs.tryharbor.ai/.well-known/agent-skills/harbor/harbor-app-ui.md): Server-rendered HTML primitives for Apps and Jobs.
- [Sand (local CLI bridge)](https://docs.tryharbor.ai/.well-known/agent-skills/harbor/harbor-sand.md): Bridge a local CLI (git, gh, wrangler…) from a remote run.
- [Workflow authoring](https://docs.tryharbor.ai/.well-known/agent-skills/harbor/harbor-workflow-authoring.md): How to author a workflow-backed skill.

## Documentation

- [For Agents — Overview](https://docs.tryharbor.ai/documentation/for-agents/overview): How AI agents consume Harbor docs.
- [Welcome to Harbor](https://docs.tryharbor.ai/documentation/overview): Shared workspace to make AI agents faster, deterministic, and token-efficient.
- [Apps (Beta)](https://docs.tryharbor.ai/documentation/concepts/apps): Harbor Functions exposed through workspace-aware URLs.
- [Exec](https://docs.tryharbor.ai/documentation/concepts/exec): One-off TypeScript execution against your workspace tools.
- [Functions (Beta)](https://docs.tryharbor.ai/documentation/concepts/functions): Named, versioned TypeScript published from the Harbor inspect runtime.
- [Orbit Runtime (Beta)](https://docs.tryharbor.ai/documentation/concepts/orbit-runtime): Workspace primitives: storage, cache, db, AI, tool discovery, sockets.
- [Plugins](https://docs.tryharbor.ai/documentation/concepts/plugins): Connected services Harbor knows how to inspect and execute.
- [Runs & Traces](https://docs.tryharbor.ai/documentation/concepts/runs-and-traces): Every Harbor execution leaves a durable trace.
- [Skills](https://docs.tryharbor.ai/documentation/concepts/skills): Agent-readable markdown grounded in Harbor inspect output.
- [Workspaces](https://docs.tryharbor.ai/documentation/concepts/workspaces): Workspace-scoped Harbor state, membership, sources, and runtime execution.
- [Agent Skills — /.well-known](https://docs.tryharbor.ai/documentation/for-agents/agent-skills): Canonical Harbor agent skills served from /.well-known/agent-skills/harbor/.
- [Connecting Agents](https://docs.tryharbor.ai/documentation/for-agents/connecting): Point Claude Code, Cursor, Codex, Gemini CLI, or any MCP client at Harbor.
- [/llms.txt — Page Index](https://docs.tryharbor.ai/documentation/for-agents/llms-txt): llmstxt.org-style enumeration of every page on this docs site.
- [Mental Model](https://docs.tryharbor.ai/documentation/mental-model): Plugin → Tool → Run → Trace, defined once.
- [Quickstart](https://docs.tryharbor.ai/documentation/quickstart): From signup to first real Harbor exec in under five minutes.
- [Glossary](https://docs.tryharbor.ai/documentation/reference/glossary): Every Harbor term, defined once.
- [Limits](https://docs.tryharbor.ai/documentation/reference/limits): Plan-level and technical limits across the Harbor surface.
- [Security Model](https://docs.tryharbor.ai/documentation/reference/security): Credential vault, sandbox isolation, OAuth trust boundaries.
- [Why Harbor](https://docs.tryharbor.ai/documentation/why-harbor): Models change. The context layer should not.

## Guides

- [Guides](https://docs.tryharbor.ai/guides/overview): Task-oriented walkthroughs. One outcome per page.
- [App UI (Beta)](https://docs.tryharbor.ai/guides/authoring/app-ui): /sdk/orbit templates and primitives — server-rendered HTML without React. (Beta)
- [Apps (Beta)](https://docs.tryharbor.ai/guides/authoring/apps): Author Harbor Apps with deployApp, route handlers, and inspect.
- [Custom MCP plugin](https://docs.tryharbor.ai/guides/authoring/custom-mcp-plugin): Bring your own MCP server and discover its tools through Harbor.
- [Functions (Beta)](https://docs.tryharbor.ai/guides/authoring/functions): Author reusable Harbor Functions with defineJob, inspect, and exec.
- [Local CLI Bridge (Sand)](https://docs.tryharbor.ai/guides/authoring/sand-cli-bridge): Bridge selected local CLIs from a Harbor exec run when Sand support is configured.
- [Skills — Wiring tool calls](https://docs.tryharbor.ai/guides/authoring/skills-frontmatter-and-tool-calls): Bind the workflow steps to exact plugin tools, with argument templating.
- [Skills template anatomy](https://docs.tryharbor.ai/guides/authoring/skills-template-anatomy): The markdown fields a Harbor-oriented Skill should include.
- [Skills validation and publish](https://docs.tryharbor.ai/guides/authoring/skills-validation-and-publish): Validate Harbor Skill markdown against real inspect output, then share through dashboard or repo workflows.
- [Skills — When to write one](https://docs.tryharbor.ai/guides/authoring/skills-when-to-write): Decide between a Skill, a Function, an App, or just exec.
- [Connect Claude Code](https://docs.tryharbor.ai/guides/get-started/connect-claude-code): Point Claude Desktop at Harbor's MCP server.
- [Connect Codex](https://docs.tryharbor.ai/guides/get-started/connect-codex): Point Codex CLI at Harbor's MCP server.
- [Connect Cursor](https://docs.tryharbor.ai/guides/get-started/connect-cursor): Point Cursor at Harbor's MCP server.
- [Connect Gemini CLI](https://docs.tryharbor.ai/guides/get-started/connect-gemini-cli): Point Gemini CLI at Harbor's MCP server.
- [Install your first plugin](https://docs.tryharbor.ai/guides/get-started/install-your-first-plugin): Connect a service, inspect readiness, and run your first tool with real CLI commands.
- [Sign up and install hrbr](https://docs.tryharbor.ai/guides/get-started/sign-up-and-install-cli): Install the real Harbor CLI and authenticate through inspect.
- [Your first App (Beta)](https://docs.tryharbor.ai/guides/get-started/your-first-app): Publish a small Harbor App with deployApp and open it through inspect.
- [Your first exec](https://docs.tryharbor.ai/guides/get-started/your-first-exec): Write multi-step TypeScript that calls real plugin tools.
- [Your first Function (Beta)](https://docs.tryharbor.ai/guides/get-started/your-first-function): Promote a working exec snippet into a reusable Harbor Function with defineJob.
- [Your first Skill](https://docs.tryharbor.ai/guides/get-started/your-first-skill): Author agent-readable instructions for Harbor workflows without fake CLI commands.
- [Disable vs Delete](https://docs.tryharbor.ai/guides/operations/disable-vs-delete): When to disable a Function / App / Skill / Plugin, and when to actually delete.
- [Observability](https://docs.tryharbor.ai/guides/operations/observability): Find runs and drill into traces with real CLI and dashboard surfaces.
- [Sharing across team](https://docs.tryharbor.ai/guides/operations/sharing-across-team): Share Functions, Apps, Skills, and plugin access without fake CLI commands.
- [Versioning & Pinning](https://docs.tryharbor.ai/guides/operations/versioning-and-pinning): How Function and App versions work with the current inspect runtime.
- [Daily Digest](https://docs.tryharbor.ai/guides/recipes/daily-digest): Scheduled Function posts a daily roll-up of your workspace activity to Slack.
- [HTML report from Orbit](https://docs.tryharbor.ai/guides/recipes/html-report-from-orbit): Generate a styled HTML report and serve it from a signed Orbit storage URL. (Beta)
- [Incident Triage](https://docs.tryharbor.ai/guides/recipes/incident-triage): Sentry → GitHub → Linear → Slack. End-to-end working example.
- [Multi-step with retries](https://docs.tryharbor.ai/guides/recipes/multi-step-with-retries): step.do + step.sleep for durable, retryable, time-paced pipelines. (Beta)
- [OAuth Approval Workflow](https://docs.tryharbor.ai/guides/recipes/oauth-approval-workflow): step.waitForEvent — park a run until an approver clicks a button. (Beta)
- [PR Review Bot](https://docs.tryharbor.ai/guides/recipes/pr-review-bot): Always-on PR reviewer. Listens to GitHub events, summarises diff, posts inline comments.
- [Public Intake Form](https://docs.tryharbor.ai/guides/recipes/public-intake-form): Public feedback form that drops submissions into Linear. (Beta)
- [Release Notes](https://docs.tryharbor.ai/guides/recipes/release-notes): Weekly release notes auto-generated from GitHub commits.

## Plugins

- [Plugins](https://docs.tryharbor.ai/plugins/overview): Connected services Harbor can inspect and execute through real CLI and SDK surfaces.
- [Catalog](https://docs.tryharbor.ai/plugins/catalog): Browse every Harbor plugin. Filter by kind, category, or search.

## Endpoints

- Production MCP server: `https://mcp.tryharbor.ai/mcp` (OAuth 2.1 + PKCE)
- This docs index:        `https://docs.tryharbor.ai/llms.txt`
- Full docs in one file:  `https://docs.tryharbor.ai/llms-full.txt`
- Canonical agent skill:  `https://docs.tryharbor.ai/.well-known/agent-skills/harbor/SKILL.md`
- Plugin catalog (web):   `https://docs.tryharbor.ai/plugins/catalog`