Skip to content
User Guide

Settings → AI → Prompts

Prompt templates are the instructions sent to the model whenever an agent runs. MisterShell separates prompts into two kinds:

  • System prompts — shipped with the platform for built-in agents (config analysis, session assistance, chat, etc.). These establish the agent’s behavior, constraints, and output format. They are read-only; you can view their content but not edit or delete them.
  • User prompts — templates you create and attach to custom or built-in agents.

Creating and editing user prompts requires the Base edition. Without it, the Add Prompt button and the edit control on user prompts stay visible but locked, with a padlock explaining what is missing.

Table columns

ColumnNotes
NameThe prompt’s display name.
TypeBadge — system (shipped) or user (custom).
DescriptionFree-text description of what the prompt is for.
ActionsView (system) / Edit (user) / Delete (user).

Common tasks

View a system prompt

  1. Click the view (eye) icon on a system prompt row.
  2. The full prompt opens in a modal. Close to return.

If you want a variant of a system prompt, create a user prompt and paste the system prompt as a starting point.

Create a user prompt

  1. Click Add Prompt at the top right.
  2. Fill the form:
    • Name — descriptive label.
    • Description — optional notes visible to other users.
    • Content — the full text of the prompt, written in a code editor with a formatting toolbar. Supports {{ variables }} that are substituted at runtime with context (for example, the resource name, the config diff, the user question); the Available Variables pane beside the editor lists what you can reference and inserts a variable where your cursor is.
    • Variable validation schema — optional JSON Schema for the complete set of runtime variables. Use it when a prompt must fail clearly instead of running with a missing or incorrectly typed value.
  3. Click Save.

Edit a user prompt

  1. Click the blue edit icon on a user-type row.
  2. Update any field.
  3. Click Save. Agents that reference this prompt start using the new text on their next invocation.

Delete a user prompt

  1. Click the red trash icon on a user-type row.
  2. Confirm.

MisterShell blocks deletion while an agent references the prompt. Assign those agents another prompt first.

Writing a good prompt

  • Start with a role statement (“You are a network engineer…”).
  • State the user’s situation and the goal of the response.
  • List the available tools when you want the model to use them.
  • Specify the expected output format (plain language, bullets, JSON).

Each prompt can reference {{ variables }} that MisterShell fills at run time — exact variable names depend on the consumer and are documented in the prompt edit form.

Validate prompt variables

The optional schema uses standard JSON Schema. For example, a prompt that requires an integer resource ID can use:

{
  "type": "object",
  "required": ["resource_id"],
  "properties": {
    "resource_id": { "type": "integer" }
  }
}

MisterShell validates the schema when you save it and validates runtime values before sending anything to the model. A mismatch stops the run with a validation error. Leave the field empty when the prompt supports several free-form contexts.

Permissions

  • Read / view: app.ai.read.
  • Create / edit user prompts: app.ai.write.
  • Delete user prompts: app.ai.delete.