关键词

代码助手LLM工具文件系统访问Shell命令Git操作文本搜索

使用说明

项目简介

Volition 是一组基于 Model Context Protocol (MCP) 的工具服务器，旨在为LLM客户端提供文件系统访问、Shell命令执行、Git操作和文本搜索等能力。这些服务器可以独立运行，并通过标准MCP协议与LLM客户端通信，从而扩展LLM的功能。

主要功能点

  • 文件系统访问: 提供读取和写入本地文件系统的工具，使LLM能够与文件进行交互。
  • Shell命令执行: 允许LLM安全地执行Shell命令，并获取命令输出，扩展LLM的系统操作能力。
  • Git版本控制: 提供常用的Git操作工具，例如查看Git状态、差异等，帮助LLM理解和操作代码仓库。
  • 文本搜索: 集成文本搜索工具，使LLM能够在指定的目录或文件中查找文本模式，方便代码分析和理解。
  • MCP协议支持: 完全遵循 Model Context Protocol 标准，易于集成到任何兼容 MCP 协议的 LLM 客户端。

安装步骤

  1. 安装 Rust 工具链: 确保您的系统已安装 Rust toolchain (版本 1.70 或更高)。您可以访问 https://www.rust-lang.org/tools/install 获取安装指导。

  2. 克隆仓库: 打开终端，执行以下命令克隆 Volition 仓库到本地：

    git clone https://github.com/jessebmiller/volition.git

  3. 进入仓库目录: 使用 'cd' 命令进入克隆下来的仓库目录：

    cd volition

  4. 构建项目: 在仓库根目录下，使用 'cargo build' 命令构建项目。为了获得更好的性能，建议使用 '--release' 参数进行 release 构建：

    cargo build --release

    构建完成后，服务器程序的可执行文件将位于 'target/release/' 目录下。例如，文件系统服务器的可执行文件是 'target/release/volition-filesystem-server'。

服务器配置

MCP 客户端需要配置 MCP 服务器的启动信息才能建立连接。以下是一个典型的配置示例 (JSON 格式)，客户端需要根据实际情况进行配置：

{
  "server_name": "filesystem",
  "command": "/path/to/volition-filesystem-server",
  "args": []
}

配置参数说明:

  • server_name: 服务器名称，用于在客户端配置中标识不同的 Volition MCP 服务器实例。例如，您可以为文件系统服务器命名为 "filesystem"，为 Shell 服务器命名为 "shell"。常用的服务器名称包括: '"filesystem"', '"shell"', '"git"', '"search"'。
  • command: MCP 服务器可执行文件的路径。请根据您的实际情况，填写 Volition MCP 服务器可执行文件的绝对路径。例如，如果 'volition-filesystem-server' 可执行文件位于 'target/release/' 目录下，则 'command' 应配置为 '"/path/to/volition/target/release/volition-filesystem-server"'。
  • args: 启动服务器的命令行参数。对于 Volition MCP 服务器，通常情况下 'args' 字段配置为空数组 '[]' 即可。如有特殊需求，请参考具体服务器的文档。

配置多个服务器:

如果需要同时使用多个 Volition MCP 服务器提供的工具（例如同时使用文件系统工具和 Shell 工具），您需要在 MCP 客户端配置中添加多个服务器配置项，每个配置项对应一个 Volition MCP 服务器实例，并使用不同的 'server_name' 进行区分。

基本使用方法

  1. 启动 MCP 服务器: 在终端中，导航到 Volition 仓库的 'target/release/' 目录，然后根据需要启动相应的 MCP 服务器。例如，启动文件系统服务器，可以执行：

    ./volition-filesystem-server

    启动 Shell 服务器，可以执行：

    ./volition-shell-server

    启动 Git 服务器，可以执行：

    ./volition-git-server

    启动 搜索 服务器，可以执行：

    ./volition-search-server

    服务器启动后，通常会在终端输出 "Starting ..." 或类似的启动信息，表明服务器已准备好接受客户端连接。

  2. 配置 MCP 客户端: 在您的 MCP 客户端软件中，根据其使用说明，配置 Volition MCP 服务器的连接信息。您需要提供服务器名称 (server_name)、服务器可执行文件的路径 (command) 和启动参数 (args) 等信息。

  3. 使用工具: 连接成功后，您可以在 MCP 客户端中使用 Volition MCP 服务器提供的工具。具体的工具调用方法和参数，请参考 MCP 客户端软件的使用说明以及 Volition MCP 服务器提供的工具列表和描述信息。

注意: Volition MCP 服务器启动后，会通过标准输入输出 (stdio) 与 MCP 客户端进行通信。请确保您的 MCP 客户端配置正确，并且服务器进程保持运行状态。

信息

分类

开发者工具

访问项目