Skip to main content

A JupyterLab extension to manage MCP servers.

Project description

jupyter_mcp_manager

Github Actions Status

A JupyterLab extension for managing Model Context Protocol (MCP) servers.

This extension provides a user interface and backend infrastructure to configure and manage MCP servers directly within JupyterLab. It allows you to define which MCP servers are available for use by other JupyterLab extensions or AI assistants.

What is MCP?

The Model Context Protocol (MCP) is an open standard that enables AI assistants and other clients to interact with various data sources, tools, and services through a unified interface. MCP servers expose resources, tools, and prompts that AI models can query and use during conversations.

This extension manages the MCP server configurations that other JupyterLab extensions (like jupyter_server_mcp) or external clients can use to connect to and interact with MCP servers.

Features

  • Configuration Management: Add, edit, and remove MCP server configurations through a dedicated settings panel in JupyterLab
  • Multiple Server Types: Support for both stdio (local executable) and HTTP (remote endpoint) MCP servers
  • Flexible Configuration: Configure servers via:
    • JupyterLab Settings UI (persisted in browser)
    • JSON configuration files in Jupyter config directories (~/.jupyter/mcp_servers.json)
    • adding MCP servers in the manager server side (for extensions)
  • Environment Variables & Headers: Set custom environment variables for stdio servers and HTTP headers for HTTP servers
  • Real-time Updates: Automatic synchronization between frontend settings and backend configuration

Requirements

  • JupyterLab >= 4.0.0
  • Python >= 3.10

Install

To install the extension, execute:

pip install jupyter_mcp_manager

After installation, restart JupyterLab for the extension to be activated.

Usage

Accessing MCP Server Settings

  1. Open JupyterLab
  2. Go to Settings > Advanced Settings Editor
  3. Select MCP Manager from the left sidebar
  4. Configure your MCP servers using the UI or switch to the JSON tab for raw JSON editing

Configuration File

You can also configure MCP servers by creating a mcp_servers.json file in your Jupyter config directory (typically ~/.jupyter/):

{
  "mcp_servers": [
    {
      "name": "my-stdio-server",
      "type": "stdio",
      "command": "/path/to/mcp-server-executable",
      "args": ["--option1", "value1"],
      "env": [{ "name": "ENV_VAR", "value": "value" }]
    },
    {
      "name": "my-http-server",
      "type": "http",
      "url": "http://localhost:8080",
      "headers": [{ "name": "Authorization", "value": "Bearer token" }]
    }
  ]
}

Server Configuration Options

Stdio Server (Local Executable)

Field Required Description
name Yes Unique identifier for the server
type Yes Must be "stdio"
command Yes Path to the MCP server executable
args No Array of command-line arguments
env No Array of environment variables (each with name and value)

HTTP Server (Remote Endpoint)

Field Required Description
name Yes Unique identifier for the server
type Yes Must be "http"
url Yes URL of the MCP server endpoint
headers No Array of HTTP headers (each with name and value)

Uninstall

To remove the extension, execute:

pip uninstall jupyter_mcp_manager

Troubleshoot

If you are seeing the frontend extension, but it is not working, check that the server extension is enabled:

jupyter server extension list

If the server extension is installed and enabled, but you are not seeing the frontend extension, check the frontend extension is installed:

jupyter labextension list

Contributing

Development install

Note: You will need NodeJS to build the extension package.

The jlpm command is JupyterLab's pinned version of yarn that is installed with JupyterLab. You may use yarn or npm in lieu of jlpm below.

# Clone the repo to your local environment
# Change directory to the jupyter_mcp_manager directory

# Set up a virtual environment and install package in development mode
python -m venv .venv
source .venv/bin/activate
pip install --editable ".[dev,test]"

# Link your development version of the extension with JupyterLab
jupyter labextension develop . --overwrite
# Server extension must be manually installed in develop mode
jupyter server extension enable jupyter_mcp_manager

# Rebuild extension Typescript source after making changes
# IMPORTANT: Unlike the steps above which are performed only once, do this step
# every time you make a change.
jlpm build

You can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension.

# Watch the source directory in one terminal, automatically rebuilding when needed
jlpm watch
# Run JupyterLab in another terminal
jupyter lab

With the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).

By default, the jlpm build command generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:

jupyter lab build --minimize=False

Development uninstall

# Server extension must be manually disabled in develop mode
jupyter server extension disable jupyter_mcp_manager
pip uninstall jupyter_mcp_manager

In development mode, you will also need to remove the symlink created by jupyter labextension develop command. To find its location, you can run jupyter labextension list to figure out where the labextensions folder is located. Then you can remove the symlink named jupyter-mcp-manager within that folder.

Testing the extension

Server tests

This extension is using Pytest for Python code testing.

Install test dependencies (needed only once):

pip install -e ".[test]"
# Each time you install the Python package, you need to restore the front-end extension link
jupyter labextension develop . --overwrite

To execute them, run:

pytest -vv -r ap --cov jupyter_mcp_manager

Frontend tests

This extension is using Jest for JavaScript code testing.

To execute them, execute:

jlpm
jlpm test

Integration tests

This extension uses Playwright for the integration tests (aka user level tests). More precisely, the JupyterLab helper Galata is used to handle testing the extension in JupyterLab.

More information are provided within the ui-tests README.

Packaging the extension

See RELEASE

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

jupyter_mcp_manager-0.2.0.tar.gz (310.4 kB view details)

Uploaded Source

Built Distribution

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

jupyter_mcp_manager-0.2.0-py3-none-any.whl (126.0 kB view details)

Uploaded Python 3

File details

Details for the file jupyter_mcp_manager-0.2.0.tar.gz.

File metadata

  • Download URL: jupyter_mcp_manager-0.2.0.tar.gz
  • Upload date:
  • Size: 310.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for jupyter_mcp_manager-0.2.0.tar.gz
Algorithm Hash digest
SHA256 798bc1374ee6b58f8e279316b41a9eb2982f47d385aed3ff24a35c9727a1041a
MD5 b1dd59a979e2c015f3f52ea724bb787a
BLAKE2b-256 64750f401832109ad2b9b698fa800dfd8504d747dd45766a517b567f5e194ca6

See more details on using hashes here.

File details

Details for the file jupyter_mcp_manager-0.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for jupyter_mcp_manager-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7e40d43f8ae6a124dc37b01b582041f090977ef39998ec781d3e8eede0aab93f
MD5 d0382227ae9a916651bdd2804f5626d9
BLAKE2b-256 e482e104e8689fa4cddbc75053e983b34c095571dc726b5ee1916740b55b09cc

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