# project

> 搜索 Godot 项目、获取项目信息、列出文件、读取配置、创建项目、设置项目规则。

| 属性 | 值 |
|------|-----|
| 所属层 | headless |
| 安全级别 | danger-api |
| 需要 Godot | 否 |
| 需要编辑器 | 否 |
| 只读 | 否 |
| 长耗时 | 否 |

## Actions

- `list_projects`
- `get_project_info`
- `list_files`
- `read_project_config`
- `create_project`
- `setup_project_rules`
- `write_config`
- `list_templates`
- `apply_template`

## Parameters

| 参数 | 类型 | 必填 | 说明 |
|------|------|------|------|
| `action` | enum (9 项) | ✓ | 操作类型 |
| `project_path` | string |  | Godot 项目目录路径（可选，默认使用 GODOT_PROJECT_PATH 环境变量或当前目录） |
| `search_dir` | string |  | 搜索目录（list_projects） |
| `max_depth` | number |  | 最大搜索深度（默认 3，钳制上限 10） |
| `extensions` | array |  | 按扩展名过滤（如 [".gd", ".tscn"]） |
| `subdirectory` | string |  | 限定子目录 |
| `project_name` | string |  | 项目名称（默认取文件夹名） |
| `renderer` | enum: forward_plus | mobile | gl_compatibility |  | 渲染器："forward_plus"（默认）、"mobile"、"gl_compatibility" |
| `template` | string |  | 项目脚手架模板：2d-platformer / 3d-fps / visual-novel（默认空） |
| `hooks` | boolean |  | 创建 .claude/settings.json 的 PostToolUse hook（默认 true） |
| `rules_mode` | enum: check | update | overwrite |  | 规则文件 reconcile 模式：check（默认，只检测报告）/ update（覆盖版本过时且未动过的文件，保留用户动过的）/ overwrite（全覆盖含本地修改） |
| `claude_md` | boolean |  | 创建/追加 CLAUDE.md 验证规则（默认 true） |
| `agents_md` | boolean |  | 创建/追加 AGENTS.md 项目规则（ZCode/Codex/Cursor 等遵循 AGENTS.md 标准的客户端读取，默认 true） |
| `ci` | boolean |  | 生成 GitHub Actions CI workflow（默认 false） |
| `godot_version` | string |  | CI 中使用的 Godot 版本（默认 4.7） |
| `force` | boolean |  | 覆盖已有配置（默认 false） |
| `key` | string |  | 配置键（write_config，如 "application/config/name"） |
| `value` | string |  | 配置值（write_config） |
| `tag` | string |  | 模板：按标签过滤 |
| `applies_to` | string |  | 模板：按适用类过滤 |
| `template_id` | string |  | 模板：模板 ID（如 T008） |
| `script_path` | string |  | 模板：目标脚本路径 |
| `variables` | object |  | 模板：变量覆盖 |

## 风险分布

读 5 / 写 4

---
<!-- AUTO-GENERATED by scripts/gen-tool-docs.mjs from capability-matrix.json v0.32.21. DO NOT edit manually; re-run npm run gen:tool-docs after tool changes. -->
