Skip to content

Add some more example prompts #154

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add some more example prompts #154

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 44 additions & 0 deletions doc/example_prompts.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,50 @@ Set or update the SSH public key for a cluster to allow SSH access to nodes.
**Example Prompts:**
- "Set the SSH key for my-cluster to ssh-rsa AAAAB3NzaC1yc2E..."

### `set_cluster_platform`
Set or update the infrastructure platform type for a cluster.

**Example Prompts:**
- "Set the platform for my-cluster to vsphere"

### `analyze_cluster_logs`
Analyze Assisted Installer logs for a cluster and summarize findings.

**Example Prompts:**
- "Analyze the logs for my-cluster and tell me what issues you find"
- "Check the logs for cluster my-cluster and summarize any problems"
- "Review the installation logs for my-cluster"

## Network Configuration

### `validate_nmstate_yaml`
Validate an NMState YAML document before applying to hosts.

**Example Prompts:**
- "Validate this NMState YAML configuration"
- "Check if this network configuration YAML is valid"

### `generate_nmstate_yaml`
Generate NMState YAML from structured network parameters.

**Example Prompts:**
- "Create a network configuration YAML for a host with static IP 10.0.0.5"

### `alter_static_network_config_nmstate_for_host`
Add, replace, or delete static network configuration for a host.

**Example Prompts:**
- "Add a new static network configuration for a host in my-cluster"
- "Update the network config for mac address c5:d6:bc:f0:05:20 to set ip address 10.0.0.5 with CIDR length 24
Copy link

@coderabbitai coderabbitai bot Nov 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Fix unclosed string in example prompt.

Line 104 is missing a closing double quote, which breaks the markdown formatting of this bullet point.

Apply this diff to fix the syntax error:

-- "Update the network config for mac address c5:d6:bc:f0:05:20 to set ip address 10.0.0.5 with CIDR length 24
+- "Update the network config for mac address c5:d6:bc:f0:05:20 to set ip address 10.0.0.5 with CIDR length 24"
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
- "Update the network config for mac address c5:d6:bc:f0:05:20 to set ip address 10.0.0.5 with CIDR length 24
- "Update the network config for mac address c5:d6:bc:f0:05:20 to set ip address 10.0.0.5 with CIDR length 24"
🤖 Prompt for AI Agents 
In doc/example_prompts.md around line 104, the example prompt string is missing
its closing double quote which breaks the markdown; add the missing closing
double quote at the end of the line so the bullet reads: "Update the network
config for mac address c5:d6:bc:f0:05:20 to set ip address 10.0.0.5 with CIDR
length 24"

- "Remove the static network configuration for my-cluster"

### `list_static_network_config`
List all static network configurations for cluster hosts.

**Example Prompts:**
- "Show me all static network configurations for my-cluster"
- "List the network configs configured for hosts in my-cluster"

## Downloads and Resources

### `cluster_iso_download_url`
Expand Down