使用说明

项目简介

UltimateCoder MCP 是一个本地优先的代码自动化服务器，基于 Model Context Protocol (MCP) 构建。它旨在将您的本地机器转变为强大的代码命令中心，通过标准化的 MCP 协议，为 LLM 客户端（如 Claude Desktop 等）提供安全、实时的本地文件系统、进程管理和代码操作能力。UltimateCoder MCP 基于 'fastmcp' 框架构建，专注于提供快速、安全、可扩展的本地自动化服务，无需云端延迟，数据不出本地，保障您的数据安全。

主要功能点

文件系统操作: 支持读取、写入、创建、删除、移动文件和目录，获取文件元信息，批量文件处理等，让 AI 能够安全地操作本地文件系统。
代码编辑: 提供精确的代码编辑工具，包括按行替换、块替换、应用 Diff Patch 等功能，支持 AI 精准修改代码。
进程管理: 允许列出和终止本地进程，方便自动化脚本和 AI 进行进程管理。
代码搜索: 集成 Ripgrep 引擎，提供快速、强大的代码搜索能力，支持文件内容和文件名搜索。
代码质量: 内置 JSON 和 Python 代码的 Linting 和静态分析工具，帮助 AI 进行代码质量检查。
本地命令执行: 可以执行任何本地 Shell 命令，并将结果返回给客户端，扩展 AI 的操作能力。
Prompt 模板: 内置多种 Prompt 模板，优化与 LLM 的交互，例如代码审查、错误调试、架构设计等。

安装步骤

克隆仓库

git clone https://github.com/m-ahmed-elbeskeri/UltimateCoderMCP.git
cd UltimateCoderMCP

运行服务器

确保您的系统已安装 Python 3.8 或更高版本。在仓库根目录下，执行以下命令启动 MCP 服务器：
```
python main.py
```
服务器成功启动后，将会在本地运行并等待 MCP 客户端连接。

服务器配置

MCP 客户端需要配置以下 JSON 信息才能连接到 UltimateCoder MCP 服务器。以下是一个配置示例，您可以根据您的 MCP 客户端进行配置：

{
  "serverName": "UltimateCoderMCP",  // MCP 服务器的名称，与 main.py 中 FastMCP 实例化的名称一致
  "command": "python",             // 启动 MCP 服务器的命令，这里使用 python
  "args": ["main.py"]              // 启动命令的参数，这里指定 main.py 为入口文件
}

配置说明:

'serverName': 服务器名称，必须与 'main.py' 文件中 'FastMCP("UltimateCoder", ...)' 实例化的名称 "UltimateCoder" 一致。客户端通过此名称识别服务器。
'command': 启动服务器的可执行命令。由于 UltimateCoderMCP 是 Python 应用，这里使用 'python' 命令来运行。
'args': 传递给启动命令的参数列表。这里指定 'main.py' 为 Python 脚本的入口文件，启动 UltimateCoderMCP 服务器。

请将以上 JSON 配置信息填入您的 MCP 客户端配置中，通常客户端会要求您提供服务器的启动命令和参数。

基本使用方法

UltimateCoder MCP 服务器运行后，您可以使用任何兼容 MCP 协议的客户端（例如 Claude Desktop 或其他自定义 MCP 客户端）与之连接。客户端通过 JSON-RPC 协议向服务器发送请求，调用服务器提供的工具 (Tools)、资源 (Resources) 和 Prompt 模板 (Prompts)。

使用流程示例:

启动 UltimateCoder MCP 服务器：在终端中运行 'python main.py'。
配置 MCP 客户端: 将上述服务器配置 JSON 信息填入 MCP 客户端的服务器配置中。
客户端发起请求: 在 MCP 客户端中，您可以选择并调用 UltimateCoder MCP 服务器提供的各种功能，例如：
- 使用 'tool_read_file' 读取本地文件内容。
- 使用 'tool_run_command' 执行 Shell 命令。
- 使用 'prompt://review_code' Prompt 模板生成代码审查 Prompt。
服务器响应: UltimateCoder MCP 服务器接收到客户端请求后，执行相应的操作，并将结果以 JSON-RPC 响应的形式返回给客户端。

具体可用的工具 (Tools) 和 Prompt 模板 (Prompts) 可以在 'main.py' 文件中查看，每个工具和 Prompt 都有详细的文档说明。您可以根据您的需求，在 MCP 客户端中灵活调用这些功能，实现各种代码自动化和 AI 辅助开发场景。

关键词