Skip to main content

A JupyterLab extension for Chat with AI supporting MCP

Project description

mcp_client_jupyter_chat

Github Actions Status Binder

A JupyterLab extension for Chat with AI supporting Model Context Protocol (MCP). This extension integrates AI and provides interactive tool usage capabilities through MCP servers.

Demo

demo

Features

  • Seamless integration with AI models (Currently supported models are Anthropi. More models are coming soon. )
  • Real-time streaming of responses with step-by-step reasoning
  • Support for MCP server tools with interactive execution:
  • Rich content display
  • Interactive chat interface

Requirements

  • JupyterLab >= 4.0.0
  • An Anthropic API key for Claude access
  • Running MCP server(s) for tool integration (optional)

Model Configuration

The extension supports multiple Claude models through the Anthropic API. You'll need to:

  1. Obtain an Anthropic API key from Anthropic's website
  2. Configure your models in JupyterLab's Settings Editor under the "MCP Chat" section
  3. For each model, provide:
    • Name (e.g., "gpt-4")
    • API Key
    • Set as default (optional)

Install

To install the extension, execute:

pip install mcp_client_jupyter_chat

Uninstall

To remove the extension, execute:

pip uninstall mcp_client_jupyter_chat

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 mcp_client_jupyter_chat directory
# Install package in development mode
pip install -e "."
# Link your development version of the extension with JupyterLab
jupyter labextension develop . --overwrite
# Rebuild extension Typescript source after making changes
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

pip uninstall mcp_client_jupyter_chat

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 mcp-client-jupyter-chat within that folder.

Testing the extension

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

mcp_client_jupyter_chat-0.1.7.tar.gz (20.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_client_jupyter_chat-0.1.7-py3-none-any.whl (73.1 kB view details)

Uploaded Python 3

File details

Details for the file mcp_client_jupyter_chat-0.1.7.tar.gz.

File metadata

  • Download URL: mcp_client_jupyter_chat-0.1.7.tar.gz
  • Upload date:
  • Size: 20.8 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for mcp_client_jupyter_chat-0.1.7.tar.gz
Algorithm Hash digest
SHA256 2b092cc26f59254593f470e27ec6d5e3f37c0a5ef0581d4b800baf5c0d3630c3
MD5 94c2cf7dab48fbfa02d42d288795dcd1
BLAKE2b-256 d09788a8b140738d218d7715cb3c48078b8af6d072f8c99df8d6c20900e752ad

See more details on using hashes here.

File details

Details for the file mcp_client_jupyter_chat-0.1.7-py3-none-any.whl.

File metadata

File hashes

Hashes for mcp_client_jupyter_chat-0.1.7-py3-none-any.whl
Algorithm Hash digest
SHA256 f66d70ad1b5b6951fa4a1303040a0f740007596e23fce540a56fde7dde993a82
MD5 f1aced353444765d5022f1a055def3f7
BLAKE2b-256 08af1b5d3bf339b70630ec37e6fb7cf1c2f8ee6c58438756d90bad33eb8ce0fc

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