项目简介

Livebook Tools 是一个旨在增强 Livebook 开发体验的命令行工具,核心功能之一是提供 MCP (Model Context Protocol) 服务器。该服务器允许 AI 编码助手(如 Cursor)连接到您的 Livebook 会话,从而利用 Livebook 的强大功能进行代码编写和探索。通过 MCP 服务器,AI 助手可以访问 Livebook 环境中的资源和工具,实现更智能的代码补全、重构和调试等功能。

主要功能点

  • MCP 服务器: 实现了 Model Context Protocol 服务器,使得 AI 编码助手能够与 Livebook 会话交互。
  • BYOE (自带编辑器): 支持将 '.livemd' 文件同步到 Livebook,方便在您喜欢的代码编辑器中编辑 Livebook 内容。
  • 命令行运行 Livebook: 可以将 '.livemd' 文件转换为 Elixir 脚本并直接在命令行中运行,方便自动化任务。

安装步骤

  1. 安装 Livebook Tools: 使用 Elixir 的 'mix escript.install' 命令进行安装。
    mix escript.install github thmsmlr/livebook_tools
  2. 配置 PATH 环境变量: 确保 escript 安装目录已添加到您的 PATH 环境变量中,这样才能在命令行中直接运行 'livebook_tools' 命令。根据您的 Elixir 安装方式,可能需要配置 '~/.mix/escripts' 或 ASDF 管理的 Elixir escripts 目录。
    # 例如 (针对普通 Elixir 用户)
    export PATH="$HOME/.mix/escripts:$PATH"
  3. 配置 Livebook 连接: 为了让 Livebook Tools 能够连接到您的 Livebook 服务器,需要设置 'LIVEBOOK_NODE' 和 'LIVEBOOK_COOKIE' 环境变量。这些变量需要与您运行 Livebook 服务器时使用的配置一致。
    export LIVEBOOK_NODE="[email protected]" # Livebook 节点名称
    export LIVEBOOK_COOKIE="secret"        # Livebook Cookie

服务器配置 (MCP 客户端配置)

要将 MCP 客户端(例如 Cursor)连接到 Livebook Tools 提供的 MCP 服务器,您需要在客户端中配置以下连接信息。

{
  "serverName": "LivebookTools MCP Server",
  "command": "livebook_tools",
  "args": ["mcp"]
}
  • 'serverName': 为您的 MCP 服务器连接自定义一个名称,方便在客户端中识别。
  • 'command': 启动 Livebook Tools MCP 服务器的命令,设置为 'livebook_tools'。
  • 'args': 传递给 'livebook_tools' 命令的参数,这里使用 'mcp' 参数来指定启动 MCP 服务器模式。

基本使用方法

  1. 启动 Livebook 服务器: 首先确保您的 Livebook 服务器正在运行,并且配置了与 Livebook Tools 相同的 'LIVEBOOK_NODE' 和 'LIVEBOOK_COOKIE' 环境变量。
  2. 配置 MCP 客户端: 在您的 MCP 客户端(如 Cursor)中,按照上述 “服务器配置 (MCP 客户端配置)” 部分填写连接信息。
  3. 连接 MCP 服务器: 在 MCP 客户端中发起连接 MCP 服务器的操作。客户端会通过 STDIO 运行 'livebook_tools mcp' 命令,Livebook Tools 将作为 MCP 服务器启动并与客户端建立连接。
  4. 在 AI 助手中使用: 连接成功后,您就可以在 AI 编码助手中体验与 Livebook 上下文联动的代码编辑功能了。

信息

分类

开发者工具