Server Configuration
Describes the environment variables required to run the server.
| Name | Required | Description | Default |
|---|---|---|---|
| TOKEN | Yes | The token used for authentication with the JupyterLab server. | |
| SERVER_URL | Yes | The URL of the server where JupyterLab is running. | http://localhost:8888 |
| NOTEBOOK_PATH | Yes | The path to the notebook file, relative to the directory where JupyterLab was started. | notebook.ipynb |
Capabilities
Server capabilities have not been inspected yet.
Tools
Functions exposed to the LLM to take actions
| Name | Description |
|---|---|
| list_files | List all files and directories recursively in the Jupyter server's file system. Used to explore the file system structure of the Jupyter server or to find specific files or directories. |
| list_kernels | List all available kernels in the Jupyter server. This tool shows all running and available kernel sessions on the Jupyter server,
including their IDs, names, states, connection information, and kernel specifications.
Useful for monitoring kernel resources and identifying specific kernels for connection. |
| use_notebook | Use a notebook and activate it for following cell operations. All cell operations will be performed on the currently activated notebook. Activate new notebook will deactivate the previously activated notebook. Reactivate previously activated notebook using same notebook_name and notebook_path. |
| list_notebooks | List all notebooks that have been used via use_notebook tool |
| restart_notebook | Restart the kernel for a specific notebook. |
| unuse_notebook | Unuse from a specific notebook and release its resources. |
| read_notebook | Read a notebook and return index, source content, type, execution count of each cell. Using brief format to get a quick overview of the notebook structure and it's useful for locating specific cells for operations like delete or insert.
Using detailed format to get detailed information of the notebook and it's useful for debugging and analysis.
It is recommended to use brief format with larger limit to get a overview of the notebook structure,
then use detailed format with exact index and limit to get the detailed information of some specific cells. |
| insert_cell | Insert a cell to specified position from the currently activated notebook. |
| overwrite_cell_source | Overwrite the source of a specific cell from the currently activated notebook.
It will return a diff style comparison (e.g. |
| execute_cell | Execute a cell from the currently activated notebook with timeout and return it's outputs |
| insert_execute_code_cell | Insert a cell at specified index from the currently activated notebook and then execute it with timeout and return it's outputs It is a shortcut tool for insert_cell and execute_cell tools, recommended to use if you want to insert a cell and execute it at the same time |
| read_cell | Read a specific cell from the currently activated notebook and return it's metadata (index, type, execution count), source and outputs (for code cells) |
| delete_cell | Delete specific cells from the currently activated notebook and return the cell source of deleted cells (if include_source=True). |
| execute_code | Execute code directly in the kernel (not saved to notebook) on the current activated notebook. Recommended to use in following cases:
1. Execute Jupyter magic commands(e.g., `%timeit`, `%pip install xxx`)
2. Performance profiling and debugging.
3. View intermediate variable values(e.g., `print(xxx)`, `df.head()`)
4. Temporary calculations and quick tests(e.g., `np.mean(df['xxx'])`)
5. Execute Shell commands in Jupyter server(e.g., `!git xxx`)
Under no circumstances should you use this tool to:
1. Import new modules or perform variable assignments that affect subsequent Notebook execution
2. Execute dangerous code that may harm the Jupyter server or the user's data without permission |
Prompts
Interactive templates invoked by user choice
| Name | Description |
|---|---|
| jupyter_cite | Like @ or # in Coding IDE or CLI, cite specific cells from specified notebook and insert them into the prompt. |
Resources
Contextual data attached and managed by the client
| Name | Description |
|---|---|
No resources | |