📁aidp-workspace-files
- ソース
- GitHub で見る ↗
説明
ファイルおよびノートブックをAIDPワークスペースのファイルシステム上で管理します。 ファイル・フォルダ・ノートブックの一覧表示、アップロード、ダウンロード、読み取り、作成、移動、名前変更、削除が可能です。 次のような場合に使用: ユーザーがスクリプト・ノートブック・設定ファイルをワークスペースに配置したいとき、ワークスペース内のファイルを読み取ったり移動したいとき、または `Shared/` フォルダを整理したいとき。
原文を表示
Manage files and notebooks in the AIDP workspace filesystem — list, upload, download, read, create, move, rename, delete files/folders/notebooks. Use when the user wants to put a script/notebook/config into the workspace, read or move workspace files, or organize Shared/ folders.
ユースケース
- ✓スクリプト・ノートブック・設定ファイルをアップロード
- ✓ワークスペース内のファイルを読み取り・移動
- ✓ファイル・フォルダ・ノートブックを一覧表示
- ✓Shared/フォルダを整理・整頓
本文(日本語訳)
aidp-workspace-files — ワークスペースファイルシステム & ノートブック CRUD
AIDPワークスペースのファイルシステムおよびJupyterコンテンツを管理します。
主エンジン: Oracle公式 aidp CLI の workspace-object グループ(同一REST API+認証)。
CLIがインストールされていない場合のフォールバックとして、Notebookコンテンツ API に対する oci raw-request を使用します。
次のような場合に使用
- 「このスクリプト/ノートブックをワークスペースにアップロードしたい」
- 「ワークスペースのファイルを一覧表示・読み取り・移動・リネーム・削除したい」
- 「Shared フォルダを整理したい」
CLI(推奨)
references/aidp-cli-map.md に基づく:
workspace-object create | get | head | list | update | copy | move | rename | delete | upload-with-par | download-with-par
すべてのコマンドに以下のオプションが必要です(ワークスペーススコープ — <WS> を確認してください):
--instance-id <DATALAKE_OCID> --auth api_key --profile DEFAULT --region <r>
# ディレクトリを参照
aidp workspace-object list \
--instance-id <DATALAKE_OCID> --auth api_key --profile DEFAULT --region us-ashburn-1
# ファイル/ノートブックを読み取る(head = メタデータのみ)
aidp workspace-object get \
--instance-id <DATALAKE_OCID> --auth api_key --profile DEFAULT --region us-ashburn-1
# 作成/上書き
aidp workspace-object create --body-file .aidp/payloads/create-load-py.json \
--instance-id <DATALAKE_OCID> --auth api_key --profile DEFAULT --region us-ashburn-1
# 再編成
aidp workspace-object move|rename|copy|delete ...
# PARを使った転送(バイナリセーフ)
aidp workspace-object upload-with-par|download-with-par ...
変更系操作(create / update / move / rename / delete / upload-with-par):
実行前にボディを .aidp/payloads/ に保存し、ユーザーに確認を取ってから実行してください
(references/payloads.md 参照)。
フォールバック(CLIなしの場合)
oci raw-request を使用して、ワークスペーススコープのJupyter Notebook contents API に対して同一のREST+認証で操作します
(認証ラダーは references/oci-raw-request.md 参照)。
ベースURL:
…/20240831/dataLakes/<DATALAKE_OCID>/workspaces/<WS>/notebook/api/contents/<urlencoded-path>
| 操作 | 方法 |
|---|---|
| ディレクトリ一覧 | GET <dir> |
| ファイル読み取り | GET <file>?content=1(.ipynb の場合は type=notebook) |
| 作成/上書き | PUT <path>(ボディに type / format / content を指定) |
| 無題ファイル作成 / リネーム・移動 | POST <dir>({"path":…}) |
| 削除 | DELETE <path> |
Jupyterのボディ形式:
- ファイル:
{"type":"file","format":"text","content":"…"} - ノートブック:
{"type":"notebook","content":<ipynb-json>} - ディレクトリ:
{"type":"directory"}
⚠️ 2026-06-10 de-agent にて実機検証済み — 訂正:
…/notebook/api/contents/<path>APIに対する素のapi_keyによるoci raw-requestは、20240831インスタンスでのファイルCRUDが確実には動作しません。
- ディレクトリ
GET→ 500 InternalErrorPUTによる作成 /GET/ パスに対するDELETE→ 404 NotAuthorizedOrNotFound (ルート自体は到達可能でJSONエラーは返るが、HTTPコンテンツCRUDは成功しない)コンテンツHTTP RESTパスは 修正待ち /
AIDP_SESSIONで再テスト要 として扱ってください。 ファイル/ノートブックの確実なCRUDには、以下のいずれかを使用してください:
- WebSocket Jupyter ヘルパー(
scripts/aidp_sql.py、aidp-notebooksが使用 — ノートブックの自動作成、/Workspace/Sharedでの一覧・削除に対応)- PARベースの
upload-with-par/download-with-parnb_*MCPツール
ワークフロー
- ワークスペース(
<WS>)とDataLake OCIDを確認する。ローカルの.envは信用しないこと。 - 一覧表示/検査:
aidp workspace-object list(メタデータはhead、内容の読み取りはget) - ファイル/ノートブックの配置:
aidp workspace-object create(ボディを.aidp/payloads/に保存し、事前に確認を取る) - 移動/リネーム/コピー:
aidp workspace-object move|rename|copy - 削除:
aidp workspace-object delete— 削除前に必ずlistを実行し、直前に自分で作成したもの以外は削除前に確認を取ること
注意事項
- 検証優先(ファブリケーション禁止):
変更操作の前に、既知のディレクトリに対して
list/GETを実行してパスを確認し、動作する形式を記録すること。削除前には必ず一覧を確認すること。 - バイナリのアップロード(wheels / jars / 画像 / parquet):
upload-with-par/download-with-par、またはaidp-volumes経由の ボリューム + PAR を使用すること。 JSONコンテンツAPIはテキスト/ノートブック専用です。 - シークレットや
.envは絶対にアップロードしないこと。
参考資料
- references/aidp-cli-map.md
- references/payloads.md
- references/oci-raw-request.md
- references/no-mcp-rest-map.md
- 関連スキル:
aidp-notebooks、aidp-volumes
原文(English)を表示
aidp-workspace-files — workspace filesystem & notebook CRUD
Manage the AIDP workspace filesystem and Jupyter contents. Primary engine: the official Oracle aidp CLI
workspace-object group (same REST API + auth); oci raw-request against the Notebook contents API is the
fallback when the CLI isn't installed.
When to use
- "Upload this script/notebook to the workspace", "list/read/move/rename/delete a workspace file", "organize the Shared folder".
CLI (preferred)
Per references/aidp-cli-map.md: workspace-object create | get | head | list | update | copy | move | rename | delete | upload-with-par | download-with-par. All take
--instance-id <DATALAKE_OCID> --auth api_key --profile DEFAULT --region <r> (workspace-scoped — confirm <WS>).
aidp workspace-object list --instance-id <DATALAKE_OCID> --auth api_key --profile DEFAULT --region us-ashburn-1 # browse a dir
aidp workspace-object get --instance-id <DATALAKE_OCID> --auth api_key --profile DEFAULT --region us-ashburn-1 # read a file/notebook (head = metadata only)
aidp workspace-object create --body-file .aidp/payloads/create-load-py.json \
--instance-id <DATALAKE_OCID> --auth api_key --profile DEFAULT --region us-ashburn-1 # create/overwrite
aidp workspace-object move|rename|copy|delete ... # reorganize
aidp workspace-object upload-with-par|download-with-par ... # PAR transfer (binary-safe)
Mutating ops (create/update/move/rename/delete/upload-with-par): persist the body to
.aidp/payloads/ and confirm with the user before running (see references/payloads.md).
Fallback (no CLI) — same REST + auth via the workspace-scoped Jupyter Notebook contents API with
oci raw-request (auth ladder in references/oci-raw-request.md):
Base …/20240831/dataLakes/<DATALAKE_OCID>/workspaces/<WS>/notebook/api/contents/<urlencoded-path> —
GET <dir> list · GET <file>?content=1 (type=notebook for .ipynb) read · PUT <path> create/overwrite
(type/format/content body) · POST <dir> create-untitled / rename-move ({"path":…}) · DELETE <path>.
Jupyter shapes: file {"type":"file","format":"text","content":"…"}; notebook {"type":"notebook","content":<ipynb-json>};
dir {"type":"directory"}.
Live-verified 2026-06-10 on de-agent — correction: bare
api_keyoci raw-requestagainst the…/notebook/api/contents/<path>API does not reliably do file CRUD on20240831instances — directoryGET→ 500 InternalError;PUT-create /GET/DELETEof a path → 404 NotAuthorizedOrNotFound (route is reachable — structured JSON errors — but the HTTP contents CRUD does not succeed). Treat the contents HTTP REST path as not-working pending fix / AIDP_SESSION re-test. For reliable file/notebook CRUD, route ops through the WebSocket Jupyter helper (scripts/aidp_sql.py, used byaidp-notebooks— auto-creates notebooks, lists/deletes at/Workspace/Shared), PAR-basedupload-with-par/download-with-par, or thenb_*MCP tools.
Workflow
- Confirm the workspace (
<WS>) and DataLake OCID; never trust a local.env. - List/inspect:
aidp workspace-object list(thenheadfor metadata,getto read). - Put a file/notebook:
aidp workspace-object create(persist body to.aidp/payloads/, confirm first). - Move/rename/copy:
aidp workspace-object move|rename|copy. - Delete:
aidp workspace-object delete— do alistfirst and confirm before deleting anything you didn't just create.
Notes
- Verify-first (no-fabrication): confirm the path with a live
list/GETof a known dir before mutating; record the working shape. List before any delete. - Binary uploads (wheels/jars/images/parquet): use
upload-with-par/download-with-par(or a volume + PAR viaaidp-volumes) — the JSON contents API is text/notebook only. - Never upload secrets/
.env.
References
- references/aidp-cli-map.md · references/payloads.md · references/oci-raw-request.md · references/no-mcp-rest-map.md · pairs with
aidp-notebooks,aidp-volumes
原文・著作権は Anthropic および各プラグイン作者に帰属します。日本語訳は Claude API による自動翻訳です。