Kuroryuu 使用说明

项目简介

Kuroryuu是一个面向软件开发任务的多智能体AI协作平台，核心包含一个符合MCP协议的后端服务器（MCP Core），支持资源管理、工具调用和Prompt模板定义。该平台集成了15个MCP工具（107项功能），覆盖代码搜索、终端控制、桌面自动化、知识管理等，支持61+ LLM模型和多种提供商，实现高度自动化和可扩展的AI工作流。

主要功能点

MCP Core服务器：实现MCP协议，提供工具注册、调用和上下文管理。
Gateway服务：基于FastAPI和WebSocket，支持聊天流式传输和智能代理注册。
多种传输协议支持：支持HTTP、WebSocket和Stdio通信方式。
多智能体编排：采用Leader/Worker架构，实现分布式任务协调和自动化。
丰富的工具集：包括多策略搜索（RAG）、终端操作（PTY）、桌面控制（PowerShell/Win32 API）、邮件系统、代码审查及知识图谱管理。
高度可配置与扩展：内置多种LLM接入方案，支持自定义Prompt和工具权限管理。
跨平台安装：支持Windows原生环境及Docker容器部署。
安全性和会话管理：具备会话生命周期管理、心跳机制和权限校验。

安装步骤

Windows原生安装

安装 Python 3.12，确保版本兼容。
安装 Node.js 18+，用于桌面和Web应用。

克隆仓库：

git clone https://github.com/ahostbr/kuroryuu-public
cd kuroryuu-public

运行设置脚本，完成环境变量设置、虚拟环境创建及依赖安装：
```
.\setup-project.ps1
```
关闭并重新打开终端，确保环境变量生效。
启动所有服务：
```
.\run_all.ps1
```

Docker安装（适合开发和CI）

安装并启动Docker与Docker Compose。
克隆仓库，复制并配置 '.env' 文件，填写必要的API密钥。

使用Docker Compose启动服务：

docker-compose up -d

访问健康检查接口确认服务状态。

服务器配置示例（MCP客户端用）

以下为MCP客户端连接配置的JSON示例：

{
  "name": "Kuroryuu MCP Core",
  "command": "python",
  "args": ["-u", "apps/mcp_core/server.py"],
  "cwd": "<项目根目录>/apps/mcp_core",
  "env": {
    "PYTHONPATH": "<项目根目录>"
  },
  "protocol": "jsonrpc",
  "url": "http://127.0.0.1:8100/mcp"
}

'command'：启动MCP Core服务器的命令。
'args'：启动参数，开启无缓冲模式。
'cwd'：工作目录，指向MCP Core应用目录。
'env'：环境变量配置，确保模块导入正确。
'protocol'：通信协议，使用JSON-RPC。
'url'：服务器API访问地址，客户端通过该地址通信。

基本使用方法

启动服务器后，MCP客户端通过JSON-RPC协议请求调用工具，如检索代码、执行终端命令等。
可通过内置的Kuroryuu CLI或Gateway API进行交互，支持多角色（leader/worker）和会话管理。
利用内置提示模板和多模型支持，实现定制化的AI协作工作流。
通过权限管理和预执行钩子保障操作安全，支持人机协同决策和审批。
支持多任务并行、子代理分配和实时监控，适合大型复杂开发环境。

详细操作和示例请参考仓库文档和内置提示。

Kuroryuu - 多智能体AI编排平台