Commit 6b61c806 authored by MD. SHAHIDUL ISLAM's avatar MD. SHAHIDUL ISLAM

docs: Update README section headers for improved clarity and organization

parent 08b7d740
......@@ -25,7 +25,7 @@ This repository contains a Model Context Protocol (MCP) server that connects you
---
## ⚙️ How to Setup
## [CONFIG] How to Setup
### Prerequisites
Make sure you have Python installed on your system.
......@@ -132,13 +132,13 @@ Example for windows:
---
## 🤖 Example Prompts
## [EXAMPLES] Example Prompts
Once the MCP server is running, the AI has direct access to your Jira. You don't need to specify the URL or API details anymore. Just talk to the AI naturally!
Here are examples of what you can ask:
### 📋 Checking Your Work
### [TASKS] Checking Your Work
```
What are my open assigned tasks in Jira?
......@@ -176,7 +176,7 @@ List all issues in PCM that were assigned to QA status yesterday.
List all issues in PCM that are currently 'In Progress' and assigned to me.
```
### Creating Tasks
### [+] Creating Tasks
You can specify absolutely any Issue Type that is valid on your Jira server when creating an issue. E.g.:
`Bug`, `New Feature`, `Task`, `Improvement`, `Epic`, `Story`, `UAT-Feedback`, `Enhancement`, `Test Result`, `Use Case`, `After UAT - Feedback`.
......@@ -222,7 +222,7 @@ I have a list of 5 tasks I need created at once in PQCI:
- Update readme
```
### 👤 Modifying Assignments
### [USER] Modifying Assignments
```
Assign the ticket PCM-228 to me.
......@@ -240,7 +240,7 @@ Who is the designated tester?
Create a new task for 'Update API Documentation' in PCM, and assign it to me right away.
```
### 🔄 Updating Statuses
### [=>] Updating Statuses
```
I just finished working on PCM-131. Please transition it to 'Ready for QA'.
......@@ -254,7 +254,7 @@ Move PQCI-873 to 'Start Progress'.
What transitions are currently available for my task PCM-228?
```
### 💬 Communication & Time Logging
### [COMM] Communication & Time Logging
```
Can you fetch the comments on issue PCM-123?
......@@ -268,7 +268,7 @@ Add a comment to PQCI-875 saying: 'I've addressed the feedback in my latest PR.'
Log 2h 30m of work on PCM-229.
```
### 🔍 Advanced Search (JQL)
### [SEARCH] Advanced Search (JQL)
```
Find all issues in the PCM project containing the word 'login' that are unassigned.
......@@ -284,7 +284,7 @@ What issues are currently in 'Ready for QA' status for PQCI?
---
## 🤝 Contributing
## [CONTRIB] Contributing
We welcome contributions from everyone! Whether you're fixing bugs, adding new features, improving documentation, or suggesting enhancements, your help is greatly appreciated.
......@@ -312,4 +312,4 @@ We welcome contributions from everyone! Whether you're fixing bugs, adding new f
Please ensure your code follows Python best practices and is well-documented. Include comments for complex logic and write clear commit messages.
Thank you for helping us build and improve this project! 🚀
Thank you for helping us build and improve this project!
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment