jupyter-mcp-server
by: datalayer
🪐 ✨ Jupyter Model Context Protocol (MCP) Server.
📌Overview
Purpose: To provide an implementation of the Model Context Protocol (MCP) for interaction with Jupyter notebooks running locally in JupyterLab.
Overview: Jupyter MCP Server enables seamless real-time collaboration within JupyterLab, facilitating the execution and management of code and markdown cells in a user-friendly manner. It is designed to work efficiently with Docker and offers a set of tools tailored for notebook enhancements.
Key Features:
-
Add and Execute Code Cell: This feature allows users to insert and execute code cells in Jupyter notebooks, returning the output of the execution, enhancing interactivity and code testing.
-
Add Markdown Cell: Users can create and add markdown cells for documentation purposes within their notebooks, improving readability and content organization.
-
Download Earth Data Granules: This specialized tool supports geospatial analysis by enabling users to download datasets from NASA Earth Data directly into their notebooks, aiding scientific research and analysis. (This tool is planned to be moved to a separate repository in the future.)
🪐 ✨ Jupyter MCP Server
Jupyter MCP Server is a Model Context Protocol (MCP) server implementation that provides interaction with Jupyter notebooks running in any JupyterLab (including your local JupyterLab).
Start JupyterLab
Make sure you have the following installed. The collaboration package is needed as the modifications made on the notebook can be seen thanks to Jupyter Real Time Collaboration.
pip install jupyterlab jupyter-collaboration ipykernel
pip uninstall -y pycrdt datalayer_pycrdt
pip install datalayer_pycrdt
Then, start JupyterLab with the following command.
jupyter lab --port 8888 --IdentityProvider.token MY_TOKEN --ip 0.0.0.0
You can also run make jupyterlab
.
The
--ip
is set to0.0.0.0
to allow the MCP server running in a Docker container to access your local JupyterLab.
Use with Claude Desktop
Claude Desktop can be downloaded from this page for macOS and Windows: https://claude.ai/download
For Linux, there is an unofficial build script based on nix:
# ⚠️ UNOFFICIAL
# You can also run `make claude-linux`
NIXPKGS_ALLOW_UNFREE=1 nix run github:k3d3/claude-desktop-linux-flake \
--impure \
--extra-experimental-features flakes \
--extra-experimental-features nix-command
To use this with Claude Desktop, add the following to your claude_desktop_config.json
.
Ensure the port of the
SERVER_URL
andTOKEN
match those used in thejupyter lab
command.
TheNOTEBOOK_PATH
should be relative to the directory where JupyterLab was started.
Claude Configuration on macOS and Windows
{
"mcpServers": {
"jupyter": {
"command": "docker",
"args": [
"run",
"-i",
"--rm",
"-e",
"SERVER_URL",
"-e",
"TOKEN",
"-e",
"NOTEBOOK_PATH",
"datalayer/jupyter-mcp-server:latest"
],
"env": {
"SERVER_URL": "http://host.docker.internal:8888",
"TOKEN": "MY_TOKEN",
"NOTEBOOK_PATH": "notebook.ipynb"
}
}
}
}
Claude Configuration on Linux
CLAUDE_CONFIG=${HOME}/.config/Claude/claude_desktop_config.json
cat <<EOF > $CLAUDE_CONFIG
{
"mcpServers": {
"jupyter": {
"command": "docker",
"args": [
"run",
"-i",
"--rm",
"-e",
"SERVER_URL",
"-e",
"TOKEN",
"-e",
"NOTEBOOK_PATH",
"--network=host",
"datalayer/jupyter-mcp-server:latest"
],
"env": {
"SERVER_URL": "http://localhost:8888",
"TOKEN": "MY_TOKEN",
"NOTEBOOK_PATH": "notebook.ipynb"
}
}
}
}
EOF
cat $CLAUDE_CONFIG
Components
Tools
The server currently offers 2 tools:
add_execute_code_cell
- Add and execute a code cell in a Jupyter notebook.
- Input:
cell_content
(string): Code to be executed.
- Returns: Cell output.
add_markdown_cell
- Add a markdown cell in a Jupyter notebook.
- Input:
cell_content
(string): Markdown content.
- Returns: Success message.
Building
You can build the Docker image from source.
make build-docker
Installing via Smithery
To install Jupyter MCP Server for Claude Desktop automatically via Smithery:
npx -y @smithery/cli install @datalayer/jupyter-mcp-server --client claude