Skip to content

提示词

本地提示词是存储在你本地项目中的提示模板文件(.md 格式),具有以下特点:

  • 与代码一同版本控制:便于团队协作和历史追踪
  • 自动同步到 IDE:保存后立即在 VJSP 插件中可用
  • 支持斜杠命令调用:设置 invokable: true 后可通过 / 快速使用
  • 高度定制化:可根据项目技术栈、规范或业务需求编写专属提示词

创建本地提示词的操作步骤

  1. 打开你的项目
  2. 确保存在 .vjsp/prompts 目录(若无,请手动创建)
  3. 新建一个 .md 文件,例如 my-custom-prompt.md
  4. 按上述结构填写 YAML 头部和提示正文
  5. 保存文件

✅ 保存后,该提示词将自动出现在 IDE 的提示词列表中。

📌 提示:你也可以通过 IDE 界面操作:

  • 选择本地智能体 → 点击「设置」→「规则」→「添加提示词」
  • 系统将自动打开 new-prompt.md 文件供你编辑

操作示意图

本地提示词存放位置

请将提示词文件存放在项目根目录下的以下路径:

.vjsp/
└── prompts/
    ├── new-prompt.md
    ├── supabase-functions.md
    └── ...

✅ 系统会自动扫描该目录,并将所有 .md 文件识别为提示词。

提示词文件结构

每个提示词文件必须包含 YAML Front Matter(头部元数据)和 正文内容

示例模板

md

name: 创建 Supabase 函数
description: 生成符合最佳实践的 PostgreSQL 数据库函数
invokable: true

# 数据库任务:创建函数

你是一位精通 Supabase Postgres 的专家,请严格遵循以下规范:

## 通用准则
1. 默认使用 `SECURITY INVOKER`
2. 设置 `search_path = ''`
3. 所有表名使用全限定格式(如 `public.users`
4. 优先使用 `IMMUTABLE``STABLE` 声明

请根据用户需求生成安全、高效、可维护的函数代码。

关键字段说明

字段类型必填说明
namestring提示词名称,显示在命令列表中
descriptionstring简要描述用途
invokableboolean❌(默认 false设为 true 后可在对话中通过 / 调用

💡 只有 invokable: true 的提示词才会出现在斜杠命令菜单中。

如何使用本地提示词

方法 1:通过斜杠命令调用(推荐)

  1. 聊天模式 / 智能体模式 / 规划模式 中输入 /
  2. 从下拉列表中选择你的提示词(如 /创建 Supabase 函数
  3. 补充具体需求,例如:

    “为订单表创建一个计算总金额的函数”

系统会自动将提示词内容作为上下文注入,引导 AI 按照你的规范生成响应。

方法 2:在 config.yaml 中引用(适用于任务自动化)

如果你使用本地配置文件,可在 .vjsp/config.yaml 中显式引入提示词:

yaml
prompts:
  - ./prompts/supabase-functions.md
  - ./prompts/api-docs-generator.md

此方式常用于 CI/CD 或批量任务场景。

与 Hub 提示词的区别

特性本地提示词Hub 提示词
存储位置项目 .vjsp/prompts/VJSP Agent Hub 云端
版本控制✅ 支持 Git 管理✅ 可公开分享
复用范围当前项目所有关联的智能体
编辑方式直接修改文件需登录 Web 控制台
适用场景项目专属通用模版

🔗 了解如何创建 Hub 提示词

通过合理使用本地提示词,你可以显著提升开发一致性、减少重复沟通,并让 AI 更好地融入你的工程体系。