Skip to main content

JupyMCP

JupyMCP is a local-first Model Context Protocol server for editing and executing Jupyter notebooks. It starts and manages kernels itself, so a separate Jupyter Server, URL, or token is not required.

Quick start

Configure an MCP client to launch JupyMCP over stdio:

{
  "mcpServers": {
    "jupymcp": {
      "command": "uvx",
      "args": ["jupymcp", "--workspace-root", "/path/to/project"]
    }
  }
}

All notebook paths passed to tools are relative to --workspace-root, which defaults to the process working directory. Absolute paths and paths that escape this root are rejected.

Tools

Area Tool Purpose
Kernel start_kernel Start a kernel, optionally selecting a kernelspec.
Kernel restart_kernel Restart a managed kernel.
Kernel shutdown_kernel Shut down a kernel and release bound clients.
Kernel shutdown_all Shut down every managed kernel.
Kernel interrupt_kernel Interrupt a running kernel.
Session get_notebook_session Return the kernel bound to one notebook.
Session interrupt_notebook_session Interrupt one notebook's kernel.
Session restart_notebook_session Restart one notebook's kernel.
Session shutdown_notebook_session Release one notebook and stop its unshared kernel.
Notebook create_notebook Create a notebook with the requested kernelspec.
Notebook read_notebook Read a validated notebook as structured data.
Notebook get_notebook_revision Return the SHA-256 revision used for optimistic writes.
Execution execute Execute code in a notebook-scoped kernel and optionally persist a new cell.
Execution execute_cell Execute an existing code cell and replace its saved outputs.
Cell append_cell Append a code, Markdown, or raw cell.
Cell insert_cell Insert a cell at a specific index.
Cell read_cell Read one cell by stable ID or index.
Cell update_cell Replace cell source and/or metadata without changing its ID.
Cell delete_cell Delete one cell.
Cell move_cell Move one cell to a new index.
Cell clear_cell_outputs Clear outputs and execution count from a code cell.
Metadata get_notebook_metadata Read notebook metadata.
Metadata set_notebook_metadata Replace notebook metadata.
Metadata get_cell_metadata Read cell metadata.
Metadata set_cell_metadata Replace cell metadata.

Cell operations that target an existing cell require exactly one of cell_id or index. IDs remain stable across source edits, metadata changes, moves, and execution.

Mutation tools accept an optional expected_revision. Obtain it with get_notebook_revision; if the file changes before the atomic replace, the mutation fails with a revision conflict instead of overwriting the newer file. execute_cell always applies this check internally across the execution window. JSON-lines open responses include revision, which clients should return in save.params.revision.

execute(type="py:percent") persists cells as a Jupytext percent script with # %% markers. The script format stores source and metadata, but not rich execution outputs.

Resources

URI Content
jupyter://kernelspecs Available kernel names.
jupyter://kernels Running kernel IDs.
notebook://{path} Validated notebook JSON for a relative workspace path.

Transports

Mode Command Status
stdio jupymcp Default and recommended for local MCP clients.
sse jupymcp --transport sse Experimental local HTTP transport.
streamable-http jupymcp --transport streamable-http Experimental local HTTP transport.
json-lines jupymcp --json-lines Trusted local desktop protocol on stdin/stdout.

Execution is bounded by server-wide defaults: 120 seconds per call (maximum requested timeout 3600 seconds), 1 MiB or 128 captured output blocks, 8 managed kernels, and 15 minutes of notebook-session idle time. Configure these with --default-timeout, --max-timeout, --max-output-bytes, --max-output-blocks, --max-kernels, and --idle-timeout. Output overflow is persisted and returned with an explicit truncation marker; increase limits deliberately for unusually large results.

HTTP transports bind only to 127.0.0.1 and enable Host/Origin validation plus DNS-rebinding protection. They do not yet provide user authentication, so do not expose them through a reverse proxy or public network.

Security model

JupyMCP deliberately provides arbitrary code execution through Jupyter kernels. Run it only for trusted MCP clients and use a dedicated --workspace-root. The workspace boundary limits notebook file access; it is not a process sandbox, and executed code retains the permissions of the JupyMCP process.

Notebook sessions get separate kernels by default. Repeated execution in the same notebook preserves state, while different notebooks do not share variables unless the caller explicitly supplies the same kernel_id.

When neither kernel_id nor kernel_name is supplied, JupyMCP uses the existing notebook's metadata.kernelspec.name before falling back to the system default. Notebook-session controls affect only the normalized notebook path; a deliberately shared kernel remains alive until its final notebook binding is released.

Local Jupyter kernel messaging can use unencrypted loopback TCP depending on the installed kernelspec and jupyter_client configuration. Do not expose kernel connection files or ports to untrusted users.

Development

uv sync --dev
uv run pytest --cov=src/jupymcp
uv run ruff check .
uv run ruff format --check .
uv build

Generated notebook schema models live in src/jupymcp/model.py; regenerate them with uv run python scripts/generate-model.py instead of editing that file manually.

Alternatives

JupyMCP focuses on a lightweight local workflow that does not require an already-running Jupyter Server.

Download files

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

Source Distribution

jupymcp-0.3.1.tar.gz (19.6 kB view details)

Uploaded Source

Built Distribution

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

jupymcp-0.3.1-py3-none-any.whl (22.6 kB view details)

Uploaded Python 3

File details

Details for the file jupymcp-0.3.1.tar.gz.

File metadata

  • Download URL: jupymcp-0.3.1.tar.gz
  • Upload date:
  • Size: 19.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.21 {"installer":{"name":"uv","version":"0.11.21","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for jupymcp-0.3.1.tar.gz
Algorithm Hash digest
SHA256 95a16e4a93b516bdd065d1a9dbd4440faf05be6f6bcd6479c557da66d6f1d081
MD5 ed14367ed004c0f88b191d58464ad562
BLAKE2b-256 77dbfc6cf77de283203c96e22654b6b5c8d6564a967d0c931afb2af67a22d821

See more details on using hashes here.

File details

Details for the file jupymcp-0.3.1-py3-none-any.whl.

File metadata

  • Download URL: jupymcp-0.3.1-py3-none-any.whl
  • Upload date:
  • Size: 22.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.21 {"installer":{"name":"uv","version":"0.11.21","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for jupymcp-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 9f12ff90f58cb380146903a98b45e09b9f92babc19c63843fe620d57cbc3bf13
MD5 ae2bdfd33f8efee552f52c52a595887e
BLAKE2b-256 46246d648bfe5deea6c93019a0066e4390866c246e31fdfc7f4845b32b8a77cc

See more details on using hashes here.

Release history Release notifications | RSS feed

0.3.2

2 files

This release

0.3.1 This release

2 files

0.3.0

2 files

0.2.0

2 files

0.1.1

2 files

0.1.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page