Commit c5513d29 authored by MD. SHAHIDUL ISLAM's avatar MD. SHAHIDUL ISLAM

docs: Add Mac and Windows configuration examples and new example queries to README.

parent 36b31d3a
...@@ -76,6 +76,43 @@ Edit your `claude_desktop_config.json` file to include the server. Replace the p ...@@ -76,6 +76,43 @@ Edit your `claude_desktop_config.json` file to include the server. Replace the p
} }
} }
``` ```
Example for mac:
```json
"dohatec-jira": {
"command": "/Users/mdshahidulislam/Documents/resource/jiramcp/venv/bin/python3",
"args": [
"/Users/mdshahidulislam/Documents/resource/jiramcp/jira_mcp_server.py"
],
"env": {
"JIRA_SERVER": "http://103.41.111.60:8085",
"JIRA_USERNAME": "shahidul",
"JIRA_PASSWORD": "[PASSWORD]",
"JIRA_DEFAULT_PROJECT": "PCM",
"JIRA_QA_TESTER": "Samia Islam"
}
}
```
Example for windows:
```json
"dohatec-jira": {
"command": "C:\\Users\\mdshahidulislam\\Documents\\resource\\jiramcp\\venv\\Scripts\\python.exe",
"args": [
"C:\\Users\\mdshahidulislam\\Documents\\resource\\jiramcp\\jira_mcp_server.py"
],
"env": {
"JIRA_SERVER": "http://103.41.111.60:8085",
"JIRA_USERNAME": "shahidul",
"JIRA_PASSWORD": "[PASSWORD]",
"JIRA_DEFAULT_PROJECT": "PCM",
"JIRA_QA_TESTER": "Samia Islam"
}
}
```
*(Note: You can remove `JIRA_DEFAULT_PROJECT` or `JIRA_QA_TESTER` if you don't need them).* *(Note: You can remove `JIRA_DEFAULT_PROJECT` or `JIRA_QA_TESTER` if you don't need them).*
### 2. Cursor Configuration ### 2. Cursor Configuration
...@@ -98,19 +135,14 @@ Here are examples of what you can ask: ...@@ -98,19 +135,14 @@ Here are examples of what you can ask:
### 📋 Checking Your Work ### 📋 Checking Your Work
> *"What are my open assigned tasks in Jira?"* > *"What are my open assigned tasks in Jira?"*
>
> *"Can you show me the details for issue PQCI-875?"* > *"Can you show me the details for issue PQCI-875?"*
>
> *"Summarize the description of PQCI-877 for me."* > *"Summarize the description of PQCI-877 for me."*
>
> *"What is my active project?"* > *"What is my active project?"*
>
> *"Set my active project to PQCI."* > *"Set my active project to PQCI."*
> *"Show me the details for issues PCM-131, PCM-132, and PCM-133."* > *"Show me the details for issues PCM-131, PCM-132, and PCM-133."*
> *"List only those issues which status is qa assign today"* > *"List only those issues which status is qa assign today"*
> *"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.: You can specify absolutely any Issue Type that is valid on your Jira server when creating an issue. E.g.:
...@@ -118,14 +150,12 @@ You can specify absolutely any Issue Type that is valid on your Jira server when ...@@ -118,14 +150,12 @@ You can specify absolutely any Issue Type that is valid on your Jira server when
#### Basic Task Creation #### Basic Task Creation
> *"Create a new task in the PQCAL Mobile project (PCM) to 'Fix the broken login button on iOS'. The description should say that it crashes on the staging environment."* > *"Create a new task in the PQCAL Mobile project (PCM) to 'Fix the broken login button on iOS'. The description should say that it crashes on the staging environment."*
>
> *"I just realized we need a new button on the dashboard. Please create a Jira ticket for this." (Requires an active project to be set!)* > *"I just realized we need a new button on the dashboard. Please create a Jira ticket for this." (Requires an active project to be set!)*
#### Creating Issues with Subtasks #### Creating Issues with Subtasks
> *"Create a story titled 'Allow Admin to Change Trader of an Investor' with the following subtasks:* > *"Create a story titled 'Allow Admin to Change Trader of an Investor' with the following subtasks:*
> *- Front-end: Design* > *- Front-end: Design*
> *- Back-end: Develop"* > *- Back-end: Develop"*
>
> *"Create a Task titled 'Migrate database' with subtasks:* > *"Create a Task titled 'Migrate database' with subtasks:*
> *- Backup* > *- Backup*
> *- Run migration* > *- Run migration*
...@@ -144,30 +174,21 @@ You can specify absolutely any Issue Type that is valid on your Jira server when ...@@ -144,30 +174,21 @@ You can specify absolutely any Issue Type that is valid on your Jira server when
### 👤 Modifying Assignments ### 👤 Modifying Assignments
> *"Assign the ticket PCM-228 to me."* > *"Assign the ticket PCM-228 to me."*
>
> *"Assign PCM-155 to the QA tester."* > *"Assign PCM-155 to the QA tester."*
>
> *"Who is the designated tester?"* > *"Who is the designated tester?"*
>
> *"Create a new task for 'Update API Documentation' in PCM, and assign it to me right away."* > *"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'."* > *"I just finished working on PCM-131. Please transition it to 'Ready for QA'."*
>
> *"Move PQCI-873 to 'Start Progress'."* > *"Move PQCI-873 to 'Start Progress'."*
>
> *"What transitions are currently available for my task PCM-228?"* > *"What transitions are currently available for my task PCM-228?"*
### 💬 Communication & Time Logging ### 💬 Communication & Time Logging
> *"Can you fetch the comments on issue PCM-123?"* > *"Can you fetch the comments on issue PCM-123?"*
>
> *"Add a comment to PQCI-875 saying: 'I've addressed the feedback in my latest PR.'"* > *"Add a comment to PQCI-875 saying: 'I've addressed the feedback in my latest PR.'"*
>
> *"Log 2h 30m of work on PCM-229."* > *"Log 2h 30m of work on PCM-229."*
### 🔍 Advanced Search (JQL) ### 🔍 Advanced Search (JQL)
> *"Find all issues in the PCM project containing the word 'login' that are unassigned."* > *"Find all issues in the PCM project containing the word 'login' that are unassigned."*
>
> *"List all high-priority bugs reported this week."* > *"List all high-priority bugs reported this week."*
>
> *"What issues are currently in 'Ready for QA' status for PQCI?"* > *"What issues are currently in 'Ready for QA' status for PQCI?"*
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