code-editor-mcp 0.2.5

code-editor

面向多客户端并发、安全沙箱、编码感知的代码编辑 MCP 服务器。

路径访问更新：所有参数必须是绝对路径。除 read_files 外，其余文件/目录工具仍校验是否落在允许目录列表内。CODE_EDIT_ROOT 只是安全标记，不做访问边界或相对路径解析；访问新目录请用 config_ops(action="set_root", path="...") 加入允许列表。

安装与运行

# 安装（pip 或 uv 均可，包名 code-editor-mcp）
pip install code-editor-mcp         # 或 uv pip install code-editor-mcp

# 更新最新版
pip install -U code-editor-mcp

# 直接启动 CLI 入口
code-editor

# 若从源码运行
uv sync
uv run python server.py

关键环境变量：

• CODE_EDIT_ROOT：安全标记（默认启动时的 CWD），不做访问边界，也不参与相对路径解析。
• CODE_EDIT_ALLOWED_ROOTS_FILE：允许目录持久化 JSON，默认 tools/.code_edit_roots.json。
• CODE_EDIT_ALLOWED_DIRECTORIES：逗号分隔允许目录列表（兼容旧的 CODE_EDIT_ALLOWED_ROOTS）。

环境变量一览：

设计要点

• 允许目录列表：默认允许用户主目录；路径需落在允许目录内，否则拒绝。config_ops(action="set_root") 仅将目录加入允许列表并更新安全标记，不做路径拼接。
• 持久允许目录：config_ops(action="set_root") 成功后写入 JSON，可跨会话复用。
• 乐观锁：写/删类支持秒或纳秒级 expected_mtime，10ms 容忍；写入走原子写避免部分落盘。
• 默认忽略：.git、__pycache__、node_modules、.DS_Store、.env*、.venv、*.log、*.pem；ignore_patterns 传空字符串/空列表可关闭默认忽略。
• 编码感知：read_files v2 默认逐文件 auto 检测/复用编码（基于最新 mtime 刷新的元信息缓存）；如自动结果乱码，可在每个 request 里显式传 encoding 覆盖。
• 安全删除：禁止删除当前根/其祖先/关键系统目录。

MCP 工具（code-editor）

文件系统工具

dir_ops 参数要点（避免误调用）

• create：仅 dir_path 必须；其余参数会被忽略。
• list：format 仅支持 tree/flat；max_items 必须为正整数或 None。
• delete：必须同时提供 expected_mtime、confirm_token、allow_nonempty（显式 True/False）。
• 删除行为统一移动到回收站，不支持永久删除。
• 命中高风险规则时会返回 status=needs_approval，响应内包含 approval_token 与 llm_instruction。
• 盘符根目录（如 C:\ / D:\ / E:\）会被永久阻断并返回 status=blocked_critical。
• confirm_token 生成规则（严格匹配）：

from pathlib import Path
import os

normalized = os.path.normcase(str(Path(dir_path).resolve()))
confirm_token = f"delete:{normalized}"

代码精准编辑工具

edit_blocks 返回格式（v0.3.0+）

edit_blocks 返回结构化数据，包含修改位置信息便于验证：

# edit_blocks（单编辑）返回示例
{
    "status": "success",
    "message": "Applied 2 edit(s) to /path/file.py (lines 10-12, 20-25)",
    "file_path": "/path/file.py",
    "replacements": 2,
    "locations": [
        {"start_line": 10, "end_line": 12, "start_col": 5, "end_col": 20},
        {"start_line": 20, "end_line": 25, "start_col": 1, "end_col": 15}
    ]
}

# edit_blocks（批量）返回示例
{
    "status": "success",  # success/partial/error
    "message": "Completed 3/3 edits",
    "total_edits": 3,
    "successful_edits": 3,
    "failed_edits": 0,
    "results": [
        {"status": "success", "file_path": "...", "replacements": 1, "locations": [...], "message": "..."},
        {"status": "success", "file_path": "...", "replacements": 1, "locations": [...], "message": "..."},
        {"status": "success", "file_path": "...", "replacements": 1, "locations": [...], "message": "..."}
    ]
}

