Skip to content

Commit d547cfd

Browse files
Ft/env tip (#168)
* add tip for correct env setup * add tip for correct env setup * Update docs/docs/jupyter/streamable-http/jupyter-extension/index.mdx Co-authored-by: Eric Charles <226720+echarles@users.noreply.github.com> * Update README.md Co-authored-by: Eric Charles <226720+echarles@users.noreply.github.com> * Update docs/docs/jupyter/streamable-http/standalone/index.mdx Co-authored-by: Eric Charles <226720+echarles@users.noreply.github.com> * Update docs/docs/jupyter/stdio/index.mdx Co-authored-by: Eric Charles <226720+echarles@users.noreply.github.com> --------- Co-authored-by: Eric Charles <226720+echarles@users.noreply.github.com>
1 parent 23b7ef4 commit d547cfd

File tree

4 files changed

+40
-17
lines changed

4 files changed

+40
-17
lines changed

README.md

Lines changed: 9 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -23,25 +23,9 @@
2323
[![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)
2424
[![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)
2525

26-
<table>
27-
<tr>
28-
<td width="60%">
29-
30-
📢 **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.
31-
32-
</td>
33-
<td width="40%" align="center">
34-
35-
[![JupyterCon 2025](https://assets.datalayer.tech/jupyter-mcp/JupyterCon.png)](https://jupytercon2025.sched.com/event/28H3z)
36-
37-
</td>
38-
</tr>
39-
</table>
4026

4127
![Jupyter MCP Server Demo](https://assets.datalayer.tech/jupyter-mcp/mcp-demo-multimodal.gif)
4228

43-
> 🚨 **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)
44-
4529
</div>
4630

4731
## 📖 Table of Contents
@@ -133,6 +117,15 @@ pip uninstall -y pycrdt datalayer_pycrdt
133117
pip install datalayer_pycrdt==0.12.17
134118
```
135119

120+
> [!TIP]
121+
> To confirm your environment is correctly configured:
122+
> 1. Open a notebook in JupyterLab
123+
> 2. Type some content in any cell (code or markdown)
124+
> 3. Observe the tab indicator: you should see an "×" appear next to the notebook name, indicating unsaved changes
125+
> 4. Wait a few seconds—the "×" should automatically change to a "●" without manually saving
126+
>
127+
> This automatic saving behavior confirms that the real-time collaboration features are working properly, which is essential for MCP server integration.
128+
136129
### 2. Start JupyterLab
137130

138131
```bash

docs/docs/jupyter/stdio/index.mdx

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,16 @@ pip uninstall -y pycrdt datalayer_pycrdt
1212
pip install datalayer_pycrdt==0.12.17
1313
```
1414

15+
:::tip
16+
To confirm your environment is correctly configured:
17+
1. Open a notebook in JupyterLab
18+
2. Type some content in any cell (code or markdown)
19+
3. Observe the tab indicator: you should see an "×" appear next to the notebook name, indicating unsaved changes
20+
4. Wait a few seconds—the "×" should automatically change to a "●" without manually saving
21+
22+
This automatic saving behavior confirms that the real-time collaboration features are working properly, which is essential for MCP server integration.
23+
:::
24+
1525
### JupyterLab start
1626

1727
Then, start JupyterLab with the following command.
@@ -238,4 +248,4 @@ For advanced configurations with separate document storage and runtime execution
238248
- Test token: `curl -H "Authorization: token YOUR_TOKEN" http://localhost:8888/api/sessions`
239249
- Check token in Jupyter server logs or URL parameters
240250

241-
For detailed troubleshooting and advanced configuration, see the [configuration guide](/configuration).
251+
For detailed troubleshooting and advanced configuration, see the [configuration guide](/configuration).

docs/docs/jupyter/streamable-http/jupyter-extension/index.mdx

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,16 @@ pip uninstall -y pycrdt datalayer_pycrdt
1212
pip install datalayer_pycrdt==0.12.17 jupyter_mcp_tools
1313
```
1414

15+
:::tip
16+
To confirm your environment is correctly configured:
17+
1. Open a notebook in JupyterLab
18+
2. Type some content in any cell (code or markdown)
19+
3. Observe the tab indicator: you should see an "×" appear next to the notebook name, indicating unsaved changes
20+
4. Wait a few seconds—the "×" should automatically change to a "●" without manually saving
21+
22+
This automatic saving behavior confirms that the real-time collaboration features are working properly, which is essential for MCP server integration.
23+
:::
24+
1525
### Start JupyterLab with MCP Extension
1626

1727
Start JupyterLab with the MCP server extension:

docs/docs/jupyter/streamable-http/standalone/index.mdx

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,16 @@ pip uninstall -y pycrdt datalayer_pycrdt
1212
pip install datalayer_pycrdt==0.12.17
1313
```
1414

15+
:::tip
16+
To confirm your environment is correctly configured:
17+
1. Open a notebook in JupyterLab
18+
2. Type some content in any cell (code or markdown)
19+
3. Observe the tab indicator: you should see an "×" appear next to the notebook name, indicating unsaved changes
20+
4. Wait a few seconds—the "×" should automatically change to a "●" without manually saving
21+
22+
This automatic saving behavior confirms that the real-time collaboration features are working properly, which is essential for MCP server integration.
23+
:::
24+
1525
### JupyterLab start
1626

1727
Then, start JupyterLab with the following command.

0 commit comments

Comments
 (0)