Cursor Notebook MCP

🚀 クイックスタート

この cursor-notebook-mcp プロジェクトは、Cursor で Jupyter ノートブックファイル（.ipynb）をサポートすることを目的としています。Cursor を通じてノートブックファイルの読み取り、書き込み、および修正操作を行うことができます。

📦 インストール

仮想環境を使用したインストール

プロジェクトのインストールには、仮想環境の使用をおすすめします。

python -m venv .venv
source .venv/bin/activate  # Windows では activate スクリプトを使用
pip install .

グローバルインストール（推奨しません）

グローバルインストールを選択する場合は、管理者権限を有効にしてください。

sudo pip install .

📚 ドキュメント

設定に関する説明

プロジェクトは以下の設定オプションを提供しています。

• ログファイルの保存先：デフォルトは ~/.cursor_notebook_mcp で、コマンドライン引数 --log-level で設定できます。
• ログレベル：DEBUG、INFO、WARNING、ERROR、CRITICAL がサポートされており、デフォルトは INFO です。
• 最大セルソースデータサイズ：デフォルトは 10 MiB で、--max-cell-source-size で調整できます。
• 最大セル出力データサイズ：デフォルトは 10 MiB で、--max-cell-output-size で調整できます。

セキュリティに関する注意事項

• 作業ディレクトリのルートディレクトリの強制：サーバー起動時に --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