frontmatter-reference

# 命令元数据（Frontmatter）参考 斜杠命令中 YAML 元数据的完整参考。 ## 元数据概述 YAML 元数据是命令文件开头可选的元数据： markdown --- description: 简短描述 allowed-tools: Read, Write model: sonnet argument-hint: [arg1] [arg2] --- 此处为命令提示词内容... 所有字段均为可选。命令在没有元数据的情况下也能正常工作。 ## 字段规范 ### description **类型：** 字符串 **必需：** 否 **默认值：** 命令提示词的第一行 **最大长度：** 建议在 `/help` 显示中不超过 60 个字符 **用途：** 描述命令的功能，显示在 `/help` 输出中 **示例：** yaml description: 审查代码中的安全问题 yaml description: 部署到测试环境 yaml description: 生成 API 文档 **最佳实践：** - 保持在 60 个字符以内以确保显示整洁 - 以动词开头（审查、部署、生成） - 明确命令的具体功能 - 避免冗余的“命令”或“斜杠命令”字样 **推荐：** - ✅ “审查 PR 以确保代码质量和安全性” - ✅ “将应用程序部署到指定环境” - ✅ “生成全面的 API 文档” **不推荐：** - ❌ “此命令审查 PR”（多余的“此命令”） - ❌ “审查”（太模糊） - ❌ “一个用于审查拉取请求以确保代码质量、安全问题和最佳实践的命令”（太长） ### allowed-tools **类型：** 字符串或字符串数组 **必需：** 否 **默认值：** 继承自对话权限 **用途：** 限制或指定命令可以使用哪些工具 **格式：** **单个工具：** yaml allowed-tools: Read **多个工具（逗号分隔）：** yaml allowed-tools: Read, Write, Edit **多个工具（数组）：** yaml allowed-tools: - Read - Write - Bash(git:*) **工具模式：** **特定工具：** yaml allowed-tools: Read, Grep, Edit **带命令过滤的 Bash：** yaml allowed-tools: Bash(git:*) # 仅限 git 命令 allowed-tools: Bash(npm:*) # 仅限 npm 命令 allowed-tools: Bash(docker:*) # 仅限 docker 命令 **所有工具（不推荐）：** yaml allowed-tools: "*" **使用场景：** 1. **安全性：** 将命令限制为安全操作 yaml allowed-tools: Read, Grep # 只读命令 2. **清晰度：** 记录所需的工具 yaml allowed-tools: Bash(git:*), Read 3. **Bash 执行：** 启用 bash 命令输出 yaml allo