Skip to main content

MCP server for Jupyter notebooks

Project description

mcp-server-jupyter

An MCP server for managing and interacting with Jupyter notebooks programmatically.

Demo

Components

Tools

The server provides five tools for notebook manipulation:

  1. read_notebook_with_outputs: Read a notebook's content including cell outputs

    • Required: notebook_path (string)
  2. read_notebook_source_only: Read notebook content without outputs

    • Required: notebook_path (string)
    • Use when size limitations prevent reading full notebook with outputs
  3. read_output_of_cell: Read output of a specific cell

    • Required:
      • notebook_path (string)
      • cell_id (string)
  4. add_cell: Add new cell to notebook

    • Required:
      • notebook_path (string)
      • source (string)
    • Optional:
      • cell_type (string): "code" or "markdown"
      • position (integer): insertion index (-1 to append)
  5. edit_cell: Modify existing cell content

    • Required:
      • notebook_path (string)
      • cell_id (string)
      • source (string)

Usage with Claude Desktop

Add this configuration to your Claude Desktop config file:

MacOS

// ~/Library/Application Support/Claude/claude_desktop_config.json
{
  "mcpServers": {
    "Jupyter-notebook-manager": {
      "command": "uv",
      "args": [
        "run",
        "--directory",
        "/path/to/mcp-server-jupyter/src/mcp_server_jupyter",
        "mcp-server-jupyter"
      ],
      "env": {
        "UV_PROJECT_ENVIRONMENT": "/path/to/venv_for_jupyter/.venv"
      }
    }
  }
}

How to Use

  1. Start JupyterLab or Jupyter Notebook

When using uv to run Jupyter notebooks it's much easier to manage venv and package installations.

Please follow uv jupyter docummentation for more details.

uv venv --seed
uv run --with jupyter jupyter lab

NOTE: this environment should be used as UV_PROJECT_ENVIRONMENT env variable in MCP server.

  1. Open or create a notebook in JupyterLab/Jupyter Notebook

  2. Get the full path to your notebook:

    • In JupyterLab: Right-click on the notebook in the file browser → "Copy Path"
    • In Jupyter Notebook: Copy the path from the URL (modify to full system path)
  3. In Claude Desktop chat:

    • Always use the full path to the notebook when calling tools
    • Example: /Users/username/projects/my_notebook.ipynb
  4. Important Notes:

    • After any modifications through Claude (add_cell, edit_cell):
      • Reload the notebook page in JupyterLab/Jupyter Notebook
      • Current version does not support automatic reload
    • Keep JupyterLab/Jupyter Notebook instance running while working with Claude

License

This project is licensed under the MIT License. See the LICENSE file for details.

Project details


Download files

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

Source Distribution

mcp_server_jupyter-0.1.1.tar.gz (25.8 MB view details)

Uploaded Source

Built Distribution

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

mcp_server_jupyter-0.1.1-py3-none-any.whl (8.6 kB view details)

Uploaded Python 3

File details

Details for the file mcp_server_jupyter-0.1.1.tar.gz.

File metadata

  • Download URL: mcp_server_jupyter-0.1.1.tar.gz
  • Upload date:
  • Size: 25.8 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for mcp_server_jupyter-0.1.1.tar.gz
Algorithm Hash digest
SHA256 1748903fb9534a63bffc212df2216267dc0ca0dd65259b98fbb3bb08415f7bd2
MD5 99018956db51a41cbbea4d52c78d185f
BLAKE2b-256 53a21b68e8f66abd79dc6e08b0f297872c6923a3e2b38441ab36fb2d0fc72550

See more details on using hashes here.

Provenance

The following attestation bundles were made for mcp_server_jupyter-0.1.1.tar.gz:

Publisher: main.yml on ihrpr/mcp-server-jupyter

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file mcp_server_jupyter-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for mcp_server_jupyter-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f8e6b89867adf2ca8ab1c52b32783fa1aaa7ff33fe79bd8c7f7cc76c118121fc
MD5 b95fc5ac1660ef7d4e08115c3c94423a
BLAKE2b-256 4e4fb5fc74a191f09ab26340a73fe8ead0cf8105790d5c5539255f99b831ab1a

See more details on using hashes here.

Provenance

The following attestation bundles were made for mcp_server_jupyter-0.1.1-py3-none-any.whl:

Publisher: main.yml on ihrpr/mcp-server-jupyter

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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