Commit 278e4052 authored by MD. SHAHIDUL ISLAM's avatar MD. SHAHIDUL ISLAM

Remove redundant environment variable documentation

- Configuration happens in JSON file OR via environment variables (not both)
- Updated to show environment variables are optional (only for command-line use)
- Clarified that Claude Desktop and Cursor use JSON/UI configuration
- Simplified configuration section with clear 'Option 1' vs 'Option 2' choice
- No need to set env vars twice - once in config is enough
parent d9d4ffd3
...@@ -60,8 +60,13 @@ For developers who want to contribute or run the project locally, see [DEVELOPME ...@@ -60,8 +60,13 @@ For developers who want to contribute or run the project locally, see [DEVELOPME
## Configuration ## Configuration
### Environment Variables ### Option 1: Via JSON Configuration (Recommended for Claude Desktop/Cursor)
Before running the MCP server, set these environment variables:
Set your Jira credentials in the Claude Desktop or Cursor MCP configuration file and skip this section.
### Option 2: Via Environment Variables
If you're running the server from the command line manually, set these environment variables:
```bash ```bash
export JIRA_SERVER="https://your-jira-domain.com" export JIRA_SERVER="https://your-jira-domain.com"
...@@ -71,14 +76,7 @@ export JIRA_DEFAULT_PROJECT="PROJ" # Optional ...@@ -71,14 +76,7 @@ export JIRA_DEFAULT_PROJECT="PROJ" # Optional
export JIRA_QA_TESTER="tester_username" # Optional export JIRA_QA_TESTER="tester_username" # Optional
``` ```
Example for Dohatec Jira: Then run: `jira-mcp` or `python -m jira_mcp`
```bash
export JIRA_SERVER="http://103.41.111.60:8085"
export JIRA_USERNAME="shahidul"
export JIRA_PASSWORD="your-password-or-token"
export JIRA_DEFAULT_PROJECT="PCM"
export JIRA_QA_TESTER="Samia Islam"
```
### Using with Claude Desktop ### Using with Claude Desktop
...@@ -87,7 +85,7 @@ Edit your `claude_desktop_config.json`: ...@@ -87,7 +85,7 @@ Edit your `claude_desktop_config.json`:
* **Mac:** `~/Library/Application Support/Claude/claude_desktop_config.json` * **Mac:** `~/Library/Application Support/Claude/claude_desktop_config.json`
* **Windows:** `%APPDATA%\Claude\claude_desktop_config.json` * **Windows:** `%APPDATA%\Claude\claude_desktop_config.json`
**After installing via pip**, use this simple configuration: Add this configuration with your Jira credentials:
```json ```json
{ {
...@@ -106,7 +104,7 @@ Edit your `claude_desktop_config.json`: ...@@ -106,7 +104,7 @@ Edit your `claude_desktop_config.json`:
} }
``` ```
**Note:** For manual installations with custom Python paths, see [DEVELOPMENT.md](DEVELOPMENT.md). That's it! The credentials are configured in the JSON file.
### Using with Cursor ### Using with Cursor
...@@ -115,12 +113,14 @@ Edit your `claude_desktop_config.json`: ...@@ -115,12 +113,14 @@ Edit your `claude_desktop_config.json`:
3. **Name:** `Jira Server` 3. **Name:** `Jira Server`
4. **Type:** `command` 4. **Type:** `command`
5. **Command:** `jira-mcp` 5. **Command:** `jira-mcp`
6. Set environment variables in your shell before launching Cursor: 6. **Environment Variables:** Set in the UI:
```bash - `JIRA_SERVER`: `http://103.41.111.60:8085`
export JIRA_SERVER="http://103.41.111.60:8085" - `JIRA_USERNAME`: `your-username`
export JIRA_USERNAME="your-username" - `JIRA_PASSWORD`: `your-password`
export JIRA_PASSWORD="your-password" - `JIRA_DEFAULT_PROJECT`: `PCM` (optional)
``` - `JIRA_QA_TESTER`: `Samia Islam` (optional)
**Note:** For manual installations with custom Python paths, see [DEVELOPMENT.md](DEVELOPMENT.md).
--- ---
......
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