Cursor Notebook MCP

🚀 cursor-notebook-mcp

cursor-notebook-mcp 项目致力于为 Cursor 提供对 Jupyter 笔记本文件（.ipynb）的支持。用户能够借助 Cursor 完成笔记本文件的读取、写入和修改操作。

🚀 快速开始

cursor-notebook-mcp 项目使 Cursor 具备处理 Jupyter 笔记本文件的能力，为用户在 Cursor 中操作 .ipynb 文件提供便利。

📦 安装指南

使用虚拟环境安装

推荐使用虚拟环境来安装项目，这样可以避免全局安装带来的依赖冲突问题。

python -m venv .venv
source .venv/bin/activate  # 在 Windows 上使用 activate 脚本
pip install .

全局安装（不推荐）

如果选择全局安装，请确保已激活管理员权限，不过这种方式可能会影响系统的其他 Python 项目。

sudo pip install .

📚 详细文档

配置说明

项目提供以下配置选项：

安全注意事项

• ⚠️ 工作区根目录强制执行：服务器启动时必须通过 --allow-root 指定允许的根目录，否则无法正常运行。
• ⚠️ 路径处理：服务器使用 os.path.realpath 解决路径，并在操作前检查是否超出允许范围。
• ⚠️ 输入验证：基本检查 .ipynb 文件扩展名。

已知限制

• 此服务器不支持单元格执行功能，仅限于对 .ipynb 文件结构的操作。

💻 使用示例

开发与测试

1. 创建虚拟环境并安装开发依赖：

python -m venv .venv
source .venv/bin/activate
pip install -e ".[dev]"

2. 执行测试：

./run_tests.sh 
# 或运行特定测试
# ./run_tests.sh tests/test_notebook_tools.py

🤝 项目贡献

欢迎任何贡献！请遵循以下步骤：

1. 叉取仓库。
2. 创建新分支：git checkout -b feature/amazing-feature
3. 进行修改。
4. 执行测试以确保没有破坏现有功能。
5. 提交更改：git commit -m 'Add amazing feature'
6. 推送到分支并提交拉取请求。

📄 许可证

本项目遵循 MIT 许可证。更多详情请查看 LICENSE 文件。

👨‍💻 项目作者

该项目由 Jim Beno 创建和维护，联系邮箱：jim@jimbeno.net