Metadata-Version: 2.4
Name: fcop-mcp
Version: 0.2.0
Summary: MCP toolbox for FCoP — the File-based Coordination Protocol for multi-agent collaboration.
Project-URL: Homepage, https://github.com/joinwell52-AI/codeflow-pwa
Project-URL: Repository, https://github.com/joinwell52-AI/codeflow-pwa
Project-URL: Issues, https://github.com/joinwell52-AI/codeflow-pwa/issues
Author: CodeFlow Team
License-Expression: MIT
Keywords: claude,codeflow,cursor,fcop,file-based-protocol,mcp,multi-agent
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.10
Requires-Dist: fastmcp>=3.2.0
Requires-Dist: websockets>=12.0
Description-Content-Type: text/markdown

# 码流（CodeFlow）— Multi-AI Agent Collaboration Plugin

让多个 Cursor Agent 像团队一样协作。

## 这是什么？

**码流（CodeFlow）** 是一个 Cursor 插件，解决一个核心问题：**Cursor 里开多个 Agent，它们各干各的，互相不知道对方在干什么。**

安装插件后，Agent 自动获得：

- 角色身份（知道自己是谁）
- 协作协议（知道怎么交接任务）
- 自动巡检（知道去哪接任务）

## 三套预设团队

| 模板 | 角色 | 适合场景 |
|------|------|----------|
| **dev-team** | PM + DEV + QA + OPS | 软件开发 |
| **media-team** | PUBLISHER + COLLECTOR + WRITER + EDITOR | 自媒体内容 |
| **mvp-team** | MARKETER + RESEARCHER + DESIGNER + BUILDER | 创业 MVP |

## 安装

### 本地安装（开发测试）

```bash
# 克隆本仓库后，将插件目录链到 Cursor 插件目录（示例）
# Windows
mklink /D "%USERPROFILE%\.cursor\plugins\local\codeflow" "D:\\CodeFlow\\codeflow-plugin"
# macOS/Linux
ln -s /path/to/codeflow-plugin ~/.cursor/plugins/local/codeflow
```

重启 Cursor 即可。`mcp.json` 中 **`args`** 请指向本机 **`codeflow-plugin\scripts\mcp_server.py`** 的绝对路径。

### Marketplace 安装

搜索 **CodeFlow** 或 **码流**（审核通过后可用）。

## 快速开始

1. 安装插件  
2. 打开项目，在 Agent 中说：`初始化码流开发团队`（或按 MCP 工具说明调用 `init_project`）  
3. 插件自动创建 `docs/agents/` 目录和角色配置  
4. 开多个 Agent 窗口，每个分配一个角色  
5. 对主控角色说「开始工作」  

## MCP Tools

| 工具 | 功能 |
|------|------|
| `init_project` | 初始化项目协作空间 |
| `get_team_status` | 查看团队状态 |
| `list_tasks` | 列出任务 |
| `read_task` | 读取任务详情 |
| `write_task` | 创建新任务 |
| `list_reports` | 列出报告 |
| `read_report` | 读取报告详情 |
| `list_issues` | 列出问题 |
| `archive_task` | 归档已完成任务 |
| `get_available_teams` | 查看可用团队模板 |

## 文件协议

Agent 之间通过 Markdown 文件通信：

```
docs/agents/
├── tasks/     ← 任务单
├── reports/   ← 完成报告
├── issues/    ← 问题记录
└── log/       ← 历史归档
```

团队配置优先写入 **`docs/agents/codeflow.json`**（兼容旧版 **`CodeFlow.json`**）。

## 中继桥接（Phase 2）

未设置 `CODEFLOW_ROOM_KEY`（或旧名 `CODEFLOW_ROOM_KEY`）时，MCP 仅操作本地 `docs/agents/`，不连中继。

要与手机端 PWA 同步，请在 MCP 配置的 `env` 中设置：

| 变量 | 说明 |
|------|------|
| `CODEFLOW_PROJECT_DIR` 或 `CODEFLOW_PROJECT_DIR` | 项目根目录（含 `docs/agents/`） |
| `CODEFLOW_ROOM_KEY` 或 `CODEFLOW_ROOM_KEY` | 非空即启用后台线程连接中继 |
| `CODEFLOW_RELAY_WS_URL` 或 `CODEFLOW_RELAY_WS_URL` | 中继 WebSocket，默认 `ws://127.0.0.1:5252` |
| `CODEFLOW_DEVICE_ID` 或 `CODEFLOW_DEVICE_ID` | 本机 MCP 设备 ID，默认 `codeflow-mcp` |

依赖：`pip install -r codeflow-plugin/requirements.txt`（含 `websockets`）。

## 打开本机控制面板（`http://127.0.0.1:18765/`）

想在 Cursor 内嵌一个面板视图，请使用仓库内 **`codeflow-desktop/cursor-extension/`** 下的 VSIX 扩展 `codeflow-panel-launcher`（命令：`CodeFlow: 打开控制面板` / `codeflow.openPanel`）。它走 VS Code 扩展 API，无需 Python、不模拟键盘、不抢焦点。

前置：已运行 **CodeFlow-Desktop.exe**，`127.0.0.1:18765` 可访问。

## License

MIT
