Add some example prompts for each tool

[carbonin]

Summary by CodeRabbit

• Documentation
  • Added a new guide with example user prompts for interacting with various cluster management tools through the Assisted Service API. The document includes categorized examples for cluster management, creation, downloads, and information retrieval.

[coderabbitai]

Walkthrough

A new documentation file, doc/example_prompts.md, has been added. This file provides categorized example user prompts for invoking various MCP tools within the Assisted Service API, including descriptions and sample natural language commands for different cluster management functionalities.

Changes

File(s)	Change Summary
doc/example_prompts.md	Added documentation with categorized example user prompts for MCP tools in Assisted Service API

Sequence Diagram(s)

No sequence diagram generated since the change is documentation-only and does not affect control flow or feature implementation.

Estimated code review effort

1 (~2 minutes)

Possibly related PRs

• MGMT-20904 Improve docs and tools description #2: Adds detailed descriptions and usage examples for MCP tools in documentation, directly relating to the new example prompts documentation.

Suggested labels

size/L, lgtm

Poem

In the warren, docs now bloom anew,
With prompts for clusters, clear and true.
Rabbits hop from tool to tool,
Guided by examples—how cool!
With every prompt, a cluster grows,
And documentation’s garden shows.
🐇✨

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

doc/example_prompts.md (1)

51-56: Plural “Prompts” but only one example – tweak for consistency

The heading says “Example Prompts:” yet only a single bullet follows. Either add at least one more example or change the heading to the singular form.

-**Example Prompts:**
-- "Start the installation for my-cluster"
+**Example Prompt:**
+- "Start the installation for my-cluster"

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d7fb34d and 0653d47.

📒 Files selected for processing (1)

• doc/example_prompts.md (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: Red Hat Konflux / assisted-service-mcp-saas-main-on-pull-request

🔇 Additional comments (1)

doc/example_prompts.md (1)

1-102: Comprehensive and well-structured examples – great addition!

The new doc is clear, consistently formatted, and immediately useful for users who want to experiment with natural-language commands. Nice work.

[eranco74]

/lgtm

[carbonin]

/approve
/retest

[openshift-ci]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: carbonin

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details

Needs approval from an approver in each of these files:

• OWNERS [carbonin]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment