jupyter-notebook-mcp

🚀 使用说明

本项目提供了一套集成Jupyter Notebook和Claude Desktop的开发环境，通过WebSocket服务器实现两者的交互。用户可以在Claude Desktop中打开Jupyter Notebook文件，并使用外部客户端进行测试。

🚀 快速开始

安装依赖

确保你已安装以下软件：

• Python 3.x
• pip（用于管理Python包）
• uvicorn（用于启动WebSocket服务器）

安装这些依赖可以在终端或命令提示符中运行：

pip install uvicorn websockets jupyter-client python-dotenv

启动Jupyter Notebook

在终端或命令提示符中启动Jupyter Notebook：

jupyter notebook

启动WebSocket服务器

导航到你的项目目录，然后运行以下命令启动WebSocket服务器：

uvicorn server:app --reload

这将在http://localhost:8000启动一个本地服务器。

✨ 主要特性

• 支持Claude Desktop与Jupyter Notebook的集成，方便在Claude Desktop中操作Jupyter Notebook文件。
• 提供外部客户端测试功能，支持批处理模式。
• 具备一定的问题解决机制，如处理连接超时、端口冲突等问题。

📦 安装指南

下载与安装Claude Desktop

访问官方链接下载并安装Claude Desktop。

配置Claude Desktop

打开Claude Desktop，进入设置菜单：

1. 找到API Settings。
2. 填写你的API密钥（如你有）。
3. 点击保存。

连接Jupyter Notebook

在Claude Desktop中，选择File > Open，然后选择你的Jupyter Notebook文件。

💻 使用示例

启动外部客户端

运行以下命令启动外部客户端：

uv run python src/jupyter_ws_external_client.py

批处理模式

如果你希望以批处理模式运行，可以使用以下命令：

uv run python src/jupyter_ws_external_client.py --batch

📚 详细文档

解决问题

连接问题

如果出现连接超时，请尝试以下步骤：

• 重新启动WebSocket服务器。
• 检查端口冲突：默认端口为8765，若被占用，服务器会自动选择其他可用端口。

单元格执行问题

确保单元格内容有效且内核正在运行。可以通过以下方式验证：

1. 点击Jupyter Notebook中的Kernel菜单。
2. 确保选择的内核已启动。

WebSocket端口冲突

如果默认端口8765已被占用，服务器会自动尝试其他可用端口。

限制与注意事项

• 仅支持Jupyter Notebook 6.x版本。
• 文本输出限制为1500字符。
• 不支持高级Jupyter插件交互（如自定义小部件）。
• 连接可能因长时间空闲而超时。

其他资源

受以下项目启发：

• ihrpr
• Datalayer