使用说明

项目简介

Build Together 是一个轻量级的、自托管的项目管理工具，专为AI+人类协作和流畅的编码体验而设计。它提供直观的Web界面、REST API 以及完整的 Model Context Protocol (MCP) 支持，方便与 Cursor、Windsurf 等 AI 编码助手集成。

主要功能点

项目管理：创建和管理包含需求和实现细节的项目。
迭代冲刺：组织工作到具有不同状态（计划中、进行中、已完成）的迭代冲刺中。
任务跟踪：跟踪任务和问题及其完成状态。
星标任务：星标重要任务和问题，以便AI助手快速识别并处理。
RESTful API：提供全面的RESTful API用于所有操作。
MCP服务器：内置MCP服务器，无缝集成AI助手。
动态UI：响应式动态用户界面，使用 Tailwind CSS 和 DaisyUI 样式。
Markdown支持：在所有详细信息字段中支持 Markdown 格式。

安装步骤

克隆仓库：

git clone https://github.com/markoinla/build-together.git
cd build-together

运行安装脚本：
```
chmod +x setup.sh
./setup.sh
```
按照脚本提示完成安装，脚本会自动检查Python版本、创建虚拟环境、安装依赖、初始化数据库和配置MCP服务器。
运行应用：
```
./run.sh
```
应用默认在 'http://127.0.0.1:3149' 启动。

MCP 服务器配置

Build Together 的 MCP 服务器允许 AI 编码助手（如 Cursor 和 Windsurf）与您的项目进行交互。以下是 MCP 客户端的配置信息示例：

Windsurf 配置示例 ('~/.codeium/windsurf/mcp_config.json'):

{
  "buildtogether": {
    "command": "/path/to/your/project/mcp/run_mcp.sh",
    "args": [],
    "env": {
      "PYTHONUNBUFFERED": "1",
      "PYTHONIOENCODING": "utf-8",
      "BTG_BASE_URL": "http://127.0.0.1:3149"
    }
  }
}

'command': '/path/to/your/project/mcp/run_mcp.sh' - MCP服务器启动命令。请替换为 'run_mcp.sh' 脚本的实际路径。
'args': '[]' - 启动参数，本应用无需额外参数。
'env': '{...}' - 环境变量。
- 'BTG_BASE_URL': 'http://127.0.0.1:3149' - Build Together 应用的基URL。确保端口与您的应用配置一致。

基本使用方法

配置完成后，您可以在 Cursor、Windsurf 等 AI 编码助手中使用自然语言指令来管理 Build Together 中的项目。例如：

“创建一个新的任务，实现在当前迭代冲刺的用户登录功能”
“当前迭代冲刺中还有哪些未完成的任务？”
“将 ‘用户认证’ 任务标记为已完成”

AI 助手会自动调用相应的 MCP 工具来执行这些操作。

可用 MCP 工具

Build Together 提供了以下 MCP 工具，用于项目、迭代冲刺、任务和问题的管理：

'list_projects' - 列出所有项目
'create_project' - 创建新项目
'get_project' - 获取项目详情
'update_project' - 更新项目
'list_sprints' - 列出迭代冲刺
'create_sprint' - 创建迭代冲刺
'get_sprint' - 获取迭代冲刺详情
'update_sprint' - 更新迭代冲刺
'list_tasks' - 列出任务
'create_task' - 创建任务
'get_task' - 获取任务详情
'update_task' - 更新任务
'list_issues' - 列出问题
'create_issue' - 创建问题
'get_issue' - 获取问题详情
'update_issue' - 更新问题

关键词

使用说明

信息