Prompts

Local prompts are prompt template files (in .md format) stored within your local project, offering the following advantages:

• Version-controlled alongside your code: Enables seamless team collaboration and historical tracking
• Automatically synchronized with your IDE: Available immediately in the VJSP plugin after saving
• Slash-command invocable: Set invokable: true to trigger via / shortcut
• Highly customizable: Tailor prompts to your project’s tech stack, coding standards, or business logic

How to Create a Local Prompt

1. Open your project
2. Ensure the .vjsp/prompts directory exists (create it manually if not)
3. Create a new .md file, e.g., my-custom-prompt.md
4. Fill in the YAML front matter and prompt body using the structure below
5. Save the file

✅ Once saved, the prompt will automatically appear in your IDE’s prompt list.

📌 Tip: You can also create prompts via the IDE UI:

• Select a local agent → Click Settings → Rules → Add Prompt
• The system will auto-open a new-prompt.md file for editing

Illustration

Local Prompt Storage Location

Place all prompt files under the following path in your project root:

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

✅ The system automatically scans this directory and treats every .md file as a valid prompt.

Prompt File Structure

Each prompt file must include YAML Front Matter (metadata header) followed by the prompt content.

Example Template

name: Create Supabase Function
description: Generate PostgreSQL database functions following best practices
invokable: true

# Database Task: Create Function

You are an expert in Supabase Postgres. Strictly adhere to the following guidelines:

## General Rules
1. Default to `SECURITY INVOKER`
2. Set `search_path = ''`
3. Use fully qualified table names (e.g., `public.users`)
4. Prefer `IMMUTABLE` or `STABLE` volatility declarations

Generate secure, efficient, and maintainable function code based on the user's request.

Key Field Reference

Field	Type	Required	Description
name	string	✅	Display name shown in command lists
description	string	✅	Brief explanation of purpose
invokable	boolean	❌ (defaults to false)	Set to true to enable invocation via /

💡 Only prompts with invokable: true appear in the slash-command menu.

How to Use Local Prompts

Method 1: Invoke via Slash Command (Recommended)

1. In Chat Mode / Agent Mode / Planning Mode, type /
2. Select your prompt from the dropdown (e.g., /Create Supabase Function)
3. Provide specific details, such as:

   “Create a function to calculate total order amount for the orders table”

The system will inject your prompt as context, guiding the AI to generate responses aligned with your specifications.

Method 2: Reference in config.yaml (For Automation)

If you use a local configuration file, explicitly include prompts in .vjsp/config.yaml:

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

This approach is commonly used in CI/CD pipelines or batch processing workflows.

Local Prompts vs. Hub Prompts

Feature	Local Prompts	Hub Prompts
Storage Location	Project’s .vjsp/prompts/	VJSP Agent Hub (cloud)
Version Control	✅ Git-managed	✅ Publicly shareable
Reusability Scope	Current project only	All agents you own
Editing Method	Direct file edit	Web console required
Best For	Project-specific logic	General-purpose templates

🔗 Learn how to create Hub Prompts

By leveraging local prompts effectively, you can significantly improve development consistency, reduce repetitive communication, and better integrate AI into your engineering workflow.