Notebook Edit

CI

Jupyter notebook (.ipynb) の構造編集に特化した MCP サーバー兼 CLI。 カーネル実行は行わない（実行は呼び出し側のクライアント／カーネルに任せる）。

コアロジック (core.py) を CLI (cli.py) と MCP サーバー (mcp_server.py) が 薄くラップする構成。ロジックは一箇所だけ。

notebook_edit/
├── core.py        # nbformat 操作の実体
├── cli.py         # argparse ラッパー
└── mcp_server.py  # FastMCP (stdio) ラッパー

安全性

• 書き込み前に nbformat.validate() を通す（不正なら書かない）
• 一時ファイル → os.replace による atomic write
• 書き込み前に .ipynb.bak を1世代だけ残す
• outputs（実行結果）は読み取り専用。コードセルの source を変更すると、 古い outputs と execution_count はクリアされる（stale な実行結果の混入を防止）

セットアップ

uv sync

CLI

uv run nb-edit --version                                    # バージョン表示
uv run nb-edit notebook-rev foo.ipynb                       # 現在の rev（並行編集ガード用）
uv run nb-edit patch-cell  foo.ipynb "x=1" "x=2" --index 0 --expected-rev <rev>  # rev 一致時のみ書く
uv run nb-edit create-notebook foo.ipynb                    # 空 notebook を新規作成
uv run nb-edit create-notebook foo.ipynb --json '[{"cell_type":"markdown","source":"# Title"}]'  # 初期セル付き
uv run nb-edit list-cells   foo.ipynb
uv run nb-edit read-cells   foo.ipynb 0 2 5                  # 複数 index を一括
uv run nb-edit read-cells   foo.ipynb --id a1b2c3d4          # id で読む
uv run nb-edit insert-cell  foo.ipynb 1 code "print('hi')" --summary "挨拶"  # 1セル挿入
uv run nb-edit insert-cells foo.ipynb 1 --json '[{"cell_type":"code","source":"import os"}]'  # 一括
uv run nb-edit edit-cell    foo.ipynb "x = 42" --index 2     # 全文置換
uv run nb-edit patch-cell   foo.ipynb "x = 42" "x = 99" --id a1b2c3d4  # 部分置換（推奨）
uv run nb-edit delete-cell  foo.ipynb --index 2
uv run nb-edit move-cell    foo.ipynb 3 --from-id a1b2c3d4   # id のセルを 3 番目へ

• インデックスは 0 始まり。負値は不可。
• 既存セルを指す edit/patch/delete/move/read は --index または --id（id は list-cells が返す安定 ID。insert/delete/move してもズレない）。挿入位置は index のまま。
• 結果は JSON で stdout に出力。エラーは stderr + 終了コード 1。

MCP サーバー

MCP 対応クライアントの stdio サーバー設定に nb-edit-mcp を登録する。設定ファイルの 場所・形式はクライアントによって異なるが、command / args は概ね共通。

ローカルの作業コピーを使う場合:

{
  "servers": {
    "notebook-edit": {
      "command": "uvx",
      "args": ["--from", "/path/to/nbedit-mcp", "nb-edit-mcp"]
    }
  }
}

Git から取得する場合は --from を Git URL に差し替える（バージョン固定推奨、@<tag>）:

"args": ["--from", "git+https://github.com/tmlksu/[email protected]", "nb-edit-mcp"]

タグを省くと最新の HEAD を取得する。相対パスはサーバーの CWD（通常はクライアントが開いている プロジェクト）基準で解決される。

注意: パッケージを指すのは --from（--with ではない）。command は uvx、args の最後は 実行するコマンド名 nb-edit-mcp。

トラブルシューティング: Failed to resolve --with requirement / Git operation failed

これは uv が --from の Git URL を fetch できていないサイン（メッセージ上は --with と出るが実体は --from の git 解決失敗）。次を確認する:

