backlog-mcp 1.0.2__py3-none-any.whl → 1.0.4__py3-none-any.whl
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.
- app/server_settings.py +0 -3
- app/tools/get_issue_details.py +4 -1
- app/tools/get_user_issue_list.py +10 -52
- app/utils/ultils.py +62 -29
- {backlog_mcp-1.0.2.dist-info → backlog_mcp-1.0.4.dist-info}/METADATA +3 -18
- {backlog_mcp-1.0.2.dist-info → backlog_mcp-1.0.4.dist-info}/RECORD +8 -8
- {backlog_mcp-1.0.2.dist-info → backlog_mcp-1.0.4.dist-info}/WHEEL +0 -0
- {backlog_mcp-1.0.2.dist-info → backlog_mcp-1.0.4.dist-info}/entry_points.txt +0 -0
app/server_settings.py
CHANGED
app/tools/get_issue_details.py
CHANGED
|
@@ -4,13 +4,15 @@ from app.utils.ultils import get_issue_detail_handler
|
|
|
4
4
|
|
|
5
5
|
async def get_issue_details(
|
|
6
6
|
issue_key: str,
|
|
7
|
-
|
|
7
|
+
include_comments: bool,
|
|
8
|
+
timezone: str = "UTC",
|
|
8
9
|
):
|
|
9
10
|
"""
|
|
10
11
|
Get details of a Backlog issue by its key.
|
|
11
12
|
|
|
12
13
|
Args:
|
|
13
14
|
issue_key (str): The key of the Backlog issue to retrieve.
|
|
15
|
+
include_comments (bool): Whether to include comments in the response.
|
|
14
16
|
timezone (str, optional): The timezone to format datetime fields. Defaults to "UTC".
|
|
15
17
|
"""
|
|
16
18
|
try:
|
|
@@ -22,6 +24,7 @@ async def get_issue_details(
|
|
|
22
24
|
api_key=ctx.api_key,
|
|
23
25
|
issue_key=issue_key,
|
|
24
26
|
timezone=timezone,
|
|
27
|
+
include_comments=include_comments,
|
|
25
28
|
)
|
|
26
29
|
return result
|
|
27
30
|
except Exception as e:
|
app/tools/get_user_issue_list.py
CHANGED
|
@@ -1,69 +1,27 @@
|
|
|
1
1
|
from app.utils.di import create_backlog_context
|
|
2
|
-
from app.utils.ultils import get_user_task
|
|
2
|
+
from app.utils.ultils import get_user_task, get_current_user
|
|
3
3
|
|
|
4
|
-
from app.server_settings import settings
|
|
5
4
|
|
|
6
|
-
|
|
7
|
-
async def get_user_issue_list(
|
|
8
|
-
project_ids: list[int] | None = None,
|
|
9
|
-
assignee_ids: list[int] | None = None,
|
|
10
|
-
status_ids: list[int] | None = None,
|
|
11
|
-
milestone_ids: list[int] | None = None,
|
|
12
|
-
parent_issue_ids: list[int] | None = None,
|
|
13
|
-
created_since: str | None = None,
|
|
14
|
-
created_until: str | None = None,
|
|
15
|
-
updated_since: str | None = None,
|
|
16
|
-
updated_until: str | None = None,
|
|
17
|
-
start_date_since: str | None = None,
|
|
18
|
-
start_date_until: str | None = None,
|
|
19
|
-
due_date_since: str | None = None,
|
|
20
|
-
due_date_until: str | None = None,
|
|
21
|
-
):
|
|
5
|
+
async def get_user_issue_list():
|
|
22
6
|
"""
|
|
23
|
-
Retrieves a
|
|
24
|
-
|
|
25
|
-
Args:
|
|
26
|
-
project_ids (list[int], optional): List of project IDs to filter issues.
|
|
27
|
-
assignee_ids (list[int], optional): List of assignee IDs to filter issues (defaults to current user).
|
|
28
|
-
status_ids (list[int], optional): List of status IDs to filter issues (defaults to all non-closed statuses).
|
|
29
|
-
milestone_ids (list[int], optional): List of milestone IDs to filter issues.
|
|
30
|
-
parent_issue_ids (list[int], optional): List of parent issue IDs to filter issues.
|
|
31
|
-
|
|
32
|
-
created_since (str, optional): Created since (YYYY-MM-DD).
|
|
33
|
-
created_until (str, optional): Created until (YYYY-MM-DD).
|
|
34
|
-
|
|
35
|
-
updated_since (str, optional): Updated since (YYYY-MM-DD).
|
|
36
|
-
updated_until (str, optional): Updated until (YYYY-MM-DD).
|
|
37
|
-
|
|
38
|
-
start_date_since (str, optional): Start Date since (YYYY-MM-DD).
|
|
39
|
-
start_date_until (str, optional): Start Date until (YYYY-MM-DD).
|
|
7
|
+
Retrieves a list of issues assigned to the current user from Backlog.
|
|
40
8
|
|
|
41
|
-
|
|
42
|
-
|
|
9
|
+
This function automatically determines the current user's ID via API
|
|
10
|
+
and returns only issues assigned to that user.
|
|
43
11
|
"""
|
|
44
12
|
|
|
45
13
|
try:
|
|
46
14
|
ctx = create_backlog_context()
|
|
47
15
|
|
|
48
|
-
|
|
49
|
-
|
|
16
|
+
# Fetch current user information
|
|
17
|
+
current_user = await get_current_user(ctx.backlog_domain, ctx.api_key)
|
|
18
|
+
current_user_id = current_user["id"]
|
|
50
19
|
|
|
20
|
+
# Get issues assigned to current user
|
|
51
21
|
issue_list = await get_user_task(
|
|
52
22
|
backlog_domain=ctx.backlog_domain,
|
|
53
23
|
api_key=ctx.api_key,
|
|
54
|
-
|
|
55
|
-
assignee_ids=assignee_ids,
|
|
56
|
-
status_ids=status_ids,
|
|
57
|
-
milestone_ids=milestone_ids,
|
|
58
|
-
parent_issue_ids=parent_issue_ids,
|
|
59
|
-
created_since=created_since,
|
|
60
|
-
created_until=created_until,
|
|
61
|
-
updated_since=updated_since,
|
|
62
|
-
updated_until=updated_until,
|
|
63
|
-
start_date_since=start_date_since,
|
|
64
|
-
start_date_until=start_date_until,
|
|
65
|
-
due_date_since=due_date_since,
|
|
66
|
-
due_date_until=due_date_until
|
|
24
|
+
assignee_ids=[current_user_id]
|
|
67
25
|
)
|
|
68
26
|
return issue_list
|
|
69
27
|
except Exception as e:
|
app/utils/ultils.py
CHANGED
|
@@ -46,28 +46,29 @@ def time_in_range(time: str, start_range: str, end_range: str):
|
|
|
46
46
|
return start_range_time <= time_to_be_compared <= end_range_time
|
|
47
47
|
|
|
48
48
|
|
|
49
|
-
def process_issue_detail(issue_detail, timezone, issue_key):
|
|
49
|
+
def process_issue_detail(issue_detail, timezone, issue_key, include_comments: bool = True):
|
|
50
50
|
processed_issue = {
|
|
51
51
|
"issue_key": issue_key,
|
|
52
52
|
"summary": issue_detail["summary"],
|
|
53
53
|
"description": issue_detail["description"]
|
|
54
54
|
}
|
|
55
55
|
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
56
|
+
if include_comments:
|
|
57
|
+
comments = issue_detail.get("comments", [])
|
|
58
|
+
if comments:
|
|
59
|
+
# Sort comments by created_at (created field)
|
|
60
|
+
sorted_comments = sorted(comments, key=lambda c: convert_to_timezone(timezone, c["created"]))
|
|
61
|
+
# Create list of {content, created_by} where created_by is just the name
|
|
62
|
+
processed_comments = [
|
|
63
|
+
{
|
|
64
|
+
"content": c["content"],
|
|
65
|
+
"created_by": c["createdUser"]["name"] if c.get("createdUser") else None
|
|
66
|
+
}
|
|
67
|
+
for c in sorted_comments if c.get("content")
|
|
68
|
+
]
|
|
69
|
+
# Filter out None created_by if any (though should not happen)
|
|
70
|
+
processed_comments = [c for c in processed_comments if c["created_by"]]
|
|
71
|
+
processed_issue["comments"] = processed_comments
|
|
71
72
|
|
|
72
73
|
return processed_issue
|
|
73
74
|
|
|
@@ -77,6 +78,7 @@ async def get_issue_detail_handler(
|
|
|
77
78
|
api_key: str,
|
|
78
79
|
issue_key: str,
|
|
79
80
|
timezone: str,
|
|
81
|
+
include_comments: bool = True,
|
|
80
82
|
):
|
|
81
83
|
issue_comments_url = f"{backlog_domain}api/v2/issues/{issue_key}/comments"
|
|
82
84
|
issue_detail_url = f"{backlog_domain}api/v2/issues/{issue_key}"
|
|
@@ -85,31 +87,38 @@ async def get_issue_detail_handler(
|
|
|
85
87
|
async with httpx.AsyncClient() as client:
|
|
86
88
|
try:
|
|
87
89
|
issue_detail_response = client.get(issue_detail_url, params=params)
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
90
|
+
|
|
91
|
+
if include_comments:
|
|
92
|
+
comments_response = client.get(issue_comments_url, params=params)
|
|
93
|
+
results = await asyncio.gather(issue_detail_response, comments_response)
|
|
94
|
+
issue_detail_result = results[0]
|
|
95
|
+
comments_result = results[1]
|
|
96
|
+
issue_detail = issue_detail_result.json()
|
|
97
|
+
issue_comment = comments_result.json()
|
|
98
|
+
else:
|
|
99
|
+
issue_detail_result = await issue_detail_response
|
|
100
|
+
issue_detail = issue_detail_result.json()
|
|
101
|
+
issue_comment = []
|
|
94
102
|
|
|
95
|
-
if not
|
|
103
|
+
if not issue_detail_result.is_success:
|
|
96
104
|
error_code = issue_detail["errors"][0]["code"]
|
|
97
105
|
return {
|
|
98
106
|
"error_msg": BacklogApiError.get_description_by_code(error_code),
|
|
99
107
|
}
|
|
100
108
|
|
|
101
|
-
if not
|
|
109
|
+
if include_comments and not comments_result.is_success:
|
|
102
110
|
error_code = issue_comment["errors"][0]["code"]
|
|
103
111
|
return {
|
|
104
112
|
"error_msg": BacklogApiError.get_description_by_code(error_code),
|
|
105
113
|
}
|
|
106
114
|
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
115
|
+
if include_comments:
|
|
116
|
+
comments_in_time_range = []
|
|
117
|
+
for comment in issue_comment:
|
|
118
|
+
comments_in_time_range.append(comment)
|
|
119
|
+
issue_detail.update({"comments": comments_in_time_range})
|
|
110
120
|
|
|
111
|
-
issue_detail
|
|
112
|
-
processed_detail = process_issue_detail(issue_detail, timezone, issue_key)
|
|
121
|
+
processed_detail = process_issue_detail(issue_detail, timezone, issue_key, include_comments)
|
|
113
122
|
return processed_detail
|
|
114
123
|
|
|
115
124
|
except Exception as e:
|
|
@@ -267,3 +276,27 @@ async def get_project_list(backlog_domain: str, api_key: str) -> list[int]:
|
|
|
267
276
|
raise ValueError(f"Failed to get project list: {e}") from e
|
|
268
277
|
except Exception as e:
|
|
269
278
|
raise ValueError(f"Unexpected error while getting project list: {e}") from e
|
|
279
|
+
|
|
280
|
+
|
|
281
|
+
async def get_current_user(backlog_domain: str, api_key: str) -> dict:
|
|
282
|
+
"""Get current user information from Backlog API.
|
|
283
|
+
|
|
284
|
+
Returns:
|
|
285
|
+
dict: {"id": int, "name": str}
|
|
286
|
+
"""
|
|
287
|
+
url = f"{backlog_domain}api/v2/users/myself"
|
|
288
|
+
params = {"apiKey": api_key}
|
|
289
|
+
|
|
290
|
+
async with httpx.AsyncClient() as client:
|
|
291
|
+
try:
|
|
292
|
+
response = await client.get(url, params=params, timeout=10.0)
|
|
293
|
+
response.raise_for_status()
|
|
294
|
+
data = response.json()
|
|
295
|
+
return {
|
|
296
|
+
"id": data["id"],
|
|
297
|
+
"name": data["name"]
|
|
298
|
+
}
|
|
299
|
+
except httpx.HTTPError as e:
|
|
300
|
+
raise ValueError(f"Failed to get current user: {e}") from e
|
|
301
|
+
except Exception as e:
|
|
302
|
+
raise ValueError(f"Unexpected error while getting current user: {e}") from e
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: backlog-mcp
|
|
3
|
-
Version: 1.0.
|
|
3
|
+
Version: 1.0.4
|
|
4
4
|
Summary: A Model Context Protocol (MCP) server for Backlog project management integration
|
|
5
5
|
Author-email: BaoNguyen <baonguyen@teqnological.asia>
|
|
6
6
|
Requires-Python: <3.14,>=3.13
|
|
@@ -55,22 +55,9 @@ Get detailed information about a Backlog issue by its issue key.
|
|
|
55
55
|
|
|
56
56
|
### `get_user_issue_list`
|
|
57
57
|
|
|
58
|
-
Retrieve a
|
|
58
|
+
Retrieve a list of issues assigned to the current user.
|
|
59
59
|
|
|
60
|
-
|
|
61
|
-
- `project_ids` (List[int], optional): List of project IDs.
|
|
62
|
-
- `assignee_ids` (List[int], optional): List of assignee IDs (defaults to current user).
|
|
63
|
-
- `status_ids` (List[int], optional): List of status IDs (defaults to non-closed).
|
|
64
|
-
- `milestone_ids` (List[int], optional): List of milestone IDs.
|
|
65
|
-
- `parent_issue_ids` (List[int], optional): List of parent issue IDs.
|
|
66
|
-
- `created_since` (str, optional): Created since (YYYY-MM-DD).
|
|
67
|
-
- `created_until` (str, optional): Created until (YYYY-MM-DD).
|
|
68
|
-
- `updated_since` (str, optional): Updated since (YYYY-MM-DD).
|
|
69
|
-
- `updated_until` (str, optional): Updated until (YYYY-MM-DD).
|
|
70
|
-
- `start_date_since` (str, optional): Start Date since (YYYY-MM-DD).
|
|
71
|
-
- `start_date_until` (str, optional): Start Date until (YYYY-MM-DD).
|
|
72
|
-
- `due_date_since` (str, optional): Due Date since (YYYY-MM-DD).
|
|
73
|
-
- `due_date_until` (str, optional): Due Date until (YYYY-MM-DD).
|
|
60
|
+
This tool automatically determines the current user's ID and returns only issues assigned to that user. No parameters are required.
|
|
74
61
|
|
|
75
62
|
## Running the Server Locally
|
|
76
63
|
|
|
@@ -89,13 +76,11 @@ Create a `.env` file in the root directory and add the following environment var
|
|
|
89
76
|
# Backlog API Settings
|
|
90
77
|
BACKLOG_API_KEY=your_backlog_api_key_here
|
|
91
78
|
BACKLOG_DOMAIN=your-space.backlog.com
|
|
92
|
-
USER_ID=your_user_id
|
|
93
79
|
```
|
|
94
80
|
|
|
95
81
|
> **Important:**
|
|
96
82
|
> - Replace `your_backlog_api_key_here` with your actual Backlog API key
|
|
97
83
|
> - Replace `your-space.backlog.com` with your actual Backlog domain
|
|
98
|
-
> - Replace `your_user_id` with your actual Backlog user ID
|
|
99
84
|
|
|
100
85
|
### 3. Start the server
|
|
101
86
|
|
|
@@ -1,19 +1,19 @@
|
|
|
1
1
|
app/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
2
2
|
app/logging_config.py,sha256=1tSV1HXExfIi_mxOpugvGL7ywd43SMmsKsjARWXTLnU,999
|
|
3
3
|
app/main.py,sha256=IZ-oDlynIZN-knCZqbUlnTMZ1YDJ-mHpUdAgv-Q-Lp4,488
|
|
4
|
-
app/server_settings.py,sha256=
|
|
4
|
+
app/server_settings.py,sha256=mI-G1DKJ2IBg9dKuW4Da5MDhFLeYSQwLOGGNEb_kQwM,434
|
|
5
5
|
app/constants/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
6
6
|
app/constants/constants.py,sha256=DV8HJnvCceHqUmA5csk9CcmcX9Zr0upl56qXVa9tF88,1664
|
|
7
7
|
app/core/__init__.py,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
|
|
8
8
|
app/models/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
9
9
|
app/models/models.py,sha256=y3JhziNew3_2bM4Lw3aVjWcTvhmaEbzz0AaCHsdAkbk,4169
|
|
10
10
|
app/tools/__init__.py,sha256=LxxyJiqccPQCNjei_YvtNJgEMs4U7IzKEsAaNKToaKg,68
|
|
11
|
-
app/tools/get_issue_details.py,sha256=
|
|
12
|
-
app/tools/get_user_issue_list.py,sha256=
|
|
11
|
+
app/tools/get_issue_details.py,sha256=efixu906oloeIZdf-geTlLxt9nLe-tPDqUlDd9HL6-g,973
|
|
12
|
+
app/tools/get_user_issue_list.py,sha256=soNX0OfvfT1hIyzeDMPaHpAjHeGqavtZdTl0CemCpyo,865
|
|
13
13
|
app/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
14
14
|
app/utils/di.py,sha256=5MmL6efLAX3uzp5WSMi4E_BDCgapzlr_OERZoN5NGnM,408
|
|
15
|
-
app/utils/ultils.py,sha256=
|
|
16
|
-
backlog_mcp-1.0.
|
|
17
|
-
backlog_mcp-1.0.
|
|
18
|
-
backlog_mcp-1.0.
|
|
19
|
-
backlog_mcp-1.0.
|
|
15
|
+
app/utils/ultils.py,sha256=HXa43zAOtyr0VdNHS2Du8CzqseAop2lsjGBPSMZnmb4,11400
|
|
16
|
+
backlog_mcp-1.0.4.dist-info/METADATA,sha256=WWSScaN5867hmnddFdBrbls1dosDjmPLZ7wubzd67TM,3883
|
|
17
|
+
backlog_mcp-1.0.4.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
|
|
18
|
+
backlog_mcp-1.0.4.dist-info/entry_points.txt,sha256=h5JeHYUp_uoaya4FO3QelcsgYOu-VRmh5qWRhPrwjtk,46
|
|
19
|
+
backlog_mcp-1.0.4.dist-info/RECORD,,
|
|
File without changes
|
|
File without changes
|