使用说明

项目简介

CoorAgent 是一个 AI 协作社区，旨在帮助用户轻松创建和管理 AI Agent，并通过灵活的工作流编排实现 Agent 之间的协同合作，以完成复杂的任务。CoorAgent 强调开放性和兼容性，特别是对 Model Context Protocol (MCP) 的支持，使其能够方便地扩展和集成各种外部工具和服务，为 LLM 应用提供强大的上下文服务框架。

主要功能点

Agent 工厂 (Agent Factory): 用户只需用一句话描述 Agent 的能力，CoorAgent 即可自动生成满足需求的 Agent。简化了 Agent 的创建过程，无需复杂的 Prompt 设计。
Agent 工作流 (Agent Workflow): 用户描述任务目标，CoorAgent 自动分析任务需求，并选择合适的 Agent 进行协同工作，自动规划任务步骤和执行顺序，实现复杂任务的自动化完成。
MCP 协议支持: 深度兼容 Model Context Protocol，允许通过 MCP 协议注册和管理外部资源和工具，实现与遵循 MCP 协议的客户端和服务器的互操作。
CLI 工具: 提供完善的命令行工具，方便开发者快速创建、编辑、删除和管理 Agent，并支持通过命令快速运行 Agent 工作流。
Langchain Toolchain 兼容: 深度兼容 Langchain 工具链，可以直接在 CoorAgent 中使用 Langchain 的各种组件，如 Prompts, Chains, Memory 等。

安装步骤

克隆仓库

git clone https://github.com/LeapLabTHU/cooragent.git
cd cooragent

创建并激活 Conda 环境 (推荐) 或 venv 环境

使用 Conda:

conda create -n cooragent python=3.12
conda activate cooragent

使用 venv:

uv venv --python 3.12
source .venv/bin/activate   # For Linux/macOS
.venv\Scripts\activate      # For Windows

安装项目依赖

pip install -e .  # 或 uv sync

(可选) 安装浏览器工具依赖

如果需要使用浏览器工具，请运行：
```
playwright install
```
配置环境变量

复制 '.env.example' 文件并重命名为 '.env'，然后编辑 '.env' 文件，填入所需的 API 密钥等配置信息。
```
cp .env.example .env
# 编辑 .env 文件
```
运行 CLI 工具
```
python cli.py
```

服务器配置 (MCP 客户端配置)

MCP 客户端需要配置 MCP 服务器的启动命令及其参数，以便建立连接。对于 CoorAgent 的 Excel MCP Server，配置信息如下 (JSON 格式):

{
  "server name": "excel-mcp-server",
  "command": "python",
  "args": [
    "path/to/cooragent/src/mcp/excel_mcp/server.py"  // 请将 "path/to/cooragent" 替换为实际的 cooragent 仓库路径
  ]
}

配置参数说明:

'server name': 自定义的服务器名称，用于在客户端标识不同的 MCP 服务器连接。
'command': 启动 MCP 服务器的命令，通常是 Python 解释器路径 ('python')。
'args': 启动命令的参数列表，指向 'excel_mcp/server.py' 脚本的路径。请务必根据实际的 CoorAgent 仓库路径修改 'args' 中的路径。

基本使用方法

启动 'cli.py' 后，即可进入 CoorAgent 命令行交互界面。您可以使用以下命令进行操作：

'run': 运行 Agent 工作流，例如创建 Agent 或执行复杂任务。
'list-agents': 列出用户创建的 Agent。
'list-default-agents': 列出默认 Agent 列表。
'list-default-tools': 列出默认工具列表。
'edit-agent': 交互式编辑已存在的 Agent 配置。
'remove-agent': 删除指定的 Agent。
'help': 查看帮助信息。
'exit' 或 'quit': 退出交互模式。

更多命令的详细用法，请参考 'cli.py help' 命令的输出或 README.md 文档。

关键词