Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 9 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

<table>
<tr>
<td width="60%">

📢 **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.

</td>
<td width="40%" align="center">

[![JupyterCon 2025](https://assets.datalayer.tech/jupyter-mcp/JupyterCon.png)](https://jupytercon2025.sched.com/event/28H3z)

</td>
</tr>
</table>

![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)

</div>

## 📖 Table of Contents
Expand Down Expand Up @@ -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
Expand Down
12 changes: 11 additions & 1 deletion docs/docs/jupyter/stdio/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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).
For detailed troubleshooting and advanced configuration, see the [configuration guide](/configuration).
10 changes: 10 additions & 0 deletions docs/docs/jupyter/streamable-http/jupyter-extension/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
10 changes: 10 additions & 0 deletions docs/docs/jupyter/streamable-http/standalone/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Loading