# MCP Jira Server - Project Summary
## š What Was Built
A complete Model Context Protocol (MCP) server for integrating self-hosted Jira instances with AI assistants like Claude Desktop and VS Code Copilot.
## šÆ Key Features
### Authentication
- ā
Personal Access Token (PAT) authentication for self-hosted Jira
- ā
Supports custom Jira instances (e.g., https://jira.domain.com)
- ā
Secure token handling via environment variables
### Core Functionality
- ā
**Issue Management**: Create, read, update, delete issues
- ā
**Search**: Powerful JQL-based search capabilities
- ā
**Comments**: Add and retrieve issue comments
- ā
**Assignments**: Assign and reassign issues
- ā
**Transitions**: Move issues through workflows
- ā
**Projects**: List and view project details
- ā
**User Info**: Get current authenticated user details
## š Project Structure
```
mcp-jira-server/
āāā src/
ā āāā index.ts # MCP server implementation (12 tools)
ā āāā jira-client.ts # Jira REST API client
āāā build/ # Compiled JavaScript
āāā package.json # Dependencies and scripts
āāā tsconfig.json # TypeScript configuration
āāā README.md # Complete documentation
āāā QUICKSTART.md # 5-minute setup guide
āāā .env.example # Environment variable template
āāā claude_desktop_config.example.json # Claude Desktop config
āāā vscode_mcp_config.example.json # VS Code config
```
## š Technology Stack
- **Runtime**: Node.js 18+
- **Language**: TypeScript 5.7+
- **MCP SDK**: @modelcontextprotocol/sdk 1.0.4
- **HTTP Client**: Axios 1.7.9
- **Build Tool**: TypeScript Compiler (tsc)
## š§ Available MCP Tools
1. **jira_get_issue** - Get issue details by key
2. **jira_search_issues** - Search with JQL
3. **jira_create_issue** - Create new issues
4. **jira_update_issue** - Update existing issues
5. **jira_add_comment** - Add comments to issues
6. **jira_get_comments** - Retrieve issue comments
7. **jira_get_projects** - List all projects
8. **jira_get_project** - Get project details
9. **jira_get_issue_types** - List available issue types
10. **jira_assign_issue** - Assign issues to users
11. **jira_delete_issue** - Delete issues permanently
12. **jira_get_current_user** - Get authenticated user info
## š Documentation Provided
1. **README.md** - Comprehensive guide with:
- Installation instructions
- Configuration for Claude Desktop & VS Code
- Tool reference with examples
- Troubleshooting guide
- Security best practices
2. **QUICKSTART.md** - Fast setup guide:
- Step-by-step setup in 5 minutes
- Common JQL queries
- Example prompts
- Quick troubleshooting
3. **Configuration Examples**:
- `.env.example` - Environment variables template
- `claude_desktop_config.example.json` - Claude Desktop config
- `vscode_mcp_config.example.json` - VS Code config
## š How to Use
### Installation
```bash
cd mcp-jira-server
npm install
npm run build
```
### Configuration
1. Create Personal Access Token in Jira
2. Add server config to Claude Desktop or VS Code
3. Set JIRA_BASE_URL and JIRA_PAT
4. Restart the AI assistant
### Example Usage
```
"Show me all open issues in project ABC"
"Create a new bug in project XYZ with high priority"
"Add a comment to issue ABC-123"
"Search for all issues assigned to me that are in progress"
```
## š Security Features
- No hardcoded credentials
- Environment variable configuration
- PAT-based authentication (more secure than basic auth)
- Token rotation support
- Minimal permission recommendations
- .gitignore for sensitive files
## ā
Build Status
- ā
TypeScript compilation successful
- ā
All dependencies installed
- ā
Build artifacts created in `build/` directory
- ā
No vulnerabilities found
- ā
Ready for deployment
## š What You Need to Do Next
1. **Get Your PAT**: Create a Personal Access Token in your Jira instance
2. **Configure**: Choose Claude Desktop or VS Code and update the config
3. **Test**: Try "Get my current Jira user information"
4. **Use**: Start managing Jira issues with natural language!
## š Learning Resources
- **MCP Documentation**: https://modelcontextprotocol.io
- **Jira REST API**: Check your Jira instance's API docs
- **JQL Guide**: Your Jira instance has JQL syntax documentation
## š¤ Integration Points
This MCP server works with:
- ā
Claude Desktop (recommended)
- ā
VS Code with GitHub Copilot
- ā
Any MCP-compatible client
- ā
Self-hosted Jira instances
- ā
Jira REST API v2
## š” Tips for Success
1. **Start Simple**: Test with "List all projects" first
2. **Use JQL**: Learn basic JQL for powerful searches
3. **Check Permissions**: Ensure your PAT has necessary access
4. **Monitor Usage**: Watch Jira audit logs for token activity
5. **Rotate Tokens**: Set expiration and rotate regularly
---
**Status**: ā
Complete and ready to use!
**Next Step**: Configure with your Personal Access Token and start using!