swarmauri_tool_jupytergetshellmessage 0.9.3.dev5

A tool designed to retrieve shell messages from a running Jupyter kernel using jupyter_client, useful for debugging execution responses.

---

Swarmauri Tool Jupyter Get Shell Message

Retrieves shell-channel messages from a running Jupyter kernel using jupyter_client.

Features

• Listens on the Jupyter kernel shell channel and captures raw message dicts.
• Returns a dict containing messages or an error key.
• Helpful for debugging live kernel communication during automated notebook workflows.

Prerequisites

• Python 3.10 or newer.
• Access to a running Jupyter kernel (Notebook server, JupyterLab, etc.).
• jupyter_client and websocket-client (installed automatically).

Installation

# pip
pip install swarmauri_tool_jupytergetshellmessage

# poetry
poetry add swarmauri_tool_jupytergetshellmessage

# uv (pyproject-based projects)
uv add swarmauri_tool_jupytergetshellmessage

Quickstart

from swarmauri_tool_jupytergetshellmessage import JupyterGetShellMessageTool

channels_url = "ws://localhost:8888/api/kernels/<kernel-id>/channels"
result = JupyterGetIOPubMessageTool()(channels_url, timeout=5.0)

if "messages" in result:
    for msg in result["messages"]:
        print(msg)
else:
    print("Error:", result.get("error"))

Tips

• Ensure you pass the correct kernel channels URL (including security tokens/cookies if your server requires them).
• Increase timeout if you expect long-running cells before shell replies are sent.
• Combine with notebook execution tools to capture both SHELL and IOPub messages for full observability.

Want to help?

If you want to contribute to swarmauri-sdk, read up on our guidelines for contributing that will help you get started.