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