@pnam16/atlassian-mcp 0.0.0-stage → 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +100 -2
- package/dist/index.js +29746 -0
- package/package.json +33 -4
package/README.md
CHANGED
|
@@ -1,3 +1,101 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Atlassian self-hosted mcp
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
MCP server for self-hosted Jira and Confluence (Server/Data Center) in one process. It serves every tool of [g-jira-mcp](https://github.com/pnam16/atlassian-mcp/tree/main/packages/jira) and [conf-mcp](https://github.com/pnam16/atlassian-mcp/tree/main/packages/confluence), so an AI assistant needs one server entry instead of two.
|
|
4
|
+
|
|
5
|
+
## Requirements
|
|
6
|
+
|
|
7
|
+
- A Jira Server/Data Center account and a Confluence Server/Data Center account.
|
|
8
|
+
- Node.js 18+.
|
|
9
|
+
|
|
10
|
+
## Quick start
|
|
11
|
+
|
|
12
|
+
Use Claude Code CLI. Run the command in a regular terminal, not inside a Claude Code session. Pick the block for your shell, since each one continues lines differently.
|
|
13
|
+
|
|
14
|
+
bash / zsh (macOS, Linux, Git Bash or WSL on Windows):
|
|
15
|
+
|
|
16
|
+
```bash
|
|
17
|
+
claude mcp add atlassian-mcp \
|
|
18
|
+
-e JIRA_HOST="https://jira.company.com" \
|
|
19
|
+
-e JIRA_USERNAME="your_username" \
|
|
20
|
+
-e JIRA_PASSWORD="your_password" \
|
|
21
|
+
-e CONFLUENCE_HOST="https://conf.company.com" \
|
|
22
|
+
-e CONFLUENCE_USERNAME="your_username" \
|
|
23
|
+
-e CONFLUENCE_PASSWORD="your_password" \
|
|
24
|
+
-- npx -y @pnam16/atlassian-mcp@latest
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
PowerShell (Windows):
|
|
28
|
+
|
|
29
|
+
```powershell
|
|
30
|
+
claude mcp add atlassian-mcp `
|
|
31
|
+
-e JIRA_HOST="https://jira.company.com" `
|
|
32
|
+
-e JIRA_USERNAME="your_username" `
|
|
33
|
+
-e JIRA_PASSWORD="your_password" `
|
|
34
|
+
-e CONFLUENCE_HOST="https://conf.company.com" `
|
|
35
|
+
-e CONFLUENCE_USERNAME="your_username" `
|
|
36
|
+
-e CONFLUENCE_PASSWORD="your_password" `
|
|
37
|
+
-- npx -y @pnam16/atlassian-mcp@latest
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
Command Prompt (cmd.exe): put the whole command on one line, or end each line with `^` instead of `\`.
|
|
41
|
+
|
|
42
|
+
Or manually add to `.claude/settings.json` (or `claude_desktop_config.json`):
|
|
43
|
+
|
|
44
|
+
```json
|
|
45
|
+
{
|
|
46
|
+
"mcpServers": {
|
|
47
|
+
"atlassian-mcp": {
|
|
48
|
+
"command": "npx",
|
|
49
|
+
"args": ["-y", "@pnam16/atlassian-mcp@latest"],
|
|
50
|
+
"env": {
|
|
51
|
+
"JIRA_HOST": "https://jira.company.com",
|
|
52
|
+
"JIRA_USERNAME": "your_username",
|
|
53
|
+
"JIRA_PASSWORD": "your_password",
|
|
54
|
+
"CONFLUENCE_HOST": "https://conf.company.com",
|
|
55
|
+
"CONFLUENCE_USERNAME": "your_username",
|
|
56
|
+
"CONFLUENCE_PASSWORD": "your_password"
|
|
57
|
+
}
|
|
58
|
+
}
|
|
59
|
+
}
|
|
60
|
+
}
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
Restart Claude Code/Desktop after editing the config.
|
|
64
|
+
|
|
65
|
+
## Environment variables
|
|
66
|
+
|
|
67
|
+
| Variable | Required | Description |
|
|
68
|
+
| ----------------------- | -------- | --------------------------------------------------------------- |
|
|
69
|
+
| `JIRA_HOST` | yes | Base URL, e.g. `https://jira.company.com` |
|
|
70
|
+
| `JIRA_USERNAME` | yes* | Jira username |
|
|
71
|
+
| `JIRA_PASSWORD` | yes* | Jira password |
|
|
72
|
+
| `JIRA_TOKEN` | no | Personal Access Token; when set, replaces username/password (*) |
|
|
73
|
+
| `JIRA_START_DATE_FIELD` | no | Custom field ID for "Start date" (default `customfield_11300`) |
|
|
74
|
+
| `JIRA_EPIC_LINK_FIELD` | no | Custom field ID for "Epic Link" (default `customfield_10001`) |
|
|
75
|
+
| `JIRA_TIMEZONE` | no | Timezone for WorklogPRO form (default `Asia/Ho_Chi_Minh`) |
|
|
76
|
+
| `CONFLUENCE_HOST` | yes | Base URL, e.g. `https://conf.company.com` |
|
|
77
|
+
| `CONFLUENCE_USERNAME` | yes* | Confluence username |
|
|
78
|
+
| `CONFLUENCE_PASSWORD` | yes* | Confluence password |
|
|
79
|
+
| `CONFLUENCE_TOKEN` | no | Personal Access Token; when set, replaces username/password (*) |
|
|
80
|
+
|
|
81
|
+
## Tools
|
|
82
|
+
|
|
83
|
+
All 36 tools keep the names and parameters documented in the [g-jira-mcp](https://github.com/pnam16/atlassian-mcp/tree/main/packages/jira#tools) and [conf-mcp](https://github.com/pnam16/atlassian-mcp/tree/main/packages/confluence#tools) READMEs, except the two names both servers use, which carry a product prefix here:
|
|
84
|
+
|
|
85
|
+
| In g-jira-mcp / conf-mcp | In @pnam16/atlassian-mcp |
|
|
86
|
+
| ------------------------ | ------------------------------------------------------------ |
|
|
87
|
+
| `add_comment` | `jira_add_comment`, `confluence_add_comment` |
|
|
88
|
+
| `download_attachment` | `jira_download_attachment`, `confluence_download_attachment` |
|
|
89
|
+
|
|
90
|
+
All logs go to stderr; stdout is reserved for the MCP protocol.
|
|
91
|
+
|
|
92
|
+
## Development
|
|
93
|
+
|
|
94
|
+
```bash
|
|
95
|
+
pnpm install
|
|
96
|
+
pnpm build # bundle to dist/index.js via esbuild
|
|
97
|
+
pnpm test
|
|
98
|
+
pnpm release # release-it: runs check, test and build, then bumps version, commits, tags, pushes (commit your changes first; pnpm publish is a separate step)
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
A release of g-jira-mcp or conf-mcp reaches this package only after it is released too.
|