From 5e0a0a880b5a46994126fd413409a420982b3cff Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?El=C3=A9onore=20Charles?= Date: Wed, 19 Nov 2025 10:30:10 +0100 Subject: [PATCH 1/6] add tip for correct env setup --- docs/docs/jupyter/stdio/index.mdx | 12 +++++++++++- .../streamable-http/jupyter-extension/index.mdx | 10 ++++++++++ .../jupyter/streamable-http/standalone/index.mdx | 10 ++++++++++ 3 files changed, 31 insertions(+), 1 deletion(-) diff --git a/docs/docs/jupyter/stdio/index.mdx b/docs/docs/jupyter/stdio/index.mdx index 643db61..eae23d8 100644 --- a/docs/docs/jupyter/stdio/index.mdx +++ b/docs/docs/jupyter/stdio/index.mdx @@ -12,6 +12,16 @@ pip uninstall -y pycrdt datalayer_pycrdt pip install datalayer_pycrdt==0.12.17 ``` +:::tip +To confirm your environment is correctly configured: +1. Open a notebook in JupyterLab +2. Type some content in any cell (code or markdown) +3. Observe the tab indicator: you should see an "×" appear next to the notebook name, indicating unsaved changes +4. Wait a few seconds—the "×" should automatically change to a "○" without manually saving + +This automatic saving behavior confirms that the real-time collaboration features are working properly, which is essential for MCP server integration. +::: + ### JupyterLab start Then, start JupyterLab with the following command. @@ -238,4 +248,4 @@ For advanced configurations with separate document storage and runtime execution - Test token: `curl -H "Authorization: token YOUR_TOKEN" http://localhost:8888/api/sessions` - Check token in Jupyter server logs or URL parameters -For detailed troubleshooting and advanced configuration, see the [configuration guide](/configuration). \ No newline at end of file +For detailed troubleshooting and advanced configuration, see the [configuration guide](/configuration). diff --git a/docs/docs/jupyter/streamable-http/jupyter-extension/index.mdx b/docs/docs/jupyter/streamable-http/jupyter-extension/index.mdx index 88776cc..362b9d9 100644 --- a/docs/docs/jupyter/streamable-http/jupyter-extension/index.mdx +++ b/docs/docs/jupyter/streamable-http/jupyter-extension/index.mdx @@ -12,6 +12,16 @@ pip uninstall -y pycrdt datalayer_pycrdt pip install datalayer_pycrdt==0.12.17 jupyter_mcp_tools ``` +:::tip +To confirm your environment is correctly configured: +1. Open a notebook in JupyterLab +2. Type some content in any cell (code or markdown) +3. Observe the tab indicator: you should see an "×" appear next to the notebook name, indicating unsaved changes +4. Wait a few seconds—the "×" should automatically change to a "○" without manually saving + +This automatic saving behavior confirms that the real-time collaboration features are working properly, which is essential for MCP server integration. +::: + ### Start JupyterLab with MCP Extension Start JupyterLab with the MCP server extension: diff --git a/docs/docs/jupyter/streamable-http/standalone/index.mdx b/docs/docs/jupyter/streamable-http/standalone/index.mdx index 5eba29c..5416945 100644 --- a/docs/docs/jupyter/streamable-http/standalone/index.mdx +++ b/docs/docs/jupyter/streamable-http/standalone/index.mdx @@ -12,6 +12,16 @@ pip uninstall -y pycrdt datalayer_pycrdt pip install datalayer_pycrdt==0.12.17 ``` +:::tip +To confirm your environment is correctly configured: +1. Open a notebook in JupyterLab +2. Type some content in any cell (code or markdown) +3. Observe the tab indicator: you should see an "×" appear next to the notebook name, indicating unsaved changes +4. Wait a few seconds—the "×" should automatically change to a "○" without manually saving + +This automatic saving behavior confirms that the real-time collaboration features are working properly, which is essential for MCP server integration. +::: + ### JupyterLab start Then, start JupyterLab with the following command. From fd285ec7efba1ee37164c58a357c212b5602e372 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?El=C3=A9onore=20Charles?= Date: Wed, 19 Nov 2025 10:30:42 +0100 Subject: [PATCH 2/6] add tip for correct env setup --- README.md | 25 +++++++++---------------- 1 file changed, 9 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 058a628..020fb7a 100644 --- a/README.md +++ b/README.md @@ -23,25 +23,9 @@ [![Docker Pulls](https://img.shields.io/docker/pulls/datalayer/jupyter-mcp-server?style=for-the-badge&logo=docker&logoColor=white&color=2496ED)](https://hub.docker.com/r/datalayer/jupyter-mcp-server) [![License](https://img.shields.io/badge/License-BSD_3--Clause-blue?style=for-the-badge&logo=open-source-initiative&logoColor=white)](https://opensource.org/licenses/BSD-3-Clause) - - - - - -
- -📢 **Upcoming JupyterCon 2025**: We'll be presenting Jupyter MCP Server at [JupyterCon 2025](https://jupytercon2025.sched.com/event/28H3z) on November 4! Join us to learn about ✨ AI-powered notebook interactions and the future of 🪐 Jupyter workflows. - - - -[![JupyterCon 2025](https://assets.datalayer.tech/jupyter-mcp/JupyterCon.png)](https://jupytercon2025.sched.com/event/28H3z) - -
![Jupyter MCP Server Demo](https://assets.datalayer.tech/jupyter-mcp/mcp-demo-multimodal.gif) -> 🚨 **Latest Release: v17.0**: **JupyterLab Mode Integration!** Enhanced UI integration with automatic notebook opening. [📋 Read more in the release notes](https://jupyter-mcp-server.datalayer.tech/releases) - ## 📖 Table of Contents @@ -133,6 +117,15 @@ pip uninstall -y pycrdt datalayer_pycrdt pip install datalayer_pycrdt==0.12.17 ``` +> [!TIP] +> To confirm your environment is correctly configured: +> 1. Open a notebook in JupyterLab +> 2. Type some content in any cell (code or markdown) +> 3. Observe the tab indicator: you should see an "×" appear next to the notebook name, indicating unsaved changes +> 4. Wait a few seconds—the "×" should automatically change to a "○" without manually saving +> +> This automatic saving behavior confirms that the real-time collaboration features are working properly, which is essential for MCP server integration. + ### 2. Start JupyterLab ```bash From 663f49efeda1cebf63f18e3aea1505818d9b840e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?El=C3=A9onore=20Charles?= Date: Wed, 19 Nov 2025 11:27:12 +0100 Subject: [PATCH 3/6] Update docs/docs/jupyter/streamable-http/jupyter-extension/index.mdx Co-authored-by: Eric Charles <226720+echarles@users.noreply.github.com> --- docs/docs/jupyter/streamable-http/jupyter-extension/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/jupyter/streamable-http/jupyter-extension/index.mdx b/docs/docs/jupyter/streamable-http/jupyter-extension/index.mdx index 362b9d9..4fdd1f0 100644 --- a/docs/docs/jupyter/streamable-http/jupyter-extension/index.mdx +++ b/docs/docs/jupyter/streamable-http/jupyter-extension/index.mdx @@ -17,7 +17,7 @@ To confirm your environment is correctly configured: 1. Open a notebook in JupyterLab 2. Type some content in any cell (code or markdown) 3. Observe the tab indicator: you should see an "×" appear next to the notebook name, indicating unsaved changes -4. Wait a few seconds—the "×" should automatically change to a "○" without manually saving +4. Wait a few seconds—the "×" should automatically change to a "●" without manually saving This automatic saving behavior confirms that the real-time collaboration features are working properly, which is essential for MCP server integration. ::: From 28f5e2d8856df2e35c1a0f226009c5a43d4d3e93 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?El=C3=A9onore=20Charles?= Date: Wed, 19 Nov 2025 11:27:19 +0100 Subject: [PATCH 4/6] Update README.md Co-authored-by: Eric Charles <226720+echarles@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 020fb7a..99d60af 100644 --- a/README.md +++ b/README.md @@ -122,7 +122,7 @@ pip install datalayer_pycrdt==0.12.17 > 1. Open a notebook in JupyterLab > 2. Type some content in any cell (code or markdown) > 3. Observe the tab indicator: you should see an "×" appear next to the notebook name, indicating unsaved changes -> 4. Wait a few seconds—the "×" should automatically change to a "○" without manually saving +> 4. Wait a few seconds—the "×" should automatically change to a "●" without manually saving > > This automatic saving behavior confirms that the real-time collaboration features are working properly, which is essential for MCP server integration. From 7006bf2b086df844f1d7b3b616c3b5cce8ed7f8c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?El=C3=A9onore=20Charles?= Date: Wed, 19 Nov 2025 11:27:25 +0100 Subject: [PATCH 5/6] Update docs/docs/jupyter/streamable-http/standalone/index.mdx Co-authored-by: Eric Charles <226720+echarles@users.noreply.github.com> --- docs/docs/jupyter/streamable-http/standalone/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/jupyter/streamable-http/standalone/index.mdx b/docs/docs/jupyter/streamable-http/standalone/index.mdx index 5416945..2c98899 100644 --- a/docs/docs/jupyter/streamable-http/standalone/index.mdx +++ b/docs/docs/jupyter/streamable-http/standalone/index.mdx @@ -17,7 +17,7 @@ To confirm your environment is correctly configured: 1. Open a notebook in JupyterLab 2. Type some content in any cell (code or markdown) 3. Observe the tab indicator: you should see an "×" appear next to the notebook name, indicating unsaved changes -4. Wait a few seconds—the "×" should automatically change to a "○" without manually saving +4. Wait a few seconds—the "×" should automatically change to a "●" without manually saving This automatic saving behavior confirms that the real-time collaboration features are working properly, which is essential for MCP server integration. ::: From 819c9eedb8361ff417e94be09a0d3e6bdd95c283 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?El=C3=A9onore=20Charles?= Date: Wed, 19 Nov 2025 11:27:33 +0100 Subject: [PATCH 6/6] Update docs/docs/jupyter/stdio/index.mdx Co-authored-by: Eric Charles <226720+echarles@users.noreply.github.com> --- docs/docs/jupyter/stdio/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/jupyter/stdio/index.mdx b/docs/docs/jupyter/stdio/index.mdx index eae23d8..abf5319 100644 --- a/docs/docs/jupyter/stdio/index.mdx +++ b/docs/docs/jupyter/stdio/index.mdx @@ -17,7 +17,7 @@ To confirm your environment is correctly configured: 1. Open a notebook in JupyterLab 2. Type some content in any cell (code or markdown) 3. Observe the tab indicator: you should see an "×" appear next to the notebook name, indicating unsaved changes -4. Wait a few seconds—the "×" should automatically change to a "○" without manually saving +4. Wait a few seconds—the "×" should automatically change to a "●" without manually saving This automatic saving behavior confirms that the real-time collaboration features are working properly, which is essential for MCP server integration. :::