You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+36-1Lines changed: 36 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,6 +12,7 @@ for the frontend extension.
12
12
13
13
-**Command Discovery**: List all available JupyterLab commands with their metadata
14
14
-**Command Execution**: Execute any JupyterLab command programmatically from Python
15
+
-**MCP Integration**: Automatically exposes tools to AI assistants via [jupyter-server-mcp](https://github.com/jupyter-ai-contrib/jupyter-server-mcp)
15
16
16
17
## Requirements
17
18
@@ -25,9 +26,43 @@ To install the extension, execute:
25
26
pip install jupyterlab_commands_toolkit
26
27
```
27
28
29
+
To install with `jupyter-server-mcp` integration support:
30
+
31
+
```bash
32
+
pip install jupyterlab_commands_toolkit[mcp]
33
+
```
34
+
28
35
## Usage
29
36
30
-
Use the toolkit to execute any JupyterLab command from Python:
37
+
### With jupyter-server-mcp (Recommended)
38
+
39
+
This extension automatically registers its tools with [jupyter-server-mcp](https://github.com/jupyter-ai-contrib/jupyter-server-mcp) via Python entrypoints, making them available to AI assistants and other MCP clients.
40
+
41
+
1. Install both packages:
42
+
43
+
```bash
44
+
pip install jupyterlab_commands_toolkit[mcp]
45
+
```
46
+
47
+
2. Start Jupyter Lab (the MCP server starts automatically):
48
+
49
+
```bash
50
+
jupyter lab
51
+
```
52
+
53
+
3. Configure your MCP client (e.g., Claude Desktop) to connect to `http://localhost:3001/mcp`
54
+
55
+
The following tools will be automatically available:
56
+
-`list_all_commands` - List all available JupyterLab commands with their metadata
57
+
-`execute_command` - Execute any JupyterLab command programmatically
58
+
59
+
For more configuration options and examples, see:
60
+
- The included [jupyter_config_mcp_example.py](jupyter_config_mcp_example.py) file
61
+
- The [jupyter-server-mcp documentation](https://github.com/jupyter-ai-contrib/jupyter-server-mcp#readme)
62
+
63
+
### Direct Python Usage
64
+
65
+
Use the toolkit directly from Python to execute JupyterLab commands:
0 commit comments