使用示例

• 查看并新增允许目录：config_ops(action="list_roots") → 若未包含目标，调用 config_ops(action="set_root", path="/data/project")。
• 带锁写入：info = config_ops(action="get_info", path="/abs/path/src/app.py") → file_ops(action="write", file_path="/abs/path/src/app.py", content=content, expected_mtime=info["modified"])。
• 精确替换（单编辑）：edit_blocks(edits={"file_path":"/abs/path/src/app.py","old_string":"old","new_string":"new","expected_replacements":1,"expected_mtime":info["modified"]})。
• 单文件片段读取（range，行号 1-based）：

read_files([
  {"path": "/abs/path/src/app.py", "mode": "range", "start_line": 10, "line_count": 60}
])

• 同文件多片段 + 跨文件（一次拿齐，减少多次调用）：

read_files([
  {"path": "/abs/path/src/app.py", "mode": "range", "start_line": 1, "line_count": 80, "id": "app_head"},
  {"path": "/abs/path/src/app.py", "mode": "range", "start_line": 200, "line_count": 80, "id": "app_mid"},
  {"path": "/abs/path/README.md", "mode": "range", "start_line": 1, "line_count": 120, "id": "readme"},
], max_total_chars=200000, parallelism=4)

• 分页读取整文件（all + cursor）：

resp1 = read_files([{"path": "/abs/path/src/app.py", "mode": "all"}], page_line_count=400)
cursor = resp1["results"][0].get("next_cursor")
resp2 = read_files([{"cursor": cursor}], page_line_count=400)  # 继续下一页

• 批量编辑（同文件多处修改）：

edit_blocks(edits=[
    {"file_path": "/abs/app.py", "old_string": "foo", "new_string": "bar"},
    {"file_path": "/abs/app.py", "old_string": "hello", "new_string": "world"},
], error_policy="rollback")

• 批量编辑（多文件）：

edit_blocks(edits=[
    {"file_path": "/abs/a.py", "old_string": "v1", "new_string": "v2"},
    {"file_path": "/abs/b.py", "old_string": "v1", "new_string": "v2"},
], error_policy="continue")

• 批量转码：convert_file_encoding(["/abs/a.txt", "/abs/b.txt"], "gb2312", "utf-8", error_handling="replace", mismatch_policy="warn-skip")。
• 列目录（扁平）：dir_ops(action="list", dir_path="/abs/path", format="flat", ignore_patterns=[".git", "node_modules"])。
• 删除目录（显式确认，统一进回收站）：info = config_ops(action="get_info", path="/abs/path") → normalized = os.path.normcase(str(Path("/abs/path").resolve())) → token = f"delete:{normalized}" → dir_ops(action="delete", dir_path="/abs/path", expected_mtime=info["modified"], confirm_token=token, allow_nonempty=True)。
• 高风险删除二次审批：首次调用 delete 可能返回 status=needs_approval + approval.approval_token，拿到用户明确同意后，带上 approval_token 再次调用同一 delete。

MCP 客户端快速配置示例

{
  "mcpServers": {
    "code-editor": {
      "command": "code-editor",
      "env": {
        "CODE_EDIT_ROOT": "."
      }
    }
  }
}

[mcp_servers.code-editor]
command = "code-editor"
# 将工作目录指向当前项目,使 CODE_EDIT_ROOT 默认跟随启动时的 CWD
cwd = "."
startup_timeout_sec = 120

安全/行为提示

• 路径验证：除 read_files 外，其他操作要求绝对路径且落在允许目录列表内；read_files 仅要求绝对路径；CODE_EDIT_ROOT 仅为安全标记。
• 删除防护：删除只允许移动到回收站；任何失败都会直接拒绝（不会降级为永久删除）。
• 盘符根目录阻断：C:\、D:\、E:\（及其他文件系统根目录）会被永久阻断，并返回极高风险警告。
• 二次审批：仅“重要目录 + 大规模删除”触发；返回会强制提示模型先询问用户并等待批准。
• 允许目录管理：如需访问新路径，先 config_ops(action="set_root") 加入白名单；不在白名单的绝对路径会被拒绝。