使用说明

项目简介

mcp-server-code-assist 是一个基于 Model Context Protocol (MCP) 构建的服务器，专门为代码编辑和辅助场景设计。它提供了一系列工具，允许大型语言模型（LLM）通过标准化的MCP协议与本地文件系统和Git仓库进行交互，从而实现代码的创建、修改、查询以及版本控制等功能。

主要功能点

文件操作：支持创建、读取、修改、重写和删除文件。
目录操作：支持列出目录内容和创建新目录。
Git操作：支持查看Git仓库状态、差异、日志和提交详情。
工具化设计：所有功能都以 MCP 工具的形式暴露，方便 LLM 客户端调用。
Prompt 模板：包含用于高级 Git 操作的 Prompt 模板，支持更复杂的交互场景。
可配置路径：可以配置允许操作的工作目录，保障安全性。

安装步骤

推荐使用 uv (ultravenv)

uvx mcp-server-code-assist

或者使用 pip

pip install mcp-server-code-assist
python -m mcp_server_code_assist

服务器配置

以下是在 MCP 客户端中配置 'mcp-server-code-assist' 服务器的示例。您需要根据您使用的 MCP 客户端 (如 Claude Desktop, Zed 等) 的具体配置方法进行设置。

Claude Desktop 配置示例 (使用 uvx 命令启动服务器)

"mcpServers": {
  "code-assist": {
    "serverName": "code-assist",  // 服务器名称，可以自定义
    "command": "uvx",             // 启动服务器的命令，这里使用 uvx
    "args": ["mcp-server-code-assist"] // 命令参数，指定要运行的 MCP 服务器
  }
}

Zed 编辑器配置示例 (使用 uvx 命令启动服务器)

"context_servers": {
  "mcp-server-code-assist": {
    "serverName": "mcp-server-code-assist", // 服务器名称，可以自定义
    "command": {
      "path": "uvx",         // 启动服务器的命令路径，这里使用 uvx
      "args": ["mcp-server-code-assist"] // 命令参数，指定要运行的 MCP 服务器
    }
  }
},

注意：

'serverName' 可以自定义，用于在客户端中标识和引用该服务器。
'command' 和 'args' 必须根据实际安装和环境配置进行调整。上述示例假设 'uvx' 命令可用，并且 'mcp-server-code-assist' 已正确安装。
如果使用 'pip' 安装，'command' 则应配置为 Python 解释器路径，'args' 配置为 '-m mcp_server_code_assist'。

基本使用方法

启动 'mcp-server-code-assist' 服务器。
在您的 MCP 客户端（如 Claude Desktop 或 Zed）中配置并连接到 'mcp-server-code-assist' 服务器。
在客户端中，LLM 可以通过调用 'mcp-server-code-assist' 提供的工具来执行代码相关的操作，例如：
- 使用 'read_file' 工具读取文件内容。
- 使用 'modify_file' 工具修改文件内容。
- 使用 'git_status' 工具查看 Git 仓库状态。
- 更多工具和详细使用方法请参考项目文档或源代码。

关键词