使用说明

项目简介

Elroy 是一个基于命令行的、可脚本化的人工智能个人助理。它不仅具备长期记忆、目标跟踪等核心功能,还实现了实验性的 MCP (Model Context Protocol) 服务器,可以将 Elroy 的对话记忆等资源暴露给其他兼容 MCP 协议的工具或客户端,实现更强大的 AI 应用集成和扩展能力。

主要功能点

  • 长期记忆: 自动回忆过去的对话,让AI助手拥有上下文连贯的记忆。
  • 目标跟踪: 帮助用户跟踪和管理个人或专业目标。
  • 简单脚本接口: 通过简洁的脚本界面即可扩展 Elroy 的功能。
  • CLI 工具接口: 方便用户快速回顾记忆或记录笔记。
  • MCP 服务器: 通过 MCP 协议将对话记忆等资源共享给其他工具或客户端 (实验性功能)。

安装步骤

Elroy 提供了多种安装方式,最快速的方式是使用安装脚本,或者使用 'uv pip install elroy' 命令进行手动安装。

快速安装脚本 (推荐)

curl -LsSf https://raw.githubusercontent.com/elroy-bot/elroy/main/scripts/install.sh | sh

手动安装 (使用 uv)

首先确保已安装 'uv' (可以使用 'curl -LsSf https://astral.sh/uv/install.sh | sh' 安装 uv),然后执行:

uv pip install elroy

更多安装方式 (Docker, 源码安装) 请参考 官方安装文档

服务器配置

Elroy 的 MCP 服务器配置信息可以通过命令 'elroy mcp print-config' 获取。该命令会输出 JSON 格式的配置信息,您可以将其复制粘贴到 MCP 客户端的服务器配置中。

MCP 客户端配置示例 (JSON 格式):

{
  "serverName": "elroy-mcp-server",
  "command": "elroy",
  "args": ["mcp", "print-config"],
  "transport": "stdio"
}

配置参数说明:

  • 'serverName': MCP 服务器的名称,可以自定义。例如 '"elroy-mcp-server"'。
  • 'command': 启动 MCP 服务器的命令。 这里设置为 '"elroy"',表示直接调用 elroy 命令行工具。
  • 'args': 传递给启动命令的参数。 '["mcp", "print-config"]' 表示调用 elroy 的 'mcp print-config' 子命令,用于获取服务器配置。 注意:实际客户端连接时,可能需要将 'args' 修改为 '["mcp", "serve"]' 或其他服务器启动命令,具体请参考 Elroy 官方文档关于 MCP 服务器的配置说明。 当前 'print-config' 参数用于获取配置信息,客户端建立连接可能需要服务器运行在 'serve' 模式或其他模式下。
  • 'transport': MCP 客户端与服务器通信的传输协议。 '"stdio"' 表示使用标准输入输出流进行通信,这是 CLI 应用常用的方式。

基本使用方法

  1. 启动 Elroy 命令行界面: 安装完成后,在终端中运行 'elroy' 或 'elroy chat' 命令,即可进入 Elroy 的聊天界面。您可以通过自然语言与 Elroy 进行对话,利用其记忆和目标管理功能。

  2. 获取 MCP 服务器配置: 运行 'elroy mcp print-config' 命令,复制输出的 JSON 配置信息。

  3. 配置 MCP 客户端: 将上一步获取的 JSON 配置信息粘贴到您的 MCP 客户端的服务器配置中。 请注意,您可能需要根据 MCP 客户端的具体要求调整 'args' 参数,以确保客户端能够成功连接到 Elroy 的 MCP 服务器。 详细的服务器启动命令,请查阅 Elroy 官方文档中关于 MCP 服务器的章节。

  4. 使用 MCP 客户端连接 Elroy: 启动您的 MCP 客户端,它将根据您提供的配置信息连接到 Elroy 的 MCP 服务器,并可以开始利用 Elroy 提供的资源 (例如对话记忆) 和工具。

注意: Elroy 的 MCP 服务器支持目前标记为实验性,使用中可能遇到问题,建议关注官方文档和社区反馈。

信息

分类

AI与计算