你的第一个项目(Your First Project)
本指南将通过一个真实项目,带你逐步了解 Kiro 的核心功能。你将学会如何使用 steering 文件、specs、hooks 和 MCP servers 来优化开发流程。
前置条件(Prerequisites)
开始之前,请确保你已经:
- 安装了 Kiro
- 拥有一个可用的项目(可以是已有项目或新建项目)
- 基本了解你的项目结构和技术栈
打开你的项目(Open Your Project)
启动 Kiro 并打开你的项目:
- 使用
File > Open Folder
选择你的项目目录 - 或将项目文件夹拖放进 Kiro
- 或在命令行中进入项目目录并运行
kiro .
- 使用
打开 Kiro 面板:
- 点击活动栏(左侧边栏)中的 Kiro Ghost 图标
- 该面板提供对 Kiro 所有 AI 功能的访问入口
开启对话会话:
- 默认情况下聊天面板会自动打开
- 这是你与 AI 交互的自然语言接口
设置 Steering 文件(Set Up Steering Files)
Steering 文件为 Kiro 提供项目上下文,帮助它理解你的代码库、开发约定和需求。
要开始设置,点击 Kiro 面板中的 Generate Steering Docs
。Kiro 会自动生成项目的 steering 文件,保存在 .kiro/steering/
目录中,这些文件会引导 Kiro 的行为。内容包括:
- 产品的功能与目标
- 使用的技术栈和框架
- 项目结构与编码规范
你也可以点击 steering 区域的 +
按钮,自定义添加如编码标准、工作流、团队最佳实践等内容。详细了解见 steering 文档。
使用 Specs 构建功能(Build Features with Specs)
Specs 将高层级的功能设想转化为详细的实现计划,分为三个阶段:
- Requirements(需求) - 使用 EARS 模式编写用户故事及验收标准
- Design(设计) - 设计技术架构和实现方案
- Tasks(任务) - 拆解为可追踪的实施步骤
创建你的第一个 Spec(Create Your First Spec)
开始一个新的 Spec:
- 在对话窗口中点击 Spec 按钮
- 或在 Kiro 面板的 Specs 区域点击
+
按钮
输入功能描述:
- 使用自然语言描述你的功能
- 示例:”添加一个用户认证系统,支持登录、登出和密码重置功能”
跟随引导流程:
- 需求阶段:Kiro 会用 EARS 模式帮你整理需求
- 设计阶段:文档化技术架构与组件设计
- 实现阶段:生成具体的开发任务
执行 Spec 任务(Execute Spec Tasks)
Spec 创建完成后:
- 在
tasks.md
文件中 查看生成的任务 - 点击每个任务条目 开始执行任务
- 跟踪进度,任务状态会自动更新为 “In Progress” 或 “Done”
用 Hooks 自动化工作流(Automate Workflows with Hooks)
Agent Hooks 可在以下场景自动执行预定义操作,帮你摆脱繁琐的手动操作:
- 文件被创建、保存或删除
- 触发了手动事件
- 特定文件模式发生变化
开始使用:
进入 Hook 创建界面:
- 在 Kiro 面板中找到 Agent Hooks 区域
- 点击
+
按钮创建新的 hook
定义 Hook 行为:
- 用自然语言描述你想自动化的内容
- 示例:”当我保存一个 React 组件文件时,自动创建或更新它的测试文件”
配置 Hook 设置:
- 事件类型:选择 File Created、File Saved、File Deleted 或 Manual Trigger
- 文件模式:指定哪些文件会触发 hook(例如
src/**/*.tsx
) - 指令说明:定义要执行的具体操作
用 MCP 扩展能力(Extend Capabilities with MCP)
Model Context Protocol(MCP)使 Kiro 能够:
- 访问特定的知识库与文档
- 集成外部 API 和服务
- 使用领域专属工具与实用程序
- 连接数据库与云服务
设置 MCP(Set Up MCP)
点击活动栏中的 Kiro Ghost 图标打开 Kiro 面板,先启用 MCP,然后点击 MCP 区域旁的编辑按钮(铅笔图标)
默认情况下,Kiro 已内置 fetch MCP server,你只需将配置文件中的
disabled
改为false
即可启用你也可以通过请求 Kiro 添加新的 MCP server,或直接编辑配置 JSON 文件。例如:
{
"mcpServers": {
"web-search": {
"command": "uvx",
"args": ["mcp-server-brave-search"],
"env": {
"BRAVE_API_KEY": "your-api-key-here"
},
"disabled": false,
"autoApprove": ["search"]
}
}
}
使用 MCP 工具(Use MCP Tools)
配置完成后,你可以通过以下方式使用 MCP 工具:
直接提问: 利用 MCP server 的能力提问 示例:
Search for the latest React 18 best practices
指定工具使用: 使用
#MCP
上下文指令调用特定 MCP 工具 示例:#[fetch] fetch
使用网页搜索查找 TypeScript 泛型约束的示例与其他功能集成: 将 MCP 与 hooks 或 specs 联动使用 示例:
创建一个 hook,当我创建新组件文件时,使用 web search MCP 查找相关文档