内容
<p align="center">
<img src="logo-bar.png" alt="DevStar" width="280">
</p>
<p align="center">
<strong>基于冲刺的开发项目规划工具 — 由 AI 代理驱动</strong>
</p>
<p align="center">
<a href="#功能">功能</a> •
<a href="#安装">安装</a> •
<a href="#快速入门">快速入门</a> •
<a href="#AI 代理集成">AI 代理集成</a> •
<a href="#MCP 服务器">MCP 服务器</a> •
<a href="docs/agents/PROMPTS.md">代理提示</a> •
<a href="#架构">架构</a> •
<a href="#从源码构建">从源码构建</a>
</p>
---
## 什么是 DevStar?
DevStar 是一款桌面应用程序,帮助开发者使用**基于冲刺的检查清单工作流**来规划和跟踪项目。它预置了 **12 个模板**,涵盖了各类软件项目,从全栈 Web 应用到嵌入式系统,每个模板都被分解成详细、可行的冲刺和章节。
DevStar 的独特之处在于其**内置的 MCP 服务器** — AI 编码代理(如 Claude Code、Cursor 等)可以读取你的项目计划,标记已完成的任务,添加新的工作项,甚至在所有任务完成后自动推进冲刺。代理直接在 DevStar 生态系统中工作,实时保持 UI 同步。
## 功能
- **12 个专业模板** — 预置模板涵盖 Web、移动、桌面、游戏开发、嵌入式/IoT、API/后端、数据科学/AI、云/基础设施、系统编程、企业、安全和工具/库
- **基于冲刺的工作流** — 通过冲刺跟踪进度(待处理 → 活跃 → 已完成),自动推进
- **实时模式** — 一个紧凑的浮动窗口,显示当前活跃的冲刺,用于专注的任务完成
- **AI 代理集成** — 内置 MCP 服务器,包含 20 个工具,用于代理管理项目、冲刺和任务
- **项目范围** — 在项目目录中工作的代理仅限于该项目(通过 `.devstar.json`)
- **实时 UI 同步** — 代理所做的更改在 3 秒内通过后台轮询出现在 UI 中
- **自动 PATH** — 安装目录在首次启动时自动添加到用户 PATH
- **共享章节和冲刺** — 可重用的检查清单块,可以链接或复制
- **系统托盘** — 在后台运行,从系统托盘可访问
- **跨平台** — Windows(NSIS/MSI)和 Linux(.deb)构建
## 安装
### Windows
从 [Releases](https://github.com/Ronin-117/DevStar/releases) 页面下载最新的 `.exe`(NSIS)安装程序。安装程序将:
- 将 DevStar 安装到您的系统
- 创建桌面快捷方式
- 将 DevStar 添加到启动项(登录时在系统托盘中运行)
- 将安装目录添加到您的 PATH,以便从任何终端都可以使用 `devstar-mcp`
### Linux
下载最新的 `.deb` 包并安装:
```bash
sudo dpkg -i devstar_*.deb
sudo apt-get install -f # 修复任何缺失的依赖项
```
## 快速入门
1. **启动 DevStar** — 点击桌面快捷方式或在开始菜单中找到它
2. **浏览模板** — 进入 **库** 选项卡,查看所有 12 个模板及其冲刺分解
3. **创建项目** — 点击 **+ 新建项目**,选择模板并命名
4. **跟踪进度** — 打开项目,标记已完成的项,观察冲刺自动推进
5. **使用实时模式** — 点击实时模式按钮,获取显示活跃冲刺的紧凑浮动窗口
## AI 代理集成
DevStar 的 MCP 服务器使 AI 编码代理能够完全参与您的项目工作流。
参见 **[docs/agents/PROMPTS.md](docs/agents/PROMPTS.md)** 获取涵盖所有场景的即用提示:新项目规划、实施、恢复会话、健康检查等。
在您的项目目录中工作的代理可以:
### 典型代理工作流
1. **发现** — 调用 `get_project_context` 读取 `.devstar.json` 并查看当前冲刺
2. **规划** — 调用 `get_project_sprints` 获取完整的项目计划,或调用 `search_tasks` 查找相关工作
3. **工作** — 使用 `check_task`(按标题)或 `update_item`(按 ID)完成任务
4. **组织** — 使用 `add_task` 添加新工作,使用 `add_section` 创建类别
5. **推进** — 当所有任务完成后,冲刺会自动推进,或调用 `complete_sprint` 快进
### 代理自我管理
每个 MCP 工具都有详细的描述,解释其功能、所需参数和使用时机。以前从未见过 DevStar 的代理可以仅凭工具描述而自行摸索,无需先前的知识。
### 项目范围
当您创建一个项目时,DevStar 会在您的工作目录中写入一个 `.devstar.json` 文件。该文件将代理限制在特定的项目中 — 它们只能看到和编辑该项目中的任务。共享资源(模板、章节、冲刺)仍然可访问。不同目录中的代理处理不同的项目。
### 实时 UI 同步
代理所做的更改(标记任务、添加项目、推进冲刺)在约 3 秒内通过后台轮询出现在 DevStar UI 中。无需重启。
## 架构
```
┌─────────────────────────────────────────────┐
│ DevStar 应用 │
├──────────────────┬──────────────────────────┤
│ 前端 │ 后端(Rust) │
│ React + TS │ SQLite + Tauri │
│ Zustand 状态管理 │ MCP 服务器(stdio) │
│ Tailwind CSS │ 系统托盘 │
└──────────────────┴──────────────────────────┘
```
### 数据模型
```
模板 → 模板冲刺 → 模板冲刺章节 → 共享章节
共享章节 → 共享章节项目
共享冲刺 → 共享冲刺章节
项目 → 项目冲刺 → 项目冲刺章节 → 项目项目
```
## 从源码构建
### 前提条件
- **Node.js 20+** 和 npm
- **Rust stable**(通过 [rustup](https://rustup.rs/) 安装)
- **Tauri 依赖项**(特定于平台,参见 [Tauri 文档](https://v2.tauri.app/start/prerequisites/))
### 构建
```bash
# 安装前端依赖项
npm install
# 开发模式(仅限网络)
npm run dev
# 开发模式(完整的 Tauri 桌面应用)
npm run tauri dev
# 生产构建
npm run tauri build
```
构建的安装程序将位于 `src-tauri/target/release/bundle/`。
## MCP 服务器
DevStar 包含一个内置的 **MCP(模型上下文协议)服务器**,允许 AI 编码代理以编程方式与您的项目计划交互。服务器在 DevStar 启动时作为后台进程运行。
### 可用工具(共 22 个)
| 工具 | 描述 |
|------|-------------|
| `initialize` | 通过 `.devstar.json` 中的 `project_uuid` 将代理会话限定到项目 |
| `get_project_context` | 通过 `.devstar.json` 实现零配置发现。返回项目概览 + 带有所有任务的活跃冲刺 |
| `get_full_project_plan` | **完整的项目树** — 每个冲刺、每个章节、每个带有检查状态的任务。首先使用此工具。 |
| `dashboard` | 所有项目的紧凑概览 — 名称、进度 %、活跃冲刺 |
| `create_project` | 从模板创建并为代理范围写入 `.devstar.json` |
| `get_active_sprint_detail` | 当前活跃的冲刺,包含所有章节和任务 |
| `get_project_sprints` | 所有冲刺,状态、进度和章节计数 |
| `get_sprint` | 按编号(基于 1)或名称获取任意冲刺,包含完整的任务列表 |
| `get_tasks` | 在活跃冲刺中列出任务,按状态(待处理/已完成/全部)过滤 |
| `add_task` | 通过标题将任务添加到活跃冲刺 — 无需 ID,自动查找/创建章节 |
| `check_task` | 通过标题(部分、大小写不敏感匹配)标记任务完成 |
| `uncheck_task` | 通过标题撤销任务标记 |
| `update_item` | 低级:通过项目 ID 标记/取消标记/添加备注 |
| `add_item` | 低级:通过章节 ID 将任务添加到特定章节 |
| `add_section` | 将新章节/类别添加到活跃冲刺(幂等 — 不会创建重复项) |
| `search_tasks` | 通过关键词搜索所有冲刺中的所有任务 |
| `complete_sprint` | 标记所有任务完成,标记冲刺完成,激活下一个冲刺 |
| `get_progress` | 项目完成统计(已检查/总数/百分比) |
| `log_error` | 记录一个错误,作为带有代理属性的未检查任务 |
| `list_templates` | 所有可用模板及其冲刺计数 |
| `get_template` | **完整的模板树** — 每个冲刺、章节和项目。在 `create_project` 之前使用。 |
| `list_shared_sections` | 可重用的检查清单块 |
| `list_shared_sprints` | 可重用的冲刺模板 |
### 配置
将以下内容添加到您的 AI 代理的 MCP 配置中:
```json
{
"mcpServers": {
"devstar": {
"command": "devstar-mcp"
}
}
}
```
MCP 服务器在 DevStar 启动时自动启动,并作为后台进程运行。`devstar-mcp` 二进制文件在安装后可在 PATH 上使用。
## 项目结构
```
ProjectTracker/
├── src/ # 前端(React + TypeScript)
│ ├── components/
│ │ ├── active/ # 实时模式窗口
│ │ ├── projects/ # 项目视图
│ │ ├── templates/ # 模板和库视图
│ │ └── shared/ # 可重用 UI 组件
│ ├── store/ # Zustand 状态管理
│ └── lib/ # API 层、类型、实用工具
├── src-tauri/ # 后端(Rust)
│ ├── src/
│ │ ├── db/ # 数据库层
│ │ │ ├── seeds/ # 种子数据(12 个模板)
│ │ │ │ └── templates/ # 每个模板的种子文件
│ │ │ └── *.rs # CRUD 操作
│ │ ├── lib.rs # Tauri 命令和设置
│ │ └── mcp_server.rs # MCP 服务器二进制文件
│ └── tauri.conf.json # Tauri 配置
└── .github/workflows/ # CI/CD 管道
```
## CI/CD
每次推送到 `main` 分支都会触发:
- **TypeScript 类型检查**
- **Rust clippy**(带有 `-D warnings`)
- **Rust 测试**
- **完整应用构建**,适用于 Windows 和 Linux(Linux 构建是非阻塞的)
标记的发布(`v*`)会生成可下载的安装程序:
- Windows:NSIS `.exe` 安装程序 + 独立 `.exe`
- Linux:`.deb` 包(尽力而为,不会阻塞发布)
## 许可证
MIT
## 贡献
1. 复刻仓库
2. 创建一个功能分支(`git checkout -b feature/amazing-feature`)
3. 提交更改(`git commit -m 'Add amazing feature'`)
4. 推送到分支(`git push origin feature/amazing-feature`)
5. 打开拉取请求
MCP 配置
以下是此 MCP Server 的配置信息,可直接复制到 Cursor 或其他 MCP 客户端中使用。
mcp.json
连接信息
猜你喜欢
rea
用于编码代理的逆向工程:一个 CLI 和 MCP 服务器,用于检查任何应用程序,了解其功能,并按照您的方式构建它们。
everything-claude-code
完整的 Claude Code 配置集合 - agents、skills、hooks、commands、rules、MCPs。来自 Anthropic...
Firecrawl
Firecrawl MCP Server 实现了网页抓取、爬虫和内容提取功能。
MarkItDown MCP
MarkItDown-MCP是一个轻量级服务器,用于将URI转换为Markdown。
cc-switch
跨平台的Claude Code、Codex和Gemini CLI一体化助手。
Agent-Reach
赋予你的AI Agent观察整个互联网的眼睛。读取并搜索...