This guide defines how we format prompts for CloudBrowser (system, style, errors, tools, context). Consistency ensures prompts are easy to read, easy to maintain, and predictable for both humans and LLMs.
Use H2 (
##) for each prompt fragment:## Role,## Style,## Errors,## Tools,## Context
Use H3 (
###) inside a fragment if you need subsections:Example:
### Static Entities,### Dynamic Entities
Do not use H1 (
#) inside prompts (reserve for Confluence docs).
Example:
## Role
You are CloudBrowser Support Copilot...
## Concepts
### Static Entities
- Client
- ProjectUse for unordered items (rules, options, facts).
Keep items short (1–2 sentences max).
Example:
- **Clarity**: ≤6 bullets max.
- **Scope**: Current client only.
- **Source of truth**: CloudBrowser data.Use when order matters (procedures, workflows).
Example:
1. Identify failing component.
2. Check related events.
3. Suggest remediation.Use for commands, identifiers, field names.
Example:
Check pod status with `kubectl describe pod`.Use for logs, configs, structured output (JSON/YAML).
Always label with language when possible (e.g.,
json,yaml,bash).
Example:
```json
{
"summary": "Pod was OOMKilled",
"root_cause": "Memory limit exceeded",
"suggested_actions": ["Increase memory limit", "Check memory leaks"]
}
```Use for critical rules, entity names, key concepts.
Think of bold as must not miss.
Example:
**Source of truth**: Use CloudBrowser data only.Use for nuance, optional hints, or tone guidance.
Think of italics as soft emphasis.
Example:
Ask for *clarification* if identifiers are missing.Rarely used, but can combine bold + italics for critical nuance.
Example:
***Never expose credentials*** in responses.Use for fallback responses or boilerplate outputs.
Example:
> If context is missing, reply: "Not enough data to answer."Use sparingly to break long sections when headings are too heavy.
Example:
## Ground Rules
...
---
## Instructions
...Require JSON only when needed for automation.
For general answers, prefer bullets.
Example:
Return output in JSON only:
```json
{
"summary": "Pod OOMKilled",
"root_cause": "Container exceeded memory limit",
"suggested_actions": ["Increase memory limit", "Check app for memory leaks"]
}
```## Role
You are CloudBrowser Support Copilot...
## Style
- Be concise and technical.
- Prefer bullet points.
- Output JSON when requested.
## Errors
> If context is missing, reply: "Not enough data."
## Tools
- `search_incidents(query)` → search known incidents.
- `get_metrics(component)` → fetch metrics.
## Context
Logs:
```
OOMKilled: container killed due to memory limit
```
Events:
```
Pod evicted due to node pressure
```Use H2 for top sections, H3 for subsections.
Bullets for unordered, numbers for steps.
Inline code for identifiers, code fences for logs/JSON.
Bold = must-follow rules.
Italics = nuance or optional hints.
Bold + Italics = critical nuance.
Blockquotes for fallback answers.
JSON only when automation requires structured output.