Jupyter MCP Tools



🪐✨ Jupyter MCP工具

](https://pypi.org/project/jupyter-mcp-tools)

](https://github.com/datalayer/jupyter-mcp-tools/actions/workflows/build.yml)

此扩展由一个名为的Python包组成 jupyter_mcp_tools 对于服务器扩展和名为的NPM包 @datalayer/jupyter-mcp-tools 用于前端扩展。

它允许将JupyterLab命令用作MCP工具。


此扩展名由以下人员使用 jupyter mcp服务器 启用JupyterLab命令，例如通过MCP工具打开笔记本电脑。

执行模式

该扩展支持JupyterLab命令的两种执行模式：

本地模式

• 直接执行：命令直接在JupyterLab前端使用内置的命令注册表执行
• 无需网络：无需WebSocket通信即可立即执行
• 用例：在JupyterLab内部测试命令和直接UI交互
• 实施：通话 app.commands.execute() 直接在浏览器中

远程模式

• WebSocket通信：命令通过WebSocket发送到后端服务器扩展
• 外部访问：使外部MCP客户端能够远程执行JupyterLab命令
• 用例：与AI代理和MCP客户端集成，如 jupyter mcp服务器
• 实施：消息通过WebSocket协议传输到后端处理程序

远程模式使此扩展对MCP集成很有价值，它允许AI代理通过标准化协议从JupyterLab环境外部触发Jupyter实验室命令（如打开笔记本电脑、执行单元格等）。

可用工具

这 jupyter-mcp-tools 扩展动态注册 所有可用的JupyterLab命令 作为MCP工具。可用工具的确切列表取决于安装的JupyterLab扩展和当前上下文，但以下是一些常用的工具：

备注：此扩展会自动发现所有JupyterLab命令并将其作为MCP工具提供。命令ID转换自 namespace:command 格式化为 namespace_command 为了MCP兼容性。下面的列表代表了常用的命令，但并不详尽。

核心笔记本命令

控制台命令

文件/文档管理

文件浏览器命令

内核管理

UI/布局命令

细胞类型转换

搜索和替换

终端命令

要查看特定JupyterLab安装中的所有可用工具，您可以打开左侧边栏中的MCP工具面板浏览可用工具。

附加命令

此扩展提供专门为MCP集成设计的自定义JupyterLab命令：

notebook:append-execute

在当前笔记本的末尾添加一个新单元格，其中包含给定的源代码，并可选择执行它。

参数：

• source （string，必填）：要插入单元格的源代码
• type （字符串，可选）：单元格类型- 'code', 'markdown'，或 'raw' （默认值： 'code')

退货：

{
  success: true,
  cellType: 'code',
  cellIndex: 5  // 0-based index of the new cell
}

示例用法：

app.commands.execute('notebook:append-execute', {
  source: 'print("Hello from MCP!")',
  type: 'code'
});

notebook:get-selected-cell

获取笔记本中当前选定/活动单元格的信息，而不执行它。

参数： 无

退货：

{
  success: true,
  cellType: 'code',           // 'code', 'markdown', or 'raw'
  cellIndex: 3,               // 0-based index
  source: 'print("hello")',   // cell content
  metadata: {...},            // cell metadata
  executionCount: 5           // execution count (code cells only, null otherwise)
}

示例用法：

const cellInfo = await app.commands.execute('notebook:get-selected-cell');
console.log(`Cell ${cellInfo.cellIndex}: ${cellInfo.source}`);

注： 该命令仅在笔记本打开时启用，如果未选择单元格，则返回错误对象：

{
  success: false,
  error: 'No active cell'
}

可视化单元格索引

需求

• JupyterLab>=4.0.0

安装

要安装扩展，请执行：

pip install jupyter_mcp_tools

使用

make start

卸载

要删除扩展名，请执行：

pip uninstall jupyter_mcp_tools

故障排除

如果您看到前端扩展，但它不起作用，请检查 服务器扩展已启用：

jupyter server extension list

如果服务器扩展已安装并启用，但您没有看到 前端扩展，检查前端扩展是否已安装：

jupyter labextension list

贡献

开发安装

注意：您需要NodeJS来构建扩展包。

这 jlpm 命令是JupyterLab的固定版本 纱线 它是随JupyterLab一起安装的。您可以使用 yarn 或 npm 代替 jlpm 在......下面

# Clone the repo to your local environment
# Change directory to the jupyter_mcp_tools directory
# Install package in development mode
pip install -e ".[test]"
# Link your development version of the extension with JupyterLab
jupyter labextension develop . --overwrite
# Server extension must be manually installed in develop mode
jupyter server extension enable jupyter_mcp_tools
# Rebuild extension Typescript source after making changes
jlpm build

您可以在不同的终端上同时查看源目录和运行JupyterLab，以查看扩展源代码的更改并自动重建扩展。

# Watch the source directory in one terminal, automatically rebuilding when needed
jlpm watch
# Run JupyterLab in another terminal
jupyter lab

运行watch命令后，每个保存的更改都将立即在本地构建，并在您正在运行的JupyterLab中可用。刷新JupyterLabs以在浏览器中加载更改（您可能需要等待几秒钟才能重建扩展）。

默认情况下 jlpm build 命令为该扩展生成源映射，以便使用浏览器开发工具更容易进行调试。要为JupyterLab核心扩展生成源映射，您可以运行以下命令：

jupyter lab build --minimize=False

开发卸载

# Server extension must be manually disabled in develop mode
jupyter server extension disable jupyter_mcp_tools
pip uninstall jupyter_mcp_tools

在开发模式下，您还需要删除由创建的符号链接 jupyter labextension develop 命令。要找到它的位置，你可以运行 jupyter labextension list 找出在哪里 labextensions 文件夹已找到。然后，您可以删除名为的符号链接 @datalayer/jupyter-mcp-tools 在该文件夹中。

测试扩展

服务器测试

此扩展正在使用 Pytest 用于Python代码测试。

安装测试依赖项（只需要一次）：

pip install -e ".[test]"
# Each time you install the Python package, you need to restore the front-end extension link
jupyter labextension develop . --overwrite

要执行它们，请运行：

pytest -vv -r ap --cov jupyter_mcp_tools

前端测试

此扩展正在使用 玩笑 用于JavaScript代码测试。

要执行它们，请执行：

jlpm
jlpm test

集成测试

此扩展使用 剧作家 用于集成测试（也称为用户级测试）。 更确切地说，JupyterLab助手 加拉塔 用于在JupyterLab中处理扩展测试。

更多信息请参见 ui测试 README。

打包扩展

看 发布