关键词

代码编辑文件访问Git操作智能助手LLM工具

使用说明

项目简介

OpenCoder 是一个开源的编码 Agent，它使用 Model Context Protocol (MCP) 协议，使得大型语言模型 (LLM) 能够安全地访问和操作本地文件系统以及执行 Git 命令。它旨在为 LLM 提供与代码库进行交互的工具，从而增强代码生成、编辑和理解的能力。

主要功能点

  • 文件系统访问: 允许 LLM 读取和编辑项目目录中指定路径下的文件。
  • Git 集成: 支持 LLM 执行常见的 Git 操作，如查看状态、日志、分支、提交、差异和拉取代码等。
  • 工具扩展: 基于 MCP 协议，可以方便地扩展更多工具，例如数据库操作、Web 浏览等。
  • 安全控制: 通过路径验证，限制 LLM 只能访问预设目录下的文件，保障安全性。
  • 灵活配置: 通过 '.rc' 和 'mcp.json' 文件进行模型选择、API 密钥和 MCP 服务器配置。

安装步骤

  1. 确保已安装 Python 环境。
  2. 使用 pip 安装 OpenCoder: 
    pip install opencoder
  3. 初始化 OpenCoder 项目配置，在你的项目根目录下运行： 
    opencoder init

服务器配置

MCP 服务器的配置信息在 '.opencoder/mcp.json' 文件中定义。默认配置包含一个名为 "shell" 的服务器，用于执行文件和 Git 操作。你可以根据需要修改或添加更多服务器配置。

以下是默认的 'mcp.json' 示例配置：

{
  "shell": {
    "command": "python",
    "args": ["src/opencoder/mcp_server.py"]
  }
}

配置参数说明：

  • 'shell': 服务器名称，可以自定义。
    • 'command': 启动 MCP 服务器的命令。这里使用 'python' 解释器。
    • 'args': 命令参数，指定 'mcp_server.py' 脚本的路径。该脚本是 OpenCoder 内置的 MCP 服务器实现，提供了文件和 Git 工具。

注意: 'command' 和 'args' 字段定义了如何启动 MCP 服务器进程。客户端（OpenCoder Agent）会根据这些配置连接到服务器并使用其提供的工具。用户无需手动配置 MCP 客户端与服务器的连接细节，OpenCoder 已经处理了这些底层通信。

基本使用方法

  1. 配置 API 密钥: 编辑项目根目录下的 '.opencoder/.rc' 文件，配置你使用的 LLM 模型的 API 密钥，例如 OpenAI API Key 或 OpenRouter API Key，并选择合适的模型。
  2. 启动 Agent: 在项目根目录下，运行 'opencoder gen' 命令启动 OpenCoder Agent。Agent 会加载配置并连接到 MCP 服务器。
  3. 与 Agent 交互: Agent 启动后，你可以在终端中输入自然语言指令。Agent 会根据你的指令，利用 LLM 和 MCP 服务器提供的工具来完成任务，例如读取文件内容、编辑文件或执行 Git 命令。

例如，你可以指示 Agent 读取某个文件的内容，或者要求 Agent 提交当前代码的更改。Agent 会通过 MCP 服务器调用相应的工具来执行这些操作，并将结果返回给你。

opencoder gen

信息

分类

开发者工具

访问项目