CodeSavant Coding Assistant - 使用说明

项目简介

CodeSavant 是一个基于 Model Context Protocol (MCP) 构建的代码助手服务器。它旨在为 AI 助手提供代码操作、执行和版本控制能力。通过 CodeSavant，AI 助手可以安全地读取、写入和执行代码，并跟踪代码变更历史，从而更有效地辅助软件开发任务。

主要功能点

代码文件读写: 允许 AI 助手读取和修改项目中的代码文件，支持按行操作。
代码执行: 支持在受控环境中执行 Python 和 Node.js 代码，并返回执行结果。
Shell 命令执行: 允许 AI 助手执行 shell 命令，方便进行代码构建、测试等操作。
版本控制: 跟踪代码文件的修改历史，支持回滚到之前的版本。
代码搜索: 支持在代码文件中搜索特定内容。
项目管理: 支持在工作区内创建和管理多个项目，每个项目有独立的代码文件和历史记录。

安装步骤

克隆仓库:

git clone https://github.com/twolven/mcp-codesavant.git
cd mcp-codesavant

安装依赖:

pip install -r requirements.txt

服务器配置

要将 CodeSavant 服务器连接到 MCP 客户端（例如 Claude Desktop），您需要在客户端的配置文件 (通常是 'config.json') 中添加服务器配置信息。以下是一个示例配置，您需要根据实际情况修改 'command' 和 'args' 中的路径：

{
  "mcpServers": {
    "codesavant": {
      "command": "python",
      "args": ["path/to/codesavant.py"]  // 将 "path/to/codesavant.py" 替换为 codesavant.py 脚本的实际路径
    }
  }
}

配置参数说明:

'server name' (配置键名): 'codesavant' (可以自定义服务器名称)
'command': 启动服务器的命令，这里使用 'python' 解释器。
'args': 命令参数，这里指定了 'codesavant.py' 脚本的路径。请务必将 '"path/to/codesavant.py"' 替换为 'codesavant.py' 文件在您本地文件系统中的绝对路径或相对路径 (相对于客户端配置文件)。 例如，如果 'codesavant.py' 与 'config.json' 在同一目录下，则可以使用 '["./codesavant.py"]'。

基本使用方法

启动服务器: 在克隆的 'mcp-codesavant' 目录下，确保已安装依赖，然后在终端中运行 'python codesavant.py' 即可启动服务器。服务器将监听标准输入和输出 (stdio) 以接收和发送 MCP 消息。
配置 MCP 客户端: 根据上述 "服务器配置" 部分的说明，配置您的 MCP 客户端，例如 Claude Desktop，使其能够连接到 CodeSavant 服务器。
通过客户端调用工具: 一旦客户端成功连接到服务器，您就可以在客户端中使用自然语言指令来调用 CodeSavant 提供的工具，例如读取代码文件、执行代码等。具体的工具名称和参数请参考仓库 README.md 中的 "Tool Reference" 部分。例如，要读取项目 "my_project" 中路径为 "main.py" 的代码文件，您可以使用类似以下的工具调用请求 (JSON 格式):
```
{
  "tool_call": {
    "tool_name": "read_code_file",
    "tool_arguments": {
      "project": "my_project",
      "path": "main.py"
    }
  }
}
```
客户端会将此类请求通过 MCP 协议发送到 CodeSavant 服务器，服务器执行相应的操作并将结果返回给客户端。

关键词