jira-admin-mcp 0.1.0__tar.gz
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.
- jira_admin_mcp-0.1.0/.env.example +16 -0
- jira_admin_mcp-0.1.0/.gitattributes +5 -0
- jira_admin_mcp-0.1.0/.github/workflows/ci.yml +31 -0
- jira_admin_mcp-0.1.0/.github/workflows/publish.yml +37 -0
- jira_admin_mcp-0.1.0/.gitignore +39 -0
- jira_admin_mcp-0.1.0/CONTRIBUTING.md +53 -0
- jira_admin_mcp-0.1.0/LICENSE +21 -0
- jira_admin_mcp-0.1.0/PKG-INFO +361 -0
- jira_admin_mcp-0.1.0/PUBLISH.md +61 -0
- jira_admin_mcp-0.1.0/README.md +330 -0
- jira_admin_mcp-0.1.0/jira_mcp/__init__.py +3 -0
- jira_admin_mcp-0.1.0/jira_mcp/client.py +117 -0
- jira_admin_mcp-0.1.0/jira_mcp/config.py +60 -0
- jira_admin_mcp-0.1.0/jira_mcp/helpers.py +148 -0
- jira_admin_mcp-0.1.0/jira_mcp/server.py +99 -0
- jira_admin_mcp-0.1.0/jira_mcp/tools/__init__.py +1 -0
- jira_admin_mcp-0.1.0/jira_mcp/tools/bulk.py +129 -0
- jira_admin_mcp-0.1.0/jira_mcp/tools/comments.py +83 -0
- jira_admin_mcp-0.1.0/jira_mcp/tools/fields.py +439 -0
- jira_admin_mcp-0.1.0/jira_mcp/tools/filters.py +467 -0
- jira_admin_mcp-0.1.0/jira_mcp/tools/groups.py +166 -0
- jira_admin_mcp-0.1.0/jira_mcp/tools/issues.py +461 -0
- jira_admin_mcp-0.1.0/jira_mcp/tools/issuetypes.py +116 -0
- jira_admin_mcp-0.1.0/jira_mcp/tools/links.py +42 -0
- jira_admin_mcp-0.1.0/jira_mcp/tools/permissions.py +132 -0
- jira_admin_mcp-0.1.0/jira_mcp/tools/projects.py +348 -0
- jira_admin_mcp-0.1.0/jira_mcp/tools/screens.py +104 -0
- jira_admin_mcp-0.1.0/jira_mcp/tools/statuses.py +52 -0
- jira_admin_mcp-0.1.0/jira_mcp/tools/tasks.py +92 -0
- jira_admin_mcp-0.1.0/jira_mcp/tools/users.py +65 -0
- jira_admin_mcp-0.1.0/jira_mcp/tools/workflows.py +298 -0
- jira_admin_mcp-0.1.0/pyproject.toml +76 -0
- jira_admin_mcp-0.1.0/server.json +45 -0
- jira_admin_mcp-0.1.0/tests/__init__.py +0 -0
- jira_admin_mcp-0.1.0/tests/conftest.py +16 -0
- jira_admin_mcp-0.1.0/tests/test_config.py +45 -0
- jira_admin_mcp-0.1.0/tests/test_helpers.py +59 -0
- jira_admin_mcp-0.1.0/tests/test_server.py +51 -0
- jira_admin_mcp-0.1.0/uv.lock +1824 -0
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# Copy this file to .env and fill in your own values.
|
|
2
|
+
# .env is gitignored - never commit real credentials.
|
|
3
|
+
|
|
4
|
+
# Your Jira Cloud base URL (no trailing path).
|
|
5
|
+
JIRA_BASE_URL=https://your-company.atlassian.net
|
|
6
|
+
|
|
7
|
+
# The Atlassian account email that owns the API token below.
|
|
8
|
+
JIRA_EMAIL=you@your-company.com
|
|
9
|
+
|
|
10
|
+
# Create one at https://id.atlassian.com/manage-profile/security/api-tokens
|
|
11
|
+
JIRA_API_TOKEN=your_api_token_here
|
|
12
|
+
|
|
13
|
+
# Optional. When "true", every write (POST/PUT/DELETE) is simulated and
|
|
14
|
+
# returns the payload that WOULD have been sent, without calling Jira.
|
|
15
|
+
# Great for a safe first run. Defaults to "false".
|
|
16
|
+
JIRA_DRY_RUN=false
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
name: CI
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
push:
|
|
5
|
+
branches: [main, master]
|
|
6
|
+
pull_request:
|
|
7
|
+
|
|
8
|
+
jobs:
|
|
9
|
+
test:
|
|
10
|
+
runs-on: ubuntu-latest
|
|
11
|
+
strategy:
|
|
12
|
+
fail-fast: false
|
|
13
|
+
matrix:
|
|
14
|
+
python-version: ["3.10", "3.11", "3.12", "3.13"]
|
|
15
|
+
steps:
|
|
16
|
+
- uses: actions/checkout@v4
|
|
17
|
+
|
|
18
|
+
- name: Install uv
|
|
19
|
+
uses: astral-sh/setup-uv@v5
|
|
20
|
+
with:
|
|
21
|
+
python-version: ${{ matrix.python-version }}
|
|
22
|
+
enable-cache: true
|
|
23
|
+
|
|
24
|
+
- name: Install dependencies
|
|
25
|
+
run: uv sync --extra dev
|
|
26
|
+
|
|
27
|
+
- name: Lint
|
|
28
|
+
run: uv run ruff check .
|
|
29
|
+
|
|
30
|
+
- name: Test
|
|
31
|
+
run: uv run pytest -v
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
name: Publish to PyPI
|
|
2
|
+
|
|
3
|
+
# Publishes on every version tag (e.g. v0.1.0). Uses PyPI Trusted Publishing
|
|
4
|
+
# (OIDC) - no API token is stored in the repo. See PUBLISH.md for the one-time
|
|
5
|
+
# trusted-publisher setup on PyPI.
|
|
6
|
+
|
|
7
|
+
on:
|
|
8
|
+
push:
|
|
9
|
+
tags: ["v*"]
|
|
10
|
+
|
|
11
|
+
jobs:
|
|
12
|
+
build:
|
|
13
|
+
runs-on: ubuntu-latest
|
|
14
|
+
steps:
|
|
15
|
+
- uses: actions/checkout@v4
|
|
16
|
+
- name: Install uv
|
|
17
|
+
uses: astral-sh/setup-uv@v5
|
|
18
|
+
- name: Build sdist and wheel
|
|
19
|
+
run: uv build
|
|
20
|
+
- uses: actions/upload-artifact@v4
|
|
21
|
+
with:
|
|
22
|
+
name: dist
|
|
23
|
+
path: dist/
|
|
24
|
+
|
|
25
|
+
publish:
|
|
26
|
+
needs: build
|
|
27
|
+
runs-on: ubuntu-latest
|
|
28
|
+
environment: pypi
|
|
29
|
+
permissions:
|
|
30
|
+
id-token: write # required for Trusted Publishing
|
|
31
|
+
steps:
|
|
32
|
+
- uses: actions/download-artifact@v4
|
|
33
|
+
with:
|
|
34
|
+
name: dist
|
|
35
|
+
path: dist/
|
|
36
|
+
- name: Publish to PyPI
|
|
37
|
+
uses: pypa/gh-action-pypi-publish@release/v1
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
# Secrets - never commit
|
|
2
|
+
.env
|
|
3
|
+
.env.*
|
|
4
|
+
!.env.example
|
|
5
|
+
|
|
6
|
+
# Local client config (machine-specific, not for the published repo)
|
|
7
|
+
.mcp.json
|
|
8
|
+
|
|
9
|
+
# Python
|
|
10
|
+
__pycache__/
|
|
11
|
+
*.py[cod]
|
|
12
|
+
*$py.class
|
|
13
|
+
*.egg-info/
|
|
14
|
+
.eggs/
|
|
15
|
+
build/
|
|
16
|
+
dist/
|
|
17
|
+
wheels/
|
|
18
|
+
|
|
19
|
+
# Virtual environments
|
|
20
|
+
.venv/
|
|
21
|
+
venv/
|
|
22
|
+
env/
|
|
23
|
+
|
|
24
|
+
# uv
|
|
25
|
+
# (uv.lock IS committed - it pins the dependency graph)
|
|
26
|
+
|
|
27
|
+
# Test / lint caches
|
|
28
|
+
.pytest_cache/
|
|
29
|
+
.ruff_cache/
|
|
30
|
+
.mypy_cache/
|
|
31
|
+
.coverage
|
|
32
|
+
htmlcov/
|
|
33
|
+
|
|
34
|
+
# Editors / OS
|
|
35
|
+
.vscode/
|
|
36
|
+
.idea/
|
|
37
|
+
*.swp
|
|
38
|
+
.DS_Store
|
|
39
|
+
Thumbs.db
|
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
# Contributing
|
|
2
|
+
|
|
3
|
+
Thanks for your interest in improving the Jira Admin MCP server.
|
|
4
|
+
|
|
5
|
+
## Development setup
|
|
6
|
+
|
|
7
|
+
This project uses [uv](https://docs.astral.sh/uv/).
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
git clone https://github.com/its-qusai-nasr/jira-admin-mcp
|
|
11
|
+
cd jira-admin-mcp
|
|
12
|
+
uv sync --extra dev # installs runtime + dev dependencies into .venv
|
|
13
|
+
cp .env.example .env # add your own Jira credentials for live testing
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
## Before you open a PR
|
|
17
|
+
|
|
18
|
+
```bash
|
|
19
|
+
uv run ruff check . # lint
|
|
20
|
+
uv run pytest # unit tests (no network)
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
Test interactively against the MCP protocol with the Inspector:
|
|
24
|
+
|
|
25
|
+
```bash
|
|
26
|
+
npx @modelcontextprotocol/inspector uvx --from . jira-mcp
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
For changes that hit Jira, run with `JIRA_DRY_RUN=true` first so writes are simulated.
|
|
30
|
+
|
|
31
|
+
## Project layout
|
|
32
|
+
|
|
33
|
+
```
|
|
34
|
+
jira_mcp/
|
|
35
|
+
server.py FastMCP app + tool registration + server instructions
|
|
36
|
+
config.py env-var loading and validation
|
|
37
|
+
client.py async httpx client, auth, dry-run, error handling
|
|
38
|
+
helpers.py response cleaning, field projection, ADF helpers
|
|
39
|
+
tools/ one module per tool group (issues, users, fields, ...)
|
|
40
|
+
tests/ unit tests (config, helpers, tool registration)
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
## Conventions
|
|
44
|
+
|
|
45
|
+
- A tool lives in the module matching its group and is registered in that module's `register(mcp)` function.
|
|
46
|
+
- Mark read-only tools with `annotations={"readOnlyHint": True}`; mark destructive ones with `destructiveHint`.
|
|
47
|
+
- Keep docstrings generic and example-driven (e.g. `PROJ-123`, `customfield_10001`). Do not hardcode any real instance, user, or field.
|
|
48
|
+
- Every write goes through `JiraClient.post/put/delete` so dry-run is honored automatically.
|
|
49
|
+
- No em dashes in code, comments, or docs - use a hyphen, colon, or parentheses.
|
|
50
|
+
|
|
51
|
+
## Reporting issues
|
|
52
|
+
|
|
53
|
+
Please include your client (Claude Desktop, Cursor, etc.), the tool you called, and the full error message. Never paste API tokens or other secrets.
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Qusai Nasr
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
|
@@ -0,0 +1,361 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: jira-admin-mcp
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: A Model Context Protocol (MCP) server giving AI assistants 78 tools to administer a Jira Cloud site: issues, users, groups, projects, permissions, custom fields, workflows, screens, filters, and bulk operations.
|
|
5
|
+
Project-URL: Homepage, https://github.com/its-qusai-nasr/jira-admin-mcp
|
|
6
|
+
Project-URL: Repository, https://github.com/its-qusai-nasr/jira-admin-mcp
|
|
7
|
+
Project-URL: Issues, https://github.com/its-qusai-nasr/jira-admin-mcp/issues
|
|
8
|
+
Author: Qusai Nasr
|
|
9
|
+
License-Expression: MIT
|
|
10
|
+
License-File: LICENSE
|
|
11
|
+
Keywords: ai-agent,atlassian,claude,fastmcp,jira,jira-cloud,llm,mcp,model-context-protocol
|
|
12
|
+
Classifier: Development Status :: 4 - Beta
|
|
13
|
+
Classifier: Intended Audience :: Developers
|
|
14
|
+
Classifier: Intended Audience :: System Administrators
|
|
15
|
+
Classifier: Programming Language :: Python :: 3
|
|
16
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
17
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
18
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
19
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
20
|
+
Classifier: Topic :: Software Development :: Libraries
|
|
21
|
+
Classifier: Topic :: Utilities
|
|
22
|
+
Requires-Python: >=3.10
|
|
23
|
+
Requires-Dist: fastmcp>=2.0.0
|
|
24
|
+
Requires-Dist: httpx>=0.27.0
|
|
25
|
+
Requires-Dist: python-dotenv>=1.0.0
|
|
26
|
+
Provides-Extra: dev
|
|
27
|
+
Requires-Dist: pytest-asyncio>=0.23; extra == 'dev'
|
|
28
|
+
Requires-Dist: pytest>=8.0; extra == 'dev'
|
|
29
|
+
Requires-Dist: ruff>=0.6; extra == 'dev'
|
|
30
|
+
Description-Content-Type: text/markdown
|
|
31
|
+
|
|
32
|
+
# Jira Admin MCP Server
|
|
33
|
+
|
|
34
|
+
[](https://www.python.org/downloads/)
|
|
35
|
+
[](LICENSE)
|
|
36
|
+
[](https://github.com/its-qusai-nasr/jira-admin-mcp/actions/workflows/ci.yml)
|
|
37
|
+
[](https://modelcontextprotocol.io)
|
|
38
|
+
|
|
39
|
+
A [Model Context Protocol](https://modelcontextprotocol.io) server that gives an AI assistant (Claude, Cursor, VS Code, or any MCP client) **78 purpose-built tools to administer a Jira Cloud site** - not just read and create tickets, but the behind-the-scenes admin work: custom fields and where they appear, permission schemes, workflows, screens, issue-type schemes, groups, project roles, saved filters, and bulk operations.
|
|
40
|
+
|
|
41
|
+
Most Jira MCP servers cover everyday usage. This one covers **administration**, and adds safety rails (dry-run mode, shared-scheme detection, identity checks before group changes, actionable errors) so an agent can run real admin jobs end to end.
|
|
42
|
+
|
|
43
|
+
> Built with [FastMCP](https://gofastmcp.com). Talks to the Jira Cloud REST API v3 with your own Atlassian email + API token.
|
|
44
|
+
|
|
45
|
+
---
|
|
46
|
+
|
|
47
|
+
## Quick start
|
|
48
|
+
|
|
49
|
+
Two prerequisites, both one-time and quick:
|
|
50
|
+
|
|
51
|
+
1. An Atlassian **API token** (it inherits your Jira permissions, so use an account with the access you need): [create one here](https://id.atlassian.com/manage-profile/security/api-tokens).
|
|
52
|
+
2. [`uv`](https://docs.astral.sh/uv/getting-started/installation/) installed (one line; it manages Python and dependencies for you, no virtualenv).
|
|
53
|
+
|
|
54
|
+
Then add the server with the one-click button or one-line command for your tool, and fill in your three `JIRA_*` values.
|
|
55
|
+
|
|
56
|
+
### Cursor
|
|
57
|
+
|
|
58
|
+
[](https://cursor.com/en/install-mcp?name=jira-admin&config=eyJjb21tYW5kIjoidXZ4IiwiYXJncyI6WyItLWZyb20iLCJnaXQraHR0cHM6Ly9naXRodWIuY29tL2l0cy1xdXNhaS1uYXNyL2ppcmEtYWRtaW4tbWNwIiwiamlyYS1tY3AiXSwiZW52Ijp7IkpJUkFfQkFTRV9VUkwiOiJodHRwczovL3lvdXItY29tcGFueS5hdGxhc3NpYW4ubmV0IiwiSklSQV9FTUFJTCI6InlvdUB5b3VyLWNvbXBhbnkuY29tIiwiSklSQV9BUElfVE9LRU4iOiJ5b3VyX2FwaV90b2tlbl9oZXJlIn19)
|
|
59
|
+
|
|
60
|
+
Click the button, confirm in Cursor, then open `~/.cursor/mcp.json` (or **Cursor Settings -> MCP**) and set `JIRA_BASE_URL`, `JIRA_EMAIL`, and `JIRA_API_TOKEN` on the `jira-admin` entry.
|
|
61
|
+
|
|
62
|
+
### Claude Code
|
|
63
|
+
|
|
64
|
+
One command (swap in your own three values):
|
|
65
|
+
|
|
66
|
+
```bash
|
|
67
|
+
claude mcp add --scope user \
|
|
68
|
+
--env JIRA_BASE_URL=https://your-company.atlassian.net \
|
|
69
|
+
--env JIRA_EMAIL=you@your-company.com \
|
|
70
|
+
--env JIRA_API_TOKEN=your_api_token_here \
|
|
71
|
+
--transport stdio jira-admin \
|
|
72
|
+
-- uvx --from git+https://github.com/its-qusai-nasr/jira-admin-mcp jira-mcp
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
`--scope user` makes it available in every project; drop it to add only to the current one. Check with `claude mcp list`.
|
|
76
|
+
|
|
77
|
+
### VS Code
|
|
78
|
+
|
|
79
|
+
[](vscode:mcp/install?%7B%22name%22%3A%22jira-admin%22%2C%22type%22%3A%22stdio%22%2C%22command%22%3A%22uvx%22%2C%22args%22%3A%5B%22--from%22%2C%22git%2Bhttps%3A%2F%2Fgithub.com%2Fits-qusai-nasr%2Fjira-admin-mcp%22%2C%22jira-mcp%22%5D%2C%22env%22%3A%7B%22JIRA_BASE_URL%22%3A%22https%3A%2F%2Fyour-company.atlassian.net%22%2C%22JIRA_EMAIL%22%3A%22you%40your-company.com%22%2C%22JIRA_API_TOKEN%22%3A%22your_api_token_here%22%7D%7D)
|
|
80
|
+
[](vscode-insiders:mcp/install?%7B%22name%22%3A%22jira-admin%22%2C%22type%22%3A%22stdio%22%2C%22command%22%3A%22uvx%22%2C%22args%22%3A%5B%22--from%22%2C%22git%2Bhttps%3A%2F%2Fgithub.com%2Fits-qusai-nasr%2Fjira-admin-mcp%22%2C%22jira-mcp%22%5D%2C%22env%22%3A%7B%22JIRA_BASE_URL%22%3A%22https%3A%2F%2Fyour-company.atlassian.net%22%2C%22JIRA_EMAIL%22%3A%22you%40your-company.com%22%2C%22JIRA_API_TOKEN%22%3A%22your_api_token_here%22%7D%7D)
|
|
81
|
+
|
|
82
|
+
After installing, set your `JIRA_*` values on the `jira-admin` entry in `.vscode/mcp.json` (or your user `mcp.json`).
|
|
83
|
+
|
|
84
|
+
### Any other MCP client (manual)
|
|
85
|
+
|
|
86
|
+
Add this block to the client's MCP config:
|
|
87
|
+
|
|
88
|
+
```json
|
|
89
|
+
{
|
|
90
|
+
"mcpServers": {
|
|
91
|
+
"jira-admin": {
|
|
92
|
+
"command": "uvx",
|
|
93
|
+
"args": ["--from", "git+https://github.com/its-qusai-nasr/jira-admin-mcp", "jira-mcp"],
|
|
94
|
+
"env": {
|
|
95
|
+
"JIRA_BASE_URL": "https://your-company.atlassian.net",
|
|
96
|
+
"JIRA_EMAIL": "you@your-company.com",
|
|
97
|
+
"JIRA_API_TOKEN": "your_api_token_here"
|
|
98
|
+
}
|
|
99
|
+
}
|
|
100
|
+
}
|
|
101
|
+
}
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
Config file locations: **Claude Desktop** `claude_desktop_config.json` (macOS `~/Library/Application Support/Claude/`, Windows `%APPDATA%\Claude\`); **Cursor** `~/.cursor/mcp.json`; **VS Code** `.vscode/mcp.json` (note: VS Code uses a top-level `"servers"` key instead of `"mcpServers"`). Restart the client after editing; the server appears as `jira-admin` with all 78 tools.
|
|
105
|
+
|
|
106
|
+
### Local clone (for development)
|
|
107
|
+
|
|
108
|
+
```bash
|
|
109
|
+
git clone https://github.com/its-qusai-nasr/jira-admin-mcp
|
|
110
|
+
cd jira-admin-mcp
|
|
111
|
+
uv sync # creates .venv and installs deps from uv.lock
|
|
112
|
+
cp .env.example .env # then edit .env with your Jira credentials
|
|
113
|
+
uv run jira-mcp # starts the server over stdio
|
|
114
|
+
```
|
|
115
|
+
|
|
116
|
+
---
|
|
117
|
+
|
|
118
|
+
## Configuration
|
|
119
|
+
|
|
120
|
+
The server reads its settings from environment variables (passed via the `env` block above, or from a `.env` file in the project directory when you run a local clone).
|
|
121
|
+
|
|
122
|
+
| Variable | Required | Description |
|
|
123
|
+
|---|---|---|
|
|
124
|
+
| `JIRA_BASE_URL` | yes | Your Jira Cloud base URL, e.g. `https://your-company.atlassian.net` |
|
|
125
|
+
| `JIRA_EMAIL` | yes | The Atlassian account email that owns the API token |
|
|
126
|
+
| `JIRA_API_TOKEN` | yes | API token from <https://id.atlassian.com/manage-profile/security/api-tokens> |
|
|
127
|
+
| `JIRA_DRY_RUN` | no | `true` simulates all writes (POST/PUT/DELETE) and returns the payload that *would* be sent, without calling Jira. Defaults to `false`. |
|
|
128
|
+
|
|
129
|
+
> **Tip:** set `JIRA_DRY_RUN=true` for your first session. Every write tool will return a `{"dry_run": true, "would_call": ...}` preview so you can watch what the agent intends to do before letting it touch live data.
|
|
130
|
+
|
|
131
|
+
---
|
|
132
|
+
|
|
133
|
+
## What you can ask for
|
|
134
|
+
|
|
135
|
+
Once connected, the assistant can do things like:
|
|
136
|
+
|
|
137
|
+
- "Add `alice@example.com` to the `jira-developers` group."
|
|
138
|
+
- "Scope the `Team` custom field to projects ENG and OPS only, for the Story and Bug issue types."
|
|
139
|
+
- "Which projects share permission scheme 10789? I want to edit it without breaking the others."
|
|
140
|
+
- "Move every `Internal Task` in project OPS to the `Task` type, then transition the open ones to In Progress."
|
|
141
|
+
- "Create a saved filter for unresolved bugs assigned to me and share it with the developers group."
|
|
142
|
+
- "Show me the change history for PROJ-123 and tell me who reopened it."
|
|
143
|
+
|
|
144
|
+
---
|
|
145
|
+
|
|
146
|
+
## Tools (78 total)
|
|
147
|
+
|
|
148
|
+
<details>
|
|
149
|
+
<summary><b>Issues (12)</b></summary>
|
|
150
|
+
|
|
151
|
+
| Tool | Description |
|
|
152
|
+
|---|---|
|
|
153
|
+
| `jira_issues_search` | Search issues using JQL with pagination |
|
|
154
|
+
| `jira_issues_get` | Get single issue by key (summary or full detail) |
|
|
155
|
+
| `jira_issues_create` | Create issue with project, type, fields |
|
|
156
|
+
| `jira_issues_update` | Update fields on existing issue |
|
|
157
|
+
| `jira_issues_transition` | Transition to new status (auto-resolves transition ID) |
|
|
158
|
+
| `jira_issues_assign` | Assign/unassign issue |
|
|
159
|
+
| `jira_issues_get_transitions` | List available workflow transitions |
|
|
160
|
+
| `jira_issues_get_createmeta` | Get required fields for creating issues |
|
|
161
|
+
| `jira_issues_delete` | Delete an issue permanently |
|
|
162
|
+
| `jira_issues_link` | Create a link between two issues |
|
|
163
|
+
| `jira_issues_get_changelog` | Get audit history (who changed what) |
|
|
164
|
+
| `jira_issues_bulk_create` | Bulk create up to 50 issues |
|
|
165
|
+
</details>
|
|
166
|
+
|
|
167
|
+
<details>
|
|
168
|
+
<summary><b>Comments (2)</b></summary>
|
|
169
|
+
|
|
170
|
+
| Tool | Description |
|
|
171
|
+
|---|---|
|
|
172
|
+
| `jira_comments_list` | List comments on an issue |
|
|
173
|
+
| `jira_comments_add` | Add comment (plain text auto-converted to ADF) |
|
|
174
|
+
</details>
|
|
175
|
+
|
|
176
|
+
<details>
|
|
177
|
+
<summary><b>Users (2)</b></summary>
|
|
178
|
+
|
|
179
|
+
| Tool | Description |
|
|
180
|
+
|---|---|
|
|
181
|
+
| `jira_users_search` | Search by email or display name |
|
|
182
|
+
| `jira_users_get` | Get user details + groups by account ID |
|
|
183
|
+
</details>
|
|
184
|
+
|
|
185
|
+
<details>
|
|
186
|
+
<summary><b>Groups (6)</b></summary>
|
|
187
|
+
|
|
188
|
+
| Tool | Description |
|
|
189
|
+
|---|---|
|
|
190
|
+
| `jira_groups_list` | List groups with member counts |
|
|
191
|
+
| `jira_groups_get_members` | Get members of a group |
|
|
192
|
+
| `jira_groups_add_user` | Add user to group |
|
|
193
|
+
| `jira_groups_remove_user` | Remove user from group |
|
|
194
|
+
| `jira_groups_create` | Create a new group |
|
|
195
|
+
| `jira_groups_delete` | Delete a group |
|
|
196
|
+
</details>
|
|
197
|
+
|
|
198
|
+
<details>
|
|
199
|
+
<summary><b>Projects (10)</b></summary>
|
|
200
|
+
|
|
201
|
+
| Tool | Description |
|
|
202
|
+
|---|---|
|
|
203
|
+
| `jira_projects_list` | List projects filtered by name/key |
|
|
204
|
+
| `jira_projects_get` | Get project details + issue types |
|
|
205
|
+
| `jira_projects_get_statuses` | All statuses grouped by issue type |
|
|
206
|
+
| `jira_projects_get_roles` | Roles with actors (users/groups) |
|
|
207
|
+
| `jira_projects_update_role` | Add/remove actors from project roles |
|
|
208
|
+
| `jira_projects_get_versions` | List versions/releases in a project |
|
|
209
|
+
| `jira_projects_create_version` | Create a new version/release |
|
|
210
|
+
| `jira_projects_get_features` | Get enabled/disabled features |
|
|
211
|
+
| `jira_projects_get_notification_scheme` | Get notification scheme |
|
|
212
|
+
| `jira_projects_get_categories` | List project categories |
|
|
213
|
+
</details>
|
|
214
|
+
|
|
215
|
+
<details>
|
|
216
|
+
<summary><b>Permissions (4)</b></summary>
|
|
217
|
+
|
|
218
|
+
| Tool | Description |
|
|
219
|
+
|---|---|
|
|
220
|
+
| `jira_permissions_list_schemes` | List all permission schemes |
|
|
221
|
+
| `jira_permissions_get_scheme` | Get scheme with all grants |
|
|
222
|
+
| `jira_permissions_add_grant` | Add permission grant to scheme |
|
|
223
|
+
| `jira_permissions_assign_scheme` | Assign scheme to project |
|
|
224
|
+
</details>
|
|
225
|
+
|
|
226
|
+
<details>
|
|
227
|
+
<summary><b>Custom Fields (12)</b></summary>
|
|
228
|
+
|
|
229
|
+
| Tool | Description |
|
|
230
|
+
|---|---|
|
|
231
|
+
| `jira_fields_search` | Search fields by name, find field IDs |
|
|
232
|
+
| `jira_fields_get_contexts` | Get contexts for a custom field |
|
|
233
|
+
| `jira_fields_get_options` | Get options for select/dropdown fields |
|
|
234
|
+
| `jira_fields_manage_options` | Add, update, or reorder field options |
|
|
235
|
+
| `jira_fields_create_context` | Create a context, optionally scoped to projects/issue types |
|
|
236
|
+
| `jira_fields_update_context` | Rename or re-describe a context |
|
|
237
|
+
| `jira_fields_delete_context` | Delete a context and its options |
|
|
238
|
+
| `jira_fields_assign_context_projects` | Scope a context to specific projects |
|
|
239
|
+
| `jira_fields_remove_context_projects` | Unscope projects from a context |
|
|
240
|
+
| `jira_fields_add_context_issuetypes` | Restrict a context to specific issue types |
|
|
241
|
+
| `jira_fields_remove_context_issuetypes` | Remove issue types from a context |
|
|
242
|
+
| `jira_fields_get_project_mapping` | Audit which projects each context covers |
|
|
243
|
+
</details>
|
|
244
|
+
|
|
245
|
+
<details>
|
|
246
|
+
<summary><b>Filters (10)</b></summary>
|
|
247
|
+
|
|
248
|
+
| Tool | Description |
|
|
249
|
+
|---|---|
|
|
250
|
+
| `jira_filters_search` | Search saved JQL filters |
|
|
251
|
+
| `jira_filters_create` | Create a new saved JQL filter |
|
|
252
|
+
| `jira_filters_get` | Get a filter with owner + share permissions |
|
|
253
|
+
| `jira_filters_update` | Update name/JQL/description |
|
|
254
|
+
| `jira_filters_delete` | Delete a filter permanently |
|
|
255
|
+
| `jira_filters_change_owner` | Change a filter's owner |
|
|
256
|
+
| `jira_filters_get_shares` | List a filter's share permissions |
|
|
257
|
+
| `jira_filters_add_share` | Add a share (requires you own the filter) |
|
|
258
|
+
| `jira_filters_remove_share` | Remove a share permission |
|
|
259
|
+
| `jira_filters_force_add_share` | Add a share to a filter you don't own (owner-swap workaround) |
|
|
260
|
+
</details>
|
|
261
|
+
|
|
262
|
+
<details>
|
|
263
|
+
<summary><b>Issue Links, Statuses (2)</b></summary>
|
|
264
|
+
|
|
265
|
+
| Tool | Description |
|
|
266
|
+
|---|---|
|
|
267
|
+
| `jira_issue_link_types_list` | List available link types (Blocks, Relates, etc.) |
|
|
268
|
+
| `jira_statuses_search` | Search statuses across the instance |
|
|
269
|
+
</details>
|
|
270
|
+
|
|
271
|
+
<details>
|
|
272
|
+
<summary><b>Workflows (8)</b></summary>
|
|
273
|
+
|
|
274
|
+
| Tool | Description |
|
|
275
|
+
|---|---|
|
|
276
|
+
| `jira_workflows_search` | Search workflows by name |
|
|
277
|
+
| `jira_workflows_get_schemes` | List workflow schemes |
|
|
278
|
+
| `jira_workflows_get_scheme_mappings` | Issue type to workflow mappings |
|
|
279
|
+
| `jira_workflows_get_scheme_project_usages` | List projects using a scheme (shared-scheme safety check) |
|
|
280
|
+
| `jira_workflows_set_scheme_issuetype` | Map an issue type to a workflow |
|
|
281
|
+
| `jira_workflows_delete_scheme_issuetype` | Remove an issue type's workflow mapping |
|
|
282
|
+
| `jira_workflows_create_scheme_draft` | Create an editable draft of a scheme |
|
|
283
|
+
| `jira_workflows_publish_scheme_draft` | Publish a scheme draft, making it live |
|
|
284
|
+
</details>
|
|
285
|
+
|
|
286
|
+
<details>
|
|
287
|
+
<summary><b>Issue Types, Screens (6)</b></summary>
|
|
288
|
+
|
|
289
|
+
| Tool | Description |
|
|
290
|
+
|---|---|
|
|
291
|
+
| `jira_issuetypes_list` | List issue types (optionally by project) |
|
|
292
|
+
| `jira_issuetypes_get_schemes` | List issue type schemes |
|
|
293
|
+
| `jira_issuetypes_get_scheme_mappings` | Issue types in a scheme |
|
|
294
|
+
| `jira_screens_list` | List screens |
|
|
295
|
+
| `jira_screens_get_fields` | Get fields on screen tabs |
|
|
296
|
+
| `jira_screens_get_schemes` | List screen schemes |
|
|
297
|
+
</details>
|
|
298
|
+
|
|
299
|
+
<details>
|
|
300
|
+
<summary><b>Bulk Operations, Tasks (4)</b></summary>
|
|
301
|
+
|
|
302
|
+
| Tool | Description |
|
|
303
|
+
|---|---|
|
|
304
|
+
| `jira_bulk_edit_issues` | Bulk edit fields on multiple issues |
|
|
305
|
+
| `jira_bulk_transition_issues` | Bulk transition issues to new status |
|
|
306
|
+
| `jira_tasks_get_status` | Poll a generic task or bulk-queue task by ID |
|
|
307
|
+
| `jira_tasks_cancel` | Request cancellation of a generic async task |
|
|
308
|
+
</details>
|
|
309
|
+
|
|
310
|
+
---
|
|
311
|
+
|
|
312
|
+
## Design notes
|
|
313
|
+
|
|
314
|
+
- **Consolidate, don't wrap** - 78 workflow-oriented tools rather than a 1:1 mirror of every REST endpoint.
|
|
315
|
+
- **Dry run** - `JIRA_DRY_RUN=true` makes all write ops return simulated payloads.
|
|
316
|
+
- **Response filtering** - strips `self`, `_links`, `avatarUrls`, and similar noise so the agent sees only useful fields.
|
|
317
|
+
- **Detail levels** - read tools take `detail="summary"` (default) or `detail="full"`.
|
|
318
|
+
- **ADF auto-wrap** - plain text in comments/descriptions is auto-converted to Atlassian Document Format.
|
|
319
|
+
- **Transition resolution** - `jira_issues_transition` resolves a status name to its transition ID automatically.
|
|
320
|
+
- **Actionable errors** - error messages say what went wrong and what to try next.
|
|
321
|
+
- **Token-auth scope** - webhook endpoints (`/webhook`) are intentionally not wrapped; Atlassian restricts them to Connect / OAuth 2.0 apps that token auth cannot satisfy.
|
|
322
|
+
|
|
323
|
+
---
|
|
324
|
+
|
|
325
|
+
## Testing locally
|
|
326
|
+
|
|
327
|
+
Inspect and call tools interactively with the [MCP Inspector](https://modelcontextprotocol.io/docs/tools/inspector):
|
|
328
|
+
|
|
329
|
+
```bash
|
|
330
|
+
npx @modelcontextprotocol/inspector uvx --from . jira-mcp
|
|
331
|
+
```
|
|
332
|
+
|
|
333
|
+
Run the unit tests (no network calls):
|
|
334
|
+
|
|
335
|
+
```bash
|
|
336
|
+
uv sync --extra dev
|
|
337
|
+
uv run pytest
|
|
338
|
+
uv run ruff check .
|
|
339
|
+
```
|
|
340
|
+
|
|
341
|
+
---
|
|
342
|
+
|
|
343
|
+
## Security
|
|
344
|
+
|
|
345
|
+
- **Never commit credentials.** `.env` is gitignored; use the `env` block in your client config or your OS secret manager.
|
|
346
|
+
- **Least privilege.** The API token acts as your Jira user. Use an account scoped to only what you need, especially for write/admin tools.
|
|
347
|
+
- **Start in dry-run.** `JIRA_DRY_RUN=true` lets you review every intended write before going live.
|
|
348
|
+
- See the official [MCP security best practices](https://modelcontextprotocol.io/docs/tutorials/security/security_best_practices).
|
|
349
|
+
|
|
350
|
+
---
|
|
351
|
+
|
|
352
|
+
## Contributing
|
|
353
|
+
|
|
354
|
+
Issues and PRs welcome. See [CONTRIBUTING.md](CONTRIBUTING.md).
|
|
355
|
+
|
|
356
|
+
## License
|
|
357
|
+
|
|
358
|
+
[MIT](LICENSE)
|
|
359
|
+
|
|
360
|
+
<!-- mcp-name: io.github.its-qusai-nasr/jira-admin-mcp -->
|
|
361
|
+
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
# Publishing checklist
|
|
2
|
+
|
|
3
|
+
This repo is ready to publish. Owner/repo are already set to
|
|
4
|
+
`its-qusai-nasr/jira-admin-mcp` throughout (README, pyproject, server.json,
|
|
5
|
+
CONTRIBUTING). Start at step 1.
|
|
6
|
+
|
|
7
|
+
## 0. (done) OWNER placeholder replaced
|
|
8
|
+
|
|
9
|
+
All URLs, badges, and the `mcp-name:` marker now point at
|
|
10
|
+
`https://github.com/its-qusai-nasr/jira-admin-mcp`. Nothing to do here unless
|
|
11
|
+
you rename the repo - in which case update those same files and, to keep the
|
|
12
|
+
PyPI/import names matching, also `name` in `pyproject.toml` and the `jira_mcp/`
|
|
13
|
+
package dir.
|
|
14
|
+
|
|
15
|
+
## 1. Create the GitHub repo and push
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
git remote add origin https://github.com/its-qusai-nasr/jira-admin-mcp.git
|
|
19
|
+
git push -u origin main
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
CI (`.github/workflows/ci.yml`) runs lint + tests on Python 3.10-3.13 automatically.
|
|
23
|
+
|
|
24
|
+
## 2. PyPI Trusted Publishing (one time, no tokens)
|
|
25
|
+
|
|
26
|
+
1. Reserve the name `jira-admin-mcp` on <https://pypi.org> (it must be free; if
|
|
27
|
+
taken, change `name` in `pyproject.toml` and the docs).
|
|
28
|
+
2. On PyPI: **Your projects -> jira-admin-mcp -> Publishing -> Add a pending
|
|
29
|
+
publisher**:
|
|
30
|
+
- Owner: `its-qusai-nasr`
|
|
31
|
+
- Repository: `jira-admin-mcp`
|
|
32
|
+
- Workflow: `publish.yml`
|
|
33
|
+
- Environment: `pypi`
|
|
34
|
+
3. Tag a release - the publish workflow builds and uploads via OIDC:
|
|
35
|
+
|
|
36
|
+
```bash
|
|
37
|
+
git tag v0.1.0
|
|
38
|
+
git push origin v0.1.0
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
## 3. List on the MCP Registry (optional)
|
|
42
|
+
|
|
43
|
+
`server.json` is ready (PyPI package + stdio transport + env vars). After the
|
|
44
|
+
PyPI release is live:
|
|
45
|
+
|
|
46
|
+
1. Install the registry CLI: see <https://github.com/modelcontextprotocol/registry>.
|
|
47
|
+
2. Authenticate with GitHub (this proves ownership of the
|
|
48
|
+
`io.github.its-qusai-nasr/...` namespace) and publish:
|
|
49
|
+
|
|
50
|
+
```bash
|
|
51
|
+
mcp-publisher login github
|
|
52
|
+
mcp-publisher publish
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
The registry verifies namespace ownership against the `mcp-name:` marker that is
|
|
56
|
+
already in `README.md` (it ships in the PyPI long description).
|
|
57
|
+
|
|
58
|
+
## 4. After publishing
|
|
59
|
+
|
|
60
|
+
- Confirm `uvx jira-admin-mcp` works from a clean machine.
|
|
61
|
+
- The README badges (PyPI version, CI) light up once the repo + first release exist.
|