使用说明

项目简介

Egent 旨在作为工程师团队和 AI Agent 之间的桥梁，通过 Model Context Protocol (MCP) 协议向 Agent 提供结构化的上下文信息和可执行的任务流程。它主要用于辅助 Agent 自动化完成代码开发任务，例如代码重构、API 升级、依赖升级和 Go 版本升级等。通过 Egent，工程师可以将经验知识、任务流程和工具整合起来，赋能 AI Agent 更智能地执行复杂任务。

主要功能点

资源管理：
- 知识库 (Knowledge)：托管和管理 Markdown 格式的知识库资源，Agent 可以访问这些知识库获取项目架构、编码规范、发布流程等信息。知识库文件存储在仓库的 '/knowledge' 目录下。
- 任务模板 (Task Template)：托管和管理 Markdown 格式的任务模板资源，定义 Agent 可以执行的标准化任务流程，例如 “Tiny refactor” 和 “Hive API Upgrade”。任务模板文件存储在仓库的 '/task-templates' 目录下。
- 启动指令 (Start Instructions)：提供固定的启动指令资源 ('start.md')，作为 Agent 执行任务的初始指导。
Prompt 模板：
- 启动任务 Prompt (start_task)：定义了 'start_task' Prompt 模板，接收用户提供的任务描述，并结合启动指令，生成用于指导 Agent 执行任务的 Prompt。
基于文件系统：所有资源（知识库、任务模板、启动指令）均以 Markdown 文件形式存储在本地文件系统中，方便工程师编辑和管理。
Stdio 传输协议：使用标准输入输出 (Stdio) 作为 MCP 服务器的传输协议，简化部署和集成。

安装步骤

前提条件：确保已安装 Node.js 和 npm (Node 包管理器)。

克隆仓库：将 Egent 仓库克隆到本地：

git clone https://github.com/xuezhaojun/egent.git

进入目录：进入克隆的仓库目录：
```
cd egent
```
安装依赖：使用 npm 安装项目依赖：
```
npm install
```
构建项目：构建 TypeScript 项目到 JavaScript：
```
npm run build
```

服务器配置

MCP 客户端 (如 Cursor) 需要配置以下 JSON 信息以连接到 Egent MCP 服务器。

{
  "serverName": "Egent",
  "command": "node",
  "args": [
    "build/index.js"
  ],
  "description": "启动 Egent MCP 服务器，使用 Node.js 运行 build 目录下的 index.js 文件，通过标准输入输出与 MCP 客户端进行通信。"
}

配置参数说明：

'serverName': MCP 服务器的名称，这里设置为 "Egent"。
'command': 启动服务器的命令，这里使用 'node' 命令来运行 JavaScript 文件。
'args': 传递给 'command' 的参数数组。
- '"build/index.js"': 指定要运行的服务器入口文件路径。
'description': 对该服务器配置的简要描述，方便用户理解其用途。

基本使用方法

启动服务器：在 MCP 客户端中配置上述服务器配置信息后，客户端会自动启动 Egent MCP 服务器。
配置工作区：在仓库根目录下创建 '/workspace' 文件夹，并将需要 Agent 处理的代码仓库克隆到 '/workspace' 目录下。
准备上下文：
- 将知识库文档（Markdown 格式）放入 '/knowledge' 目录下的子目录中，例如按主题或类别组织。
- 创建任务模板文档（Markdown 格式）并放入 '/task-templates' 目录，定义 Agent 可以执行的任务流程。
- 编辑 'start.md' 文件，配置 Agent 的初始指令和行为准则。
发起任务：在 MCP 客户端中，可以使用集成了 MCP 协议的 Agent 工具（如 Cursor 的 Agent 模式），通过 Prompt 触发 'start_task'，并提供任务描述。Agent 将根据 'start.md' 的指令和匹配的任务模板执行任务。
查看工作日志：Agent 的执行计划、操作记录和总结报告会保存在 '/worklogs' 目录下，方便用户监控 Agent 的工作状态和结果。

示例任务启动指令（在 Cursor Agent 模式中输入）： 'Follow @start.md run task: Tiny refactor import-controller'

此指令指示 Agent 按照 'start.md' 中的启动指令，执行名为 "Tiny refactor import-controller" 的任务。Agent 会尝试匹配相应的任务模板（在 '/task-templates' 目录下），并结合知识库信息完成任务。

关键词