# Installation Guide
Choose your preferred installation method based on your Claude platform:
## š Claude Desktop (.dxt Format) - **RECOMMENDED**
> **New!** Use Anthropic's `.dxt` format for one-click installation.
### Quick Start
1. Download `jsm-assets-mcp.dxt`
2. Double-click to open with Claude Desktop
3. Click "Install"
4. Configure your JSM credentials in the GUI
**ā
Advantages:**
- One-click installation
- GUI configuration
- Self-contained with all dependencies
- Automatic updates
š **[Complete .dxt Installation Guide ā](./DXT-README.md)**
---
## ā” Claude Code (CLI Configuration)
> **New!** For Claude Code users - simple command-line setup.
### Quick Start
```bash
claude mcp add jsm-assets \
-e JSM_WORKSPACE_ID="your-workspace-id" \
-e JSM_AUTH_TOKEN="Basic your-encoded-token" \
-- node /path/to/jsm-assets-mcp/dist/index.js
```
### Scope Options
- **Local** (default): `claude mcp add jsm-assets ...`
- **User** (all projects): `claude mcp add jsm-assets -s user ...`
- **Project** (team shared): `claude mcp add jsm-assets -s project ...`
**ā
Advantages:**
- Command-line configuration
- Automatic server lifecycle management
- No manual server starting required
- Available immediately after configuration
---
## š ļø Traditional Installation (Manual)
### Prerequisites
- Node.js 18.0.0 or higher
- JSM Assets workspace access
- Valid authentication token
### Steps
1. **Clone and install:**
```bash
git clone <repository-url>
cd jsm-assets-mcp
npm install
npm run build
```
2. **Configure environment:**
```bash
cp .env.example .env
# Edit .env with your credentials
```
3. **Add to Claude Desktop config:**
**macOS:** `~/Library/Application Support/Claude/claude_desktop_config.json`
**Windows:** `%APPDATA%/Claude/claude_desktop_config.json`
```json
{
"mcpServers": {
"jsm-assets": {
"command": "node",
"args": ["/path/to/jsm-assets-mcp/dist/index.js"],
"env": {
"JSM_WORKSPACE_ID": "your-workspace-id",
"JSM_AUTH_TOKEN": "Basic your-encoded-token",
"JSM_BASE_URL": "https://api.atlassian.com/jsm/assets/workspace"
}
}
}
}
```
4. **Restart Claude Desktop**
š **[Complete Traditional Installation Guide ā](./README.md)**
---
## šÆ Which Method Should I Choose?
| Feature | Claude Desktop (.dxt) | Claude Code (CLI) | Traditional (Manual) |
|---------|----------------------|------------------|---------------------|
| **Ease of Installation** | āāāāā One-click | āāāā Single command | āā Manual setup |
| **Configuration** | āāāāā GUI forms | āāāā CLI flags | āā JSON editing |
| **Server Management** | āāāāā Automatic | āāāāā Automatic | āāā Manual config |
| **Updates** | āāāāā Automatic | āāā CLI update | āā Manual |
| **Customization** | āāā Limited | āāāā Flexible | āāāāā Full control |
| **Development** | āā Package building | āāāā Direct path | āāāāā Direct access |
### Choose Claude Desktop (.dxt) if:
- You use Claude Desktop app
- You want the easiest installation experience
- You prefer GUI configuration over command line
- You want automatic updates
### Choose Claude Code (CLI) if:
- You use Claude Code in VS Code or terminal
- You're comfortable with command-line tools
- You want quick setup without GUI
- You need different scopes (local/user/project)
### Choose Traditional if:
- You need to customize the server code
- You're developing or contributing to the project
- You prefer full control over the installation
- You're familiar with MCP server setup
---
## Getting Your JSM Credentials
Regardless of installation method, you'll need:
### 1. JSM Workspace ID
- Found in your JSM Assets URL
- Example: `e15ec40f-3efb-44b0-a2a5-218bea7aa637`
### 2. Authentication Token
Create in Atlassian Account Settings ā API Tokens, then encode:
```bash
# Format: email:api_token
echo -n "your-email@domain.com:ATATT3xFfGF07rP6..." | base64
# Result: eW91ci1lbWFpbEBkb21haW4uY29tOkFUQVRUM3hGZkdGMDdyUDYuLi4...
# Use as: Basic eW91ci1lbWFpbEBkb21haW4uY29tOkFUQVRUM3hGZkdGMDdyUDYuLi4...
```
### 3. Base URL (Optional)
- Default: `https://api.atlassian.com/jsm/assets/workspace`
- Only change if you have a custom Atlassian instance
---
## Next Steps
After installation, try these example queries:
- "What object schemas are available in this JSM workspace?"
- "Search for Installation Package assets that start with IASM"
- "Show me all object types for schema ID 1"
š **You're ready to start using JSM Assets with Claude!**