nebula-notebook 0.1.0 → 0.1.1

package/README.md

@@ -1,9 +1,31 @@
 # Nebula Notebook
 
-Nebula is an AI-native notebook computing environment built for what's coming next. It also comes with an optimized user experience even if you use no AI features at all.
+Nebula is an agent-native notebook computing environment built for what's coming next: real Jupyter kernels, real filesystem access, and a notebook that agents (Claude Code, Codex, …) can drive end-to-end through MCP — while staying a fast, polished notebook even if you never touch the AI features.
+
+![Nebula Notebook — agents drive the notebook via MCP](https://raw.githubusercontent.com/jzthree/nebula-notebook/main/docs/assets/nebula-hero.svg)
 
 ## Quick Start
 
+```bash
+npx nebula-notebook
+```
+
+On first start, a QR code will appear in the terminal. Scan it with an authenticator app (Google Authenticator, Authy, etc.) to set up 2FA.
+
+Open http://localhost:3000 and enter your 6-digit code.
+
+To let agents (Claude Code, Codex, Cursor, Gemini CLI, …) drive your notebooks, register the Nebula MCP on the machine where your agent runs:
+
+```bash
+npx nebula-notebook-mcp setup-mcp
+```
+
+Then open a notebook, click **Agent**, and launch Claude Code or Codex right in the notebook's terminal.
+
+### From source (latest)
+
+npm releases are point-in-time snapshots — to get the latest changes, install from source:
+
 ```bash
 git clone https://github.com/jzthree/nebula-notebook.git
 cd nebula-notebook
@@ -12,10 +34,6 @@ npm install
 npm run start
 ```
 
-On first start, a QR code will appear in the terminal. Scan it with an authenticator app (Google Authenticator, Authy, etc.) to set up 2FA.
-
-Open http://localhost:3000 and enter your 6-digit code.
-
 ## Root Directory
 
 Set the server root directory (default is your home directory):
@@ -39,10 +57,11 @@ This root is used for the file browser and terminals. You can also change it fro
 - Search & replace across all cells (Cmd/Ctrl+F)
 - Keyboard shortcuts (Shift+Enter to run, Cmd+S to save, etc.)
 
-**AI Assistant**
-- Multi-provider support: Gemini, OpenAI, Anthropic
-- Code generation and error fixing
-- Context-aware suggestions
+**Agents**
+- Agent terminal built into every notebook — one click launches Claude Code or Codex, pre-briefed with the server URL and notebook path
+- "Fix with agent" on any failing cell, and per-cell prompts, injected straight into the agent's terminal
+- Full MCP toolset ([`nebula-notebook-mcp`](https://www.npmjs.com/package/nebula-notebook-mcp)): read/edit/execute cells, manage kernels and files — from any agent on any machine
+- Agent sessions lock the notebook during edits and sync live into the UI
 
 **Editor**
 - Syntax highlighting with CodeMirror
@@ -93,19 +112,21 @@ nebula-notebook/
 
 ## MCP Adapter
 
-The MCP adapter now lives in this repository under `packages/mcp`. It remains a
-separate Node package so it can be installed on a local agent/client machine even
-when the Nebula Notebook server is running elsewhere.
+The MCP adapter is published as [`nebula-notebook-mcp`](https://www.npmjs.com/package/nebula-notebook-mcp)
+and lives in this repository under `packages/mcp`. It is a separate package so it
+can be installed on a local agent/client machine even when the Nebula Notebook
+server is running elsewhere.
 
 ```bash
-# From this repo: build or run the MCP server
+# Register the MCP with your installed agent CLIs (Claude Code, Codex, …)
+npx nebula-notebook-mcp setup-mcp
+
+# Agents must call connect_server(base_url) once per session —
+# the base_url is the URL you open Nebula at, e.g. http://localhost:3000
+
+# From a repo checkout instead: build or run the MCP server
 npm run mcp:build
 npm run mcp
-
-# Client-only install from source
-cd packages/mcp
-npm install
-npm run build
 ```
 
 ## Authentication
@@ -213,9 +234,9 @@ Terminals persist as long as the server runs. Bookmark different terminals for q
 ## Tech Stack
 
 - **Frontend**: React 19, TypeScript, Vite, Tailwind CSS, CodeMirror
-- **Backend**: Node.js, Express, ZeroMQ (Jupyter kernel protocol)
+- **Backend**: Node.js, Fastify, ZeroMQ (Jupyter kernel protocol)
 - **Auth**: TOTP (otplib), JWT (jsonwebtoken)
-- **AI**: OpenAI, Anthropic, Google GenAI SDKs
+- **Agents**: MCP (`nebula-notebook-mcp`) driven by Claude Code, Codex, and other agent CLIs
 
 ## License