Commit 08b7d740 authored by MD. SHAHIDUL ISLAM's avatar MD. SHAHIDUL ISLAM

docs: Update README to reflect project name change and enhance example queries

parent c5513d29
# Jira MCP Server # Dohatech Jira MCP Server
This repository contains a Model Context Protocol (MCP) server that connects your AI assistants (like Cursor, Gemini, Claude Desktop) directly to any self-hosted Jira Server or Jira Cloud instance. It enables your AI to seamlessly manage tasks, create issues, and query your project management workflow without leaving the chat interface. This repository contains a Model Context Protocol (MCP) server that connects your AI assistants (like Cursor, Gemini, Claude Desktop) directly to any self-hosted Jira Server or Jira Cloud instance. It enables your AI to seamlessly manage tasks, create issues, and query your project management workflow without leaving the chat interface.
## Author
**Md Shahidul Islam** - Project Creator & Developer
---
## Features Supported ## Features Supported
- **Fetch Assigned Tasks:** Get all open tasks currently assigned to you. - **Fetch Assigned Tasks:** Get all open tasks currently assigned to you.
- **View Issue Details:** Retrieve full information about a specific issue (description, status, priority, reporter). - **View Issue Details:** Retrieve full information about a specific issue (description, status, priority, reporter).
...@@ -134,61 +139,177 @@ Once the MCP server is running, the AI has direct access to your Jira. You don't ...@@ -134,61 +139,177 @@ Once the MCP server is running, the AI has direct access to your Jira. You don't
Here are examples of what you can ask: Here are examples of what you can ask:
### 📋 Checking Your Work ### 📋 Checking Your Work
> *"What are my open assigned tasks in Jira?"*
> *"Can you show me the details for issue PQCI-875?"* ```
> *"Summarize the description of PQCI-877 for me."* What are my open assigned tasks in Jira?
> *"What is my active project?"* ```
> *"Set my active project to PQCI."*
> *"Show me the details for issues PCM-131, PCM-132, and PCM-133."* ```
> *"List only those issues which status is qa assign today"* Can you show me the details for issue PQCI-875?
> *"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."*
```
Summarize the description of PQCI-877 for me.
```
```
What is my active project?
```
```
Set my active project to PQCI.
```
```
Show me the details for issues PCM-131, PCM-132, and PCM-133.
```
```
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.:
`Bug`, `New Feature`, `Task`, `Improvement`, `Epic`, `Story`, `UAT-Feedback`, `Enhancement`, `Test Result`, `Use Case`, `After UAT - Feedback`. `Bug`, `New Feature`, `Task`, `Improvement`, `Epic`, `Story`, `UAT-Feedback`, `Enhancement`, `Test Result`, `Use Case`, `After UAT - Feedback`.
#### 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."*
> *"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!)* ```
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!)
```
#### Creating Issues with Subtasks #### Creating Issues with Subtasks
> *"Create a story titled 'Allow Admin to Change Trader of an Investor' with the following subtasks:*
> *- Front-end: Design* ```
> *- Back-end: Develop"* Create a story titled 'Allow Admin to Change Trader of an Investor' with the following subtasks:
> *"Create a Task titled 'Migrate database' with subtasks:* - Front-end: Design
> *- Backup* - Back-end: Develop
> *- Run migration* ```
> *- Verify data"*
```
Create a Task titled 'Migrate database' with subtasks:
- Backup
- Run migration
- Verify data
```
#### Advanced Task Creation #### Advanced Task Creation
> *"Create a major priority bug for the 'login' component, assigned to 'shahidul', with label 'frontend', environment 'iOS', due '2026-10-31', and an original estimate of '3d 4h'. Support this with description X."*
```
Create a major priority bug for the 'login' component, assigned to 'shahidul', with label 'frontend', environment 'iOS', due '2026-10-31', and an original estimate of '3d 4h'. Support this with description X.
```
#### Bulk Issue Creation #### Bulk Issue Creation
> *"I have a list of 5 tasks I need created at once in PQCI:*
> *- Update logo* ```
> *- Fix header bug (issue_type=Bug)* I have a list of 5 tasks I need created at once in PQCI:
> *- Write documentation* - Update logo
> *- Audit dependencies* - Fix header bug (issue_type=Bug)
> *- Update readme"* - Write documentation
- Audit dependencies
- Update readme
```
### 👤 Modifying Assignments ### 👤 Modifying Assignments
> *"Assign the ticket PCM-228 to me."*
> *"Assign PCM-155 to the QA tester."* ```
> *"Who is the designated tester?"* Assign the ticket PCM-228 to me.
> *"Create a new task for 'Update API Documentation' in PCM, and assign it to me right away."* ```
```
Assign PCM-155 to the QA tester.
```
```
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'."*
> *"Move PQCI-873 to 'Start Progress'."* ```
> *"What transitions are currently available for my task PCM-228?"* I just finished working on PCM-131. Please transition it to 'Ready for QA'.
```
```
Move PQCI-873 to 'Start Progress'.
```
```
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?"*
> *"Add a comment to PQCI-875 saying: 'I've addressed the feedback in my latest PR.'"* ```
> *"Log 2h 30m of work on PCM-229."* 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.'
```
```
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."*
> *"List all high-priority bugs reported this week."* ```
> *"What issues are currently in 'Ready for QA' status for PQCI?"* Find all issues in the PCM project containing the word 'login' that are unassigned.
```
```
List all high-priority bugs reported this week.
```
```
What issues are currently in 'Ready for QA' status for PQCI?
```
---
## 🤝 Contributing
We welcome contributions from everyone! Whether you're fixing bugs, adding new features, improving documentation, or suggesting enhancements, your help is greatly appreciated.
### How to Contribute
1. **Fork the repository** - Click the fork button on GitHub
2. **Create a new branch** - `git checkout -b feature/your-feature-name` or `git checkout -b bugfix/your-bug-fix`
3. **Make your changes** - Implement your feature or bug fix
4. **Test your changes** - Ensure everything works as expected
5. **Commit your changes** - `git commit -m "Clear description of your changes"`
6. **Push to your branch** - `git push origin feature/your-feature-name`
7. **Create a Pull Request** - Submit a PR with a clear description of your changes
### Areas for Enhancement
- Additional Jira operations and features
- Better error handling and logging
- Support for more MCP clients
- Improved documentation and examples
- Performance optimizations
- Unit tests and test coverage
- Bug fixes and reliability improvements
### Code Style
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! 🚀
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