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

Keep README simple and easy - move manual paths to DEVELOPMENT.md

- Removed hardcoded Mac/Windows path examples from README
- README now focused on simple 'jira-mcp' command for end users
- Added reference to DEVELOPMENT.md for custom path configurations
- Moved manual Claude Desktop and Cursor path examples to DEVELOPMENT.md
- Cleaner user experience with progressive disclosure of advanced options
parent 3c28d32a
......@@ -187,6 +187,67 @@ printenv | grep JIRA_
curl http://103.41.111.60:8085
```
## Advanced Configuration
If you've done manual installation with a custom virtual environment path, you may need to specify the full Python path in Claude Desktop or Cursor configurations.
### Claude Desktop with Custom Python Path
**Mac Example:**
```json
{
"mcpServers": {
"jira-mcp-dev": {
"command": "/Users/your-username/Documents/resource/jiramcp/venv/bin/python3",
"args": ["-m", "jira_mcp"],
"env": {
"JIRA_SERVER": "http://103.41.111.60:8085",
"JIRA_USERNAME": "your-username",
"JIRA_PASSWORD": "your-password",
"JIRA_DEFAULT_PROJECT": "PCM",
"JIRA_QA_TESTER": "Samia Islam"
}
}
}
}
```
**Windows Example:**
```json
{
"mcpServers": {
"jira-mcp-dev": {
"command": "C:\\Users\\your-username\\Documents\\resource\\jiramcp\\venv\\Scripts\\python.exe",
"args": ["-m", "jira_mcp"],
"env": {
"JIRA_SERVER": "http://103.41.111.60:8085",
"JIRA_USERNAME": "your-username",
"JIRA_PASSWORD": "your-password",
"JIRA_DEFAULT_PROJECT": "PCM",
"JIRA_QA_TESTER": "Samia Islam"
}
}
}
}
```
### Cursor with Custom Python Path
1. Set environment variables in your shell before launching Cursor:
```bash
export JIRA_MSERVER="/path/to/venv/bin/python3"
export JIRA_SERVER="http://103.41.111.60:8085"
export JIRA_USERNAME="your-username"
export JIRA_PASSWORD="your-password"
```
2. In Cursor Settings → MCP Servers, use:
```bash
/path/to/venv/bin/python3 -m jira_mcp
```
Replace `/path/to/venv` with your actual virtual environment path.
## For More Information
- See [README.md](README.md) for general usage
......
......@@ -106,45 +106,7 @@ Edit your `claude_desktop_config.json`:
}
```
Alternatively, if you need Python path or used manual installation:
**Mac Example:**
```json
{
"mcpServers": {
"dohatec-jira": {
"command": "/Users/mdshahidulislam/Documents/resource/jiramcp/venv/bin/python3",
"args": ["-m", "jira_mcp"],
"env": {
"JIRA_SERVER": "http://103.41.111.60:8085",
"JIRA_USERNAME": "shahidul",
"JIRA_PASSWORD": "[PASSWORD]",
"JIRA_DEFAULT_PROJECT": "PCM",
"JIRA_QA_TESTER": "Samia Islam"
}
}
}
}
```
**Windows Example:**
```json
{
"mcpServers": {
"dohatec-jira": {
"command": "C:\\Users\\mdshahidulislam\\Documents\\resource\\jiramcp\\venv\\Scripts\\python.exe",
"args": ["-m", "jira_mcp"],
"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:** For manual installations with custom Python paths, see [DEVELOPMENT.md](DEVELOPMENT.md).
### Using with Cursor
......@@ -152,7 +114,7 @@ Alternatively, if you need Python path or used manual installation:
2. Click **+ Add New MCP Server**
3. **Name:** `Jira Server`
4. **Type:** `command`
5. **Command:** `jira-mcp` (if installed via pip) or `python -m jira_mcp` (if using manual installation)
5. **Command:** `jira-mcp`
6. Set environment variables in your shell before launching Cursor:
```bash
export JIRA_SERVER="http://103.41.111.60:8085"
......
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