Skip to main content

Bring AI to Jupyter notebooks. MCP server for Claude, ChatGPT, Gemini, OpenCode and any agent.

Project description

nteract/nteract

What's going on?

If you're here looking for the Electron-based nteract desktop app, you can view the source in this repo. That desktop app is not actively maintained.

We're actively developing the spiritual successor to the nteract desktop app in the nteract/desktop repo.

The New Desktop App

We're actively developing the spiritual successor to the nteract desktop app in the nteract/desktop repo.

The new app is a native desktop app with instant startup and intelligent environment management.

Screenshot 2025-02-27 at 8 33 13 AM

Bringing Agents in the Loop

We're in the preliminary stages of hooking up the realtime system from nteract/desktop to any agent of your choice. Collaborate with agents in notebooks, render interactive elements, and explore data together.

Quick Start

Claude Code

# Stable desktop 1.4.x / stable MCP
claude mcp add nteract -- uvx nteract

For desktop nightly / the upcoming 2.x transition, use the prerelease MCP package and nightly socket:

claude mcp add nteract-nightly -- env RUNTIMED_SOCKET_PATH="$HOME/Library/Caches/runt-nightly/runtimed.sock" uvx --prerelease allow nteract

That's it. Now Claude can execute Python code, create visualizations, and work with your data.

What is this?

nteract is an MCP (Model Context Protocol) server that connects AI assistants like Claude to Jupyter notebooks. It enables:

  • Code execution: Run Python in a persistent kernel
  • Real-time collaboration: Watch the AI work in the nteract desktop app
  • Shared state: Multiple agents can work on the same notebook
  • Environment management: Automatic Python environment setup

Example

Ask Claude:

"Help me visualize my log data"

Claude will:

  1. Connect to a notebook session
  2. Write and execute code
  3. Generate visualizations
  4. Show you the results

You can open the same notebook in the nteract desktop app to see changes in real-time and collaborate with the AI.

Installation

Stable line for desktop 1.4.x:

uvx nteract

Prerelease line for desktop nightly / 2.x transition:

uvx --prerelease allow nteract

Claude Code Setup

Add stable nteract as an MCP server:

claude mcp add nteract -- uvx nteract

Or manually add to your Claude configuration:

{
  "mcpServers": {
    "nteract": {
      "command": "uvx",
      "args": ["nteract"]
    }
  }
}

Using with Nightly

If you're using nteract desktop nightly builds, point at the nightly socket and allow prereleases:

claude mcp add nteract -- env RUNTIMED_SOCKET_PATH="$HOME/Library/Caches/runt-nightly/runtimed.sock" uvx --prerelease allow nteract

Release Tracks

  • main publishes prerelease nteract builds for the 2.x transition and tracks runtimed 2.x prereleases.
  • release/1.9.x is the stable maintenance line for desktop 1.4.x and stays on runtimed 1.9.0.

Available Tools

Tool Description
list_active_notebooks List all open notebook sessions
join_notebook Join an existing notebook session by ID
open_notebook Open an existing .ipynb file
create_notebook Create a new notebook
save_notebook Save notebook to disk as .ipynb file
create_cell Add a cell to the notebook (use and_run=True to execute)
execute_cell Run a specific cell (returns partial results after timeout)
run_all_cells Queue all code cells for execution
set_cell Update a cell's source and/or type
get_cell Get a cell by ID with outputs
get_all_cells View all cells in the notebook
replace_match Targeted literal text find-and-replace in a cell
replace_regex Regex-based find-and-replace in a cell
move_cell Reorder a cell within the notebook
clear_outputs Clear a cell's outputs
delete_cell Remove a cell from the notebook
interrupt_kernel Interrupt the currently executing cell
restart_kernel Restart kernel with updated dependencies
show_notebook Open the notebook in the nteract desktop app (disabled with --no-show)
add_dependency Add a Python package dependency
remove_dependency Remove a dependency
get_dependencies List current dependencies
sync_environment Hot-install new deps without restart

Architecture

┌─────────────┐     ┌─────────────┐     ┌─────────────┐
│   Claude    │────▶│   nteract   │────▶│   runtimed  │
│  (or other  │     │ MCP Server  │     │   daemon    │
│     AI)     │     │             │     │             │
└─────────────┘     └─────────────┘     └──────┬──────┘
                                               │
                    ┌─────────────┐             │
                    │   nteract   │◀────────────┘
                    │ Desktop App │  (real-time sync)
                    └─────────────┘
  • nteract (this package): MCP server for AI assistants
  • runtimed: Low-level daemon and Python bindings (docs)
  • nteract desktop: Native app for humans to collaborate with AI

Real-time Collaboration

The magic of nteract is that AI and humans share the same notebook:

  1. AI connects via MCP and runs code
  2. Human opens the same notebook in nteract desktop
  3. Changes sync instantly via CRDT
  4. Both see the same kernel state

This enables workflows like:

  • AI does initial analysis, human refines
  • Human writes code, AI debugs errors
  • Multiple AI agents collaborate on complex tasks

Development

# Clone
git clone https://github.com/nteract/desktop
cd desktop/python/nteract

# Install dependencies
uv sync

# Run tests
uv run pytest

Related Projects

License

BSD-3-Clause

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nteract-2.0.3a202603230920.tar.gz (78.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

nteract-2.0.3a202603230920-py3-none-any.whl (18.9 kB view details)

Uploaded Python 3

File details

Details for the file nteract-2.0.3a202603230920.tar.gz.

File metadata

  • Download URL: nteract-2.0.3a202603230920.tar.gz
  • Upload date:
  • Size: 78.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.10.12 {"installer":{"name":"uv","version":"0.10.12","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for nteract-2.0.3a202603230920.tar.gz
Algorithm Hash digest
SHA256 68e148b754de708f77c6e1afa50f41095979798294dd8484096d3f39b05a320f
MD5 0722b8f1d07c2a0219766982ab4db66f
BLAKE2b-256 814aac30b089cc5a3215b9f800e24a77650b0119a6eae33b15ea94152428c1c5

See more details on using hashes here.

File details

Details for the file nteract-2.0.3a202603230920-py3-none-any.whl.

File metadata

  • Download URL: nteract-2.0.3a202603230920-py3-none-any.whl
  • Upload date:
  • Size: 18.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.10.12 {"installer":{"name":"uv","version":"0.10.12","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for nteract-2.0.3a202603230920-py3-none-any.whl
Algorithm Hash digest
SHA256 d2db9610497869689325e400257d747f9d920e939efc849d681713cac90d29fd
MD5 91de071cc92e8c765c07129856d071db
BLAKE2b-256 430ceea671cacca81044222919643e6d998214a9f739cd2fbece807b2e01e125

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page