openai-jupyter-notebook
Use when the user asks to create, scaffold, or edit Jupyter notebooks (`.ipynb`) for experiments, explorations, or tutorials; prefer the bundled templates and run the helper script `new_notebook.py` to generate a clean starting notebook. Originally from OpenAI's curated skills catalog.
How do I install this agent skill?
npx skills add https://github.com/trailofbits/skills-curated --skill openai-jupyter-notebookIs this agent skill safe to install?
- Gen Agent Trust Hubpass
This skill provides tools for creating and editing Jupyter notebooks using local templates and a helper script. It uses standard Python packages and focuses on organizational best practices. A minor security concern is the potential for indirect prompt injection, as user-supplied notebook titles are inserted into the notebook content without sanitization. The skill also facilitates the installation of standard Jupyter components from official registries.
- Socketpass
No alerts
- Snykpass
Risk: LOW · No issues
- Runlayerwarn
4/6 files flagged
What does this agent skill do?
Jupyter Notebook Skill
Create clean, reproducible Jupyter notebooks for two primary modes:
- Experiments and exploratory analysis
- Tutorials and teaching-oriented walkthroughs
Prefer the bundled templates and the helper script for consistent structure and fewer JSON mistakes.
When to use
- Create a new
.ipynbnotebook from scratch. - Convert rough notes or scripts into a structured notebook.
- Refactor an existing notebook to be more reproducible and skimmable.
- Build experiments or tutorials that will be read or re-run by other people.
Decision tree
- If the request is exploratory, analytical, or hypothesis-driven, choose
experiment. - If the request is instructional, step-by-step, or audience-specific, choose
tutorial. - If editing an existing notebook, treat it as a refactor: preserve intent and improve structure.
Scripts and references are located under {baseDir}/.
Workflow
-
Lock the intent. Identify the notebook kind:
experimentortutorial. Capture the objective, audience, and what "done" looks like. -
Scaffold from the template. Use the helper script to avoid hand-authoring raw notebook JSON.
uv run --python 3.12 python "$JUPYTER_NOTEBOOK_CLI" \
--kind experiment \
--title "Compare prompt variants" \
--out output/jupyter-notebook/compare-prompt-variants.ipynb
uv run --python 3.12 python "$JUPYTER_NOTEBOOK_CLI" \
--kind tutorial \
--title "Intro to embeddings" \
--out output/jupyter-notebook/intro-to-embeddings.ipynb
-
Fill the notebook with small, runnable steps. Keep each code cell focused on one step. Add short markdown cells that explain the purpose and expected result. Avoid large, noisy outputs when a short summary works.
-
Apply the right pattern. For experiments, follow
references/experiment-patterns.md. For tutorials, followreferences/tutorial-patterns.md. -
Edit safely when working with existing notebooks. Preserve the notebook structure; avoid reordering cells unless it improves the top-to-bottom story. Prefer targeted edits over full rewrites. If you must edit raw JSON, review
references/notebook-structure.mdfirst. -
Validate the result. Run the notebook top-to-bottom when the environment allows. If execution is not possible, say so explicitly and call out how to validate locally. Use the final pass checklist in
references/quality-checklist.md.
Templates and helper script
- Templates live in
assets/experiment-template.ipynbandassets/tutorial-template.ipynb. - The helper script loads a template, updates the title cell, and writes a notebook.
Script path:
$JUPYTER_NOTEBOOK_CLI(installed default:{baseDir}/scripts/new_notebook.py)
Temp and output conventions
- Use
tmp/jupyter-notebook/for intermediate files; delete when done. - Write final artifacts under
output/jupyter-notebook/when working in this repo. - Use stable, descriptive filenames (for example,
ablation-temperature.ipynb).
Dependencies (install only when needed)
Prefer uv for dependency management.
Optional Python packages for local notebook execution:
uv pip install jupyterlab ipykernel
The bundled scaffold script uses only the Python standard library and does not require extra dependencies.
Environment
No required environment variables.
Reference map
references/experiment-patterns.md: experiment structure and heuristics.references/tutorial-patterns.md: tutorial structure and teaching flow.references/notebook-structure.md: notebook JSON shape and safe editing rules.references/quality-checklist.md: final validation checklist.
When NOT to Use
<!-- TODO: review -->How can the creator link this skill?
Add the canonical catalog link to the repository README so users can inspect current installs and available audits. The publishing guide covers the complete discovery path.
<a href="https://skillzs.dev/skills/trailofbits/skills-curated/openai-jupyter-notebook">View openai-jupyter-notebook on skillZs</a>