• URL の owner/repo が正しいか（tmlksu/nbedit-mcp）。README のプレースホルダ <owner> を 置換し忘れると %3Cowner%3E になって失敗する。
• 指定した @<tag> が存在するか（例: @v0.8.0）。存在しない ref も同じ失敗になる。
• private repo・ネットワーク/プロキシで git fetch がブロックされていないか。

手元で切り分けるには --from 単体で実行してみる（成功すれば nb-edit 0.8.0 が出る）:

uvx --from git+https://github.com/tmlksu/[email protected] nb-edit --version

公開ツール

ツール	引数	説明
create_notebook	path, [cells]	新規 .ipynb を作成（空 or 初期セル付き。既存は上書き拒否）
notebook_rev	path	現在の rev（内容ハッシュ）を返す。並行編集ガード用
list_cells	path	全セルの目次（id + summary + has_error）
read_cells	path, [indices], [offset], [ids]	複数セルを一括読み取り（indices か ids の一方。source 窓＋outputs_text/has_error/output_types）
insert_cell	path, index, cell_type, source, [summary]	index の前に1セル挿入
insert_cells	path, index, cells	複数セルを index の前に一括挿入（atomic）
edit_cell	`path, source, [index	cell_id], [summary]`
patch_cell	`path, old, new, [index	cell_id]`
delete_cell	`path, [index	cell_id]`
move_cell	`path, to_index, [from_index	from_id]`

cell_type は code / markdown / raw。 patch_cell の old はセル内でちょうど1回一致する必要がある （0回・複数回はエラー → 文脈を足して一意にする）。

• 並行編集ガード（optional）: 変更系（insert*/edit/patch/delete/move）に expected_rev を 渡すと、read した時点からファイルが外部で変わっていたら書き込みを拒否する（NotebookError）。 rev は notebook_rev で取得（または直前の書き込みの戻り値 rev を流用）。省略時は無検査（後方互換）。 変更系は書き込み後の新しい rev を返すので、re-read せず連続編集を chain できる。VS Code など外部エディタと 同じファイルを触るときのサイレント上書き事故を防ぐ（ADR-0017）。※本ツール側の上書きを止めるだけで、 外部エディタ側の reload は別責務。
• セル指定: 既存セルを指すツール（read/edit/patch/delete/move の対象）は index（0始まり）または id（安定 ID）のどちらか一方。id は list_cells/read_cells が返し、 insert/delete/move してもズレないので、一覧後は id 指定が安全（stale index 事故を防ぐ）。 見つからない／重複 id は即エラー（index の「静かに別セルを書き換える」を回避）。ADR-0014。 挿入位置（insert* の index、move の to_index）は位置概念なので index のまま。 各変更系の戻り値も id（複数は ids）を返す。

バージョンの取得

サーバー/CLI のバージョンは notebook_edit/__init__.py の __version__ が唯一の源 （pyproject は hatchling の dynamic version で追従）。クライアント（VS Code 拡張など）からは:

• MCP: initialize ハンドシェイクの serverInfo.version（serverInfo.name は notebook-edit）。
• CLI: nb-edit --version。
• 配布メタデータ: importlib.metadata.version("notebook-edit")。

いずれも同じ値を返す（ADR-0016）。

要約規約と出力の扱い

• 要約: list_cells の summary は metadata > 先頭 # コメント > 先頭行 の優先順位 （最大 3 行 / 各 100 字）。insert_cell / edit_cell の summary 引数で明示指定すると cell.metadata['summary'] に保存され、以降の一覧が確実に目次として機能する。
• 出力: read_cells は既存の実行結果を整形して返す（outputs_text：stdout/結果を連結、 エラーは強調、画像は [image/png] プレースホルダ、2000 字で truncate）。 セル実行はしない——実行はクライアント／カーネル側に任せ、本ツールは保存済み outputs を読むだけ。
• サイズ上限: read_cells は結果を cap する。各セルの source は 8000 字窓 （source_truncated/source_length 付き、offset でページング）、レスポンス総量は 20000 字。 超過分のセルは content_omitted: true で返るので、小さいバッチや offset で読み直す。

テスト

uv run pytest -q