Skip to content

Commit 0dddcbd

Browse files
committed
docs: improve Jira MCP DevTools README with enhanced configuration and usage guide
- Restructure Cursor IDE configuration section for clarity - Add detailed environment variable explanations - Provide comprehensive Jira command usage examples - Include link to Jira package documentation - Enhance readability and user guidance for MCP DevTools Jira integration
1 parent 70266d4 commit 0dddcbd

File tree

1 file changed

+30
-11
lines changed

1 file changed

+30
-11
lines changed

README.md

Lines changed: 30 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -23,23 +23,42 @@ MCP (Model Context Protocol) DevTools is a collection of packages that enable AI
2323

2424
## 🚀 Quick Start
2525

26-
To use MCP DevTools with Cursor IDE:
26+
### Configuration in Cursor IDE
2727

28-
```bash
29-
# Configure in Cursor settings (recommended)
30-
# Settings > Cursor Settings > MCP
31-
# Add a new MCP server with:
32-
# Name: Jira
33-
# Type: command
34-
# Command: env JIRA_URL=https://[YOUR_WORKSPACE].atlassian.net JIRA_API_MAIL=[YOUR_EMAIL] JIRA_API_KEY=[YOUR_API_KEY] npx -y @mcp-devtools/jira
35-
```
28+
1. Open Cursor Settings → MCP
29+
2. Click "Add New MCP Server"
30+
3. Fill in the following details:
31+
- **Name**: `Jira`
32+
- **Type**: `command`
33+
- **Command**:
34+
`env JIRA_URL=https://[YOUR_WORKSPACE].atlassian.net JIRA_API_MAIL=[YOUR_EMAIL] JIRA_API_KEY=[YOUR_API_KEY] npx -y @mcp-devtools/jira`
35+
36+
> **Required Environment Variables**:
37+
>
38+
> - `JIRA_URL`: Your Jira instance URL (e.g., `https://your-company.atlassian.net`)
39+
> - `JIRA_API_MAIL`: Your Atlassian account email
40+
> - `JIRA_API_KEY`: Your Atlassian API key ([Create one here](https://id.atlassian.com/manage-profile/security/api-tokens))
41+
42+
### Using Jira Tools
3643

37-
Once configured, interact with Jira through chat commands:
44+
Once configured, you can interact with Jira through natural language commands in Cursor. Examples:
3845

3946
```
40-
get task SCRUM-1
47+
# Fetch a specific ticket
48+
get ticket SCRUM-123
49+
50+
# Search for tickets
51+
execute jql "project = SCRUM AND status = 'In Progress'"
52+
53+
# Get ticket details
54+
read ticket SCRUM-123
55+
56+
# Create a new ticket
57+
create ticket project=SCRUM summary="Fix login bug" description="Users can't log in" issuetype=Bug
4158
```
4259

60+
For a complete list of available commands, refer to the [Jira Package Documentation](./packages/jira/README.md).
61+
4362
## 📖 Documentation
4463

4564
- [Jira Package Documentation](./packages/jira/README.md)

0 commit comments

Comments
 (0)