计划 Alpha 登机
欢迎加入Kaava alpha计划。本指南将帮助您设置MCP服务器(用于Claude Desktop)和Storyboard web应用程序。
你得到了什么
Kaava是一个规范智能系统,可以帮助您与Claude对话式地思考软件设计,然后在实施前与利益相关者分享实时规范以供审查。
两个组件:
- 配置 MCP 服务器 --在本地运行,为Claude提供90多种管理规范的工具
- 图形故事板 --kaava.studio上的Web应用程序,用于与利益相关者共享规格
第一步:获取您的邀请函
作为alpha用户,您将收到一封项目邀请电子邮件,其中包含一个访问Storyboard的神奇链接。如果你还没有收到,请联系Aaron。
步骤2:安装MCP服务器
MCP服务器允许Claude帮助您创建和管理规范。
先决条件
- Node.js 20或更高版本
- 已安装Claude Desktop应用程序
安装
- 从以下网址下载最新版本:
- 全局安装:
# Install from the downloaded tarball
npm install -g ~/Downloads/kaava-mcp-1.29.0.tgz配置Claude桌面
将Kaava添加到您的Claude Desktop配置中:
macOS: 编辑 ~/Library/Application Support/Claude/claude_desktop_config.json 窗户: 编辑 %APPDATA%\Claude\claude_desktop_config.json
{
"mcpServers": {
"kaava": {
"command": "kaava-mcp",
"args": [],
"env": {
"KAAVA_PROJECT_ROOT": "/path/to/your/projects"
}
}
}
}集 KAAVA_PROJECT_ROOT 转到包含项目存储库的目录。
重新启动克劳德桌面
保存配置后,重新启动Claude Desktop。当你开始新的对话时,你应该看到Kaava工具可用。
验证安装
问克劳德:
“列出我的Kaava项目”
克劳德应该用 kaava_query 工具。
第三步:创建你的第一个项目
在Claude Desktop中,说:
“在/path/to/my-app中初始化一个名为my-app的新Kaava项目”
克劳德将使用 kaava_init 建立项目结构,包括:
.kaava/kaava.db--存储所有规格的SQLite数据库CLAUDE.md--向Claude说明如何处理您的项目
CLAUDE.md文件
每个Kaava项目都包括一个 CLAUDE.md 根目录下的文件。此文件教Claude如何在您的项目中有效地使用Kaava工具。当开始谈论你的项目时,告诉克劳德:
“阅读CLAUDE.md并帮助我制定规格”
这确保了Claude了解Kaava的工作流程:使用MCP工具而不是原始文件编辑,在执行过程中记录决策,并保持规范同步。
步骤4:连接到故事板
故事板是一个web界面,利益相关者可以在其中浏览和评论您的规范。
登录
- 首选 公式.studio
- 点击“使用GitHub登录”
- 授权Kaava应用程序
注: 在alpha期间,新注册需要邀请。如果你看到“需要邀请”,请确保你首先点击了邀请电子邮件中的神奇链接。
连接您的存储库
登录后:
- 单击“连接存储库”
- 输入存储库的GitHub URL(例如。,
https://github.com/you/my-app) - 故事板将同步您的Kaava规格
邀请利益相关者
要与不需要完整MCP设置的审阅者共享规格:
- 转到项目设置
- 点击“邀请团队成员”
- 输入他们的电子邮件并选择访问级别
- 他们会收到一个神奇的链接来查看你的规格
工作流程
以下是一切如何结合在一起:
- 定义 --使用MCP工具在Claude Desktop中与Claude一起工作
- 添加功能、实体、状态机 - 记录架构决策 - 当你大声思考时,结构会逐渐累积
- 推 --将更改提交到您的存储库
- Claude可以提供帮助:“提交我的规范更改”
- 审查 --利益相关者在故事板中浏览
- 他们看到能力、实体、生命周期 - 他们对特定项目发表评论 - 它们不需要设置,只需要一个神奇的链接
- 迭代 --处理反馈,完善规格
- Claude帮助整合反馈 - 推送更新,利益相关者看到变化
常用命令
问克劳德这些事情开始:
| 该说什么 | 发生了什么 |
|---|---|
| “我们有什么能力?” | 列出所有能力 |
| “添加用户身份验证功能” | 创建新功能 |
| “存在哪些实体?” | 列出数据实体 |
| “显示订单的生命周期” | 显示状态机 |
| “记录关于API版本控制的决策” | 记录体系结构决策 |
| “为CAP-001生成实施文档” | 创建详细的实施指南 |
故障排除
“不在Kaava项目中”
确保 KAAVA_PROJECT_ROOT 指向包含您的项目的目录,并且该项目已使用初始化 kaava_init.
故事板上出现“invite_required”错误
你需要一个邀请才能在alpha期间注册。查看您的电子邮件中的魔术链接或联系Aaron。
克劳德看不到卡瓦工具
- 检查claude_desktop_config.json语法(有效的json?)
- 确保kaava-mcp在全球范围内安装:
which kaava-mcp - 完全重新启动克劳德桌面
规格未出现在情节提要中
- 确保您已提交并推送了更改
- 在“项目设置”中检查您的存储库URL是否正确
- 拉取故事板中的最新更改
获取帮助
- 问题? 直接给Aaron留言
- 漏洞? 提交问题(Aaron将分享回购链接)
- 反馈? 我们想听到一切——什么有效,什么令人困惑,缺少什么
欢迎来到阿尔法。让我们一起创造一些伟大的东西。
