SETUP.mdā¢2.87 kB
# Setup Guide
This guide will help you set up the Jira MCP Server on your local machine.
## Prerequisites
- Node.js 18 or higher
- npm or yarn package manager
- A Jira account (Cloud or Data Center)
- Jira API credentials (email and API token)
## Step 1: Clone the Repository
```bash
git clone [REPOSITORY_URL_HERE]
cd jira-mcp
```
Replace `[REPOSITORY_URL_HERE]` with the actual repository URL.
## Step 2: Install Dependencies
```bash
npm install
```
**Why:** Installs all required packages including the MCP SDK, Axios for HTTP requests, and TypeScript for type safety.
## Step 3: Build the Project
```bash
npm run build
```
**Why:** Compiles TypeScript source files to JavaScript in the `build/` directory for execution.
### How to Get Your Jira API Token:
1. Go to https://id.atlassian.com/manage-profile/security/api-tokens
2. Click "Create API token"
3. Give it a label (e.g., "MCP Server")
4. Copy the generated token to your `.env` file
## Step 5: Configure MCP Client
- Create a .VsCode/mcp.json file in your project root if it doesn't exist. and Write the following configuration to connect your MCP client to the Jira MCP server.
```json
{
"mcpServers": {
"jira": {
"command": "node",
"args": ["/absolute/path/to/jira-mcp/build/index.js"],
"env": {
"JIRA_HOST": "https://your-domain.atlassian.net",
"JIRA_EMAIL": "your-email@example.com",
"JIRA_API_TOKEN": "your-api-token"
}
}
}
}
```
Replace `/absolute/path/to/jira-mcp` with the actual path to your project directory.
**Field Explanations:**
- **`servers`** - Container object for all MCP server configurations
- **`jira`** - Unique identifier for this server (you can name it anything)
- **`command`** - The executable command to run (`node` for Node.js)
- **`args`** - Array of arguments passed to the command; contains the path to the compiled server entry point
- **`${workspaceFolder}`** - VS Code variable that automatically resolves to your workspace root directory
- **`env`** - Environment variables passed to the server process:
- **`JIRA_HOST`** - Full URL of your Jira instance (must include `https://`)
- **`JIRA_EMAIL`** - Email address registered with your Jira account (used for authentication)
- **`JIRA_API_TOKEN`** - Secret token for API access (never commit this to version control!)
- **`JIRA_BOARD_ID`** - Optional default board ID for board-specific operations
## Verification
Once configured, your AI assistant should have access to Jira tools. Try asking:
- "Show me all my Jira projects"
- "Can you get a story of xxxx?"
## Additional Resources
- [Jira REST API Documentation](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/)
- [Model Context Protocol Specification](https://modelcontextprotocol.io)
- [MCP SDK Documentation](https://github.com/modelcontextprotocol/sdk)