@kanbodev/mcp 1.1.9 → 1.2.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 +323 -323
- package/dist/index.js +1795 -1012
- package/docs/GIT_CONVENTIONS.md +139 -139
- package/docs/SETUP.md +254 -254
- package/docs/VSCODE.md +211 -211
- package/package.json +47 -47
package/docs/GIT_CONVENTIONS.md
CHANGED
|
@@ -1,139 +1,139 @@
|
|
|
1
|
-
# Git Commit Conventions
|
|
2
|
-
|
|
3
|
-
> **Purpose**: Ensures git commits are linked to Kanbo tickets and appear in the **Git tab** of the Kanbo UI. Any AI agent using the Kanbo MCP server should follow these conventions when committing code.
|
|
4
|
-
>
|
|
5
|
-
> **Last Updated**: 2026-03-12
|
|
6
|
-
|
|
7
|
-
---
|
|
8
|
-
|
|
9
|
-
## Overview
|
|
10
|
-
|
|
11
|
-
Kanbo's Git tab tracks commits associated with a ticket by matching the **ticket key prefix** in commit messages. When a commit message starts with a ticket key (e.g., `WHLZ-59:`), that commit is automatically linked to the ticket and displayed in its Git tab.
|
|
12
|
-
|
|
13
|
-
Without the correct prefix, commits are **invisible** to the ticket — there is no way to retroactively link them.
|
|
14
|
-
|
|
15
|
-
---
|
|
16
|
-
|
|
17
|
-
## Commit Message Format
|
|
18
|
-
|
|
19
|
-
### Single Ticket
|
|
20
|
-
|
|
21
|
-
```
|
|
22
|
-
<TICKET_KEY>: <description>
|
|
23
|
-
```
|
|
24
|
-
|
|
25
|
-
**Examples:**
|
|
26
|
-
|
|
27
|
-
```
|
|
28
|
-
WHLZ-59: implement Google OAuth login flow
|
|
29
|
-
UNO-12: fix pagination bug in ticket list
|
|
30
|
-
KANBO-7: add rate limiting middleware
|
|
31
|
-
```
|
|
32
|
-
|
|
33
|
-
### Multiple Tickets
|
|
34
|
-
|
|
35
|
-
When a single commit applies to more than one ticket, include all keys separated by spaces:
|
|
36
|
-
|
|
37
|
-
```
|
|
38
|
-
<TICKET_KEY_1> <TICKET_KEY_2>: <description>
|
|
39
|
-
```
|
|
40
|
-
|
|
41
|
-
**Examples:**
|
|
42
|
-
|
|
43
|
-
```
|
|
44
|
-
WHLZ-59 WHLZ-60: add shared auth middleware for OAuth providers
|
|
45
|
-
UNO-12 UNO-15: refactor validation logic for both endpoints
|
|
46
|
-
```
|
|
47
|
-
|
|
48
|
-
---
|
|
49
|
-
|
|
50
|
-
## Rules
|
|
51
|
-
|
|
52
|
-
| Rule | Details |
|
|
53
|
-
|------|---------|
|
|
54
|
-
| **Always prefix** | Every commit related to a Kanbo ticket MUST start with the ticket key(s) |
|
|
55
|
-
| **Key format** | `PROJECT_PREFIX-NUMBER` — uppercase letters followed by a dash and number (e.g., `WHLZ-59`) |
|
|
56
|
-
| **Description style** | Lowercase, starting with a verb (`add`, `fix`, `update`, `refactor`, `remove`, `implement`) |
|
|
57
|
-
| **Line length** | Keep the first line under 72 characters |
|
|
58
|
-
| **No prefix = no link** | Commits without the ticket key prefix will NOT appear in the Kanbo Git tab |
|
|
59
|
-
|
|
60
|
-
---
|
|
61
|
-
|
|
62
|
-
## MCP Tool: `get_commit_prefix`
|
|
63
|
-
|
|
64
|
-
The Kanbo MCP server provides a `get_commit_prefix` tool that generates properly formatted commit message prefixes.
|
|
65
|
-
|
|
66
|
-
### Usage
|
|
67
|
-
|
|
68
|
-
```json
|
|
69
|
-
{
|
|
70
|
-
"tool": "get_commit_prefix",
|
|
71
|
-
"arguments": {
|
|
72
|
-
"ticketKeys": ["WHLZ-59"]
|
|
73
|
-
}
|
|
74
|
-
}
|
|
75
|
-
```
|
|
76
|
-
|
|
77
|
-
### Response
|
|
78
|
-
|
|
79
|
-
```json
|
|
80
|
-
{
|
|
81
|
-
"success": true,
|
|
82
|
-
"data": {
|
|
83
|
-
"prefix": "WHLZ-59:",
|
|
84
|
-
"example": "WHLZ-59: <describe your change>",
|
|
85
|
-
"format_rules": [
|
|
86
|
-
"Use lowercase description after the prefix",
|
|
87
|
-
"Start with a verb: add, fix, update, refactor, remove, implement",
|
|
88
|
-
"Keep the first line under 72 characters"
|
|
89
|
-
],
|
|
90
|
-
"examples": [
|
|
91
|
-
"WHLZ-59: implement the feature",
|
|
92
|
-
"WHLZ-59: fix validation bug",
|
|
93
|
-
"WHLZ-59: update error handling"
|
|
94
|
-
]
|
|
95
|
-
}
|
|
96
|
-
}
|
|
97
|
-
```
|
|
98
|
-
|
|
99
|
-
### Multiple Tickets
|
|
100
|
-
|
|
101
|
-
```json
|
|
102
|
-
{
|
|
103
|
-
"tool": "get_commit_prefix",
|
|
104
|
-
"arguments": {
|
|
105
|
-
"ticketKeys": ["WHLZ-59", "WHLZ-60"]
|
|
106
|
-
}
|
|
107
|
-
}
|
|
108
|
-
```
|
|
109
|
-
|
|
110
|
-
Returns prefix: `WHLZ-59 WHLZ-60:`
|
|
111
|
-
|
|
112
|
-
### Validation
|
|
113
|
-
|
|
114
|
-
The tool validates that each key matches the expected format (`PROJECT_PREFIX-NUMBER`). Invalid keys like `whlz-59`, `WHLZ59`, or `59` will return an error with guidance on the correct format.
|
|
115
|
-
|
|
116
|
-
---
|
|
117
|
-
|
|
118
|
-
## Agent Workflow
|
|
119
|
-
|
|
120
|
-
The recommended workflow for an AI agent working on a Kanbo ticket:
|
|
121
|
-
|
|
122
|
-
```
|
|
123
|
-
1. get_ticket_by_key("WHLZ-59") — Retrieve ticket details
|
|
124
|
-
2. Implement the changes — Write code
|
|
125
|
-
3. get_commit_prefix(["WHLZ-59"]) — Get the formatted prefix
|
|
126
|
-
4. git commit -m "WHLZ-59: ..." — Commit with the prefix
|
|
127
|
-
```
|
|
128
|
-
|
|
129
|
-
This workflow is also documented in the `get_help` tool under `common_workflows` → "Committing code for a ticket" and in the `git_conventions` section.
|
|
130
|
-
|
|
131
|
-
---
|
|
132
|
-
|
|
133
|
-
## Discovery
|
|
134
|
-
|
|
135
|
-
Agents discover these conventions through:
|
|
136
|
-
|
|
137
|
-
1. **`get_help` tool** — The `git_conventions` section describes the format, rules, and workflow
|
|
138
|
-
2. **`get_commit_prefix` tool** — The tool description itself explains why the prefix is required
|
|
139
|
-
3. **`common_workflows`** — The "Committing code for a ticket" workflow guides agents step-by-step
|
|
1
|
+
# Git Commit Conventions
|
|
2
|
+
|
|
3
|
+
> **Purpose**: Ensures git commits are linked to Kanbo tickets and appear in the **Git tab** of the Kanbo UI. Any AI agent using the Kanbo MCP server should follow these conventions when committing code.
|
|
4
|
+
>
|
|
5
|
+
> **Last Updated**: 2026-03-12
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## Overview
|
|
10
|
+
|
|
11
|
+
Kanbo's Git tab tracks commits associated with a ticket by matching the **ticket key prefix** in commit messages. When a commit message starts with a ticket key (e.g., `WHLZ-59:`), that commit is automatically linked to the ticket and displayed in its Git tab.
|
|
12
|
+
|
|
13
|
+
Without the correct prefix, commits are **invisible** to the ticket — there is no way to retroactively link them.
|
|
14
|
+
|
|
15
|
+
---
|
|
16
|
+
|
|
17
|
+
## Commit Message Format
|
|
18
|
+
|
|
19
|
+
### Single Ticket
|
|
20
|
+
|
|
21
|
+
```
|
|
22
|
+
<TICKET_KEY>: <description>
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
**Examples:**
|
|
26
|
+
|
|
27
|
+
```
|
|
28
|
+
WHLZ-59: implement Google OAuth login flow
|
|
29
|
+
UNO-12: fix pagination bug in ticket list
|
|
30
|
+
KANBO-7: add rate limiting middleware
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
### Multiple Tickets
|
|
34
|
+
|
|
35
|
+
When a single commit applies to more than one ticket, include all keys separated by spaces:
|
|
36
|
+
|
|
37
|
+
```
|
|
38
|
+
<TICKET_KEY_1> <TICKET_KEY_2>: <description>
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
**Examples:**
|
|
42
|
+
|
|
43
|
+
```
|
|
44
|
+
WHLZ-59 WHLZ-60: add shared auth middleware for OAuth providers
|
|
45
|
+
UNO-12 UNO-15: refactor validation logic for both endpoints
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
---
|
|
49
|
+
|
|
50
|
+
## Rules
|
|
51
|
+
|
|
52
|
+
| Rule | Details |
|
|
53
|
+
|------|---------|
|
|
54
|
+
| **Always prefix** | Every commit related to a Kanbo ticket MUST start with the ticket key(s) |
|
|
55
|
+
| **Key format** | `PROJECT_PREFIX-NUMBER` — uppercase letters followed by a dash and number (e.g., `WHLZ-59`) |
|
|
56
|
+
| **Description style** | Lowercase, starting with a verb (`add`, `fix`, `update`, `refactor`, `remove`, `implement`) |
|
|
57
|
+
| **Line length** | Keep the first line under 72 characters |
|
|
58
|
+
| **No prefix = no link** | Commits without the ticket key prefix will NOT appear in the Kanbo Git tab |
|
|
59
|
+
|
|
60
|
+
---
|
|
61
|
+
|
|
62
|
+
## MCP Tool: `get_commit_prefix`
|
|
63
|
+
|
|
64
|
+
The Kanbo MCP server provides a `get_commit_prefix` tool that generates properly formatted commit message prefixes.
|
|
65
|
+
|
|
66
|
+
### Usage
|
|
67
|
+
|
|
68
|
+
```json
|
|
69
|
+
{
|
|
70
|
+
"tool": "get_commit_prefix",
|
|
71
|
+
"arguments": {
|
|
72
|
+
"ticketKeys": ["WHLZ-59"]
|
|
73
|
+
}
|
|
74
|
+
}
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
### Response
|
|
78
|
+
|
|
79
|
+
```json
|
|
80
|
+
{
|
|
81
|
+
"success": true,
|
|
82
|
+
"data": {
|
|
83
|
+
"prefix": "WHLZ-59:",
|
|
84
|
+
"example": "WHLZ-59: <describe your change>",
|
|
85
|
+
"format_rules": [
|
|
86
|
+
"Use lowercase description after the prefix",
|
|
87
|
+
"Start with a verb: add, fix, update, refactor, remove, implement",
|
|
88
|
+
"Keep the first line under 72 characters"
|
|
89
|
+
],
|
|
90
|
+
"examples": [
|
|
91
|
+
"WHLZ-59: implement the feature",
|
|
92
|
+
"WHLZ-59: fix validation bug",
|
|
93
|
+
"WHLZ-59: update error handling"
|
|
94
|
+
]
|
|
95
|
+
}
|
|
96
|
+
}
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
### Multiple Tickets
|
|
100
|
+
|
|
101
|
+
```json
|
|
102
|
+
{
|
|
103
|
+
"tool": "get_commit_prefix",
|
|
104
|
+
"arguments": {
|
|
105
|
+
"ticketKeys": ["WHLZ-59", "WHLZ-60"]
|
|
106
|
+
}
|
|
107
|
+
}
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
Returns prefix: `WHLZ-59 WHLZ-60:`
|
|
111
|
+
|
|
112
|
+
### Validation
|
|
113
|
+
|
|
114
|
+
The tool validates that each key matches the expected format (`PROJECT_PREFIX-NUMBER`). Invalid keys like `whlz-59`, `WHLZ59`, or `59` will return an error with guidance on the correct format.
|
|
115
|
+
|
|
116
|
+
---
|
|
117
|
+
|
|
118
|
+
## Agent Workflow
|
|
119
|
+
|
|
120
|
+
The recommended workflow for an AI agent working on a Kanbo ticket:
|
|
121
|
+
|
|
122
|
+
```
|
|
123
|
+
1. get_ticket_by_key("WHLZ-59") — Retrieve ticket details
|
|
124
|
+
2. Implement the changes — Write code
|
|
125
|
+
3. get_commit_prefix(["WHLZ-59"]) — Get the formatted prefix
|
|
126
|
+
4. git commit -m "WHLZ-59: ..." — Commit with the prefix
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
This workflow is also documented in the `get_help` tool under `common_workflows` → "Committing code for a ticket" and in the `git_conventions` section.
|
|
130
|
+
|
|
131
|
+
---
|
|
132
|
+
|
|
133
|
+
## Discovery
|
|
134
|
+
|
|
135
|
+
Agents discover these conventions through:
|
|
136
|
+
|
|
137
|
+
1. **`get_help` tool** — The `git_conventions` section describes the format, rules, and workflow
|
|
138
|
+
2. **`get_commit_prefix` tool** — The tool description itself explains why the prefix is required
|
|
139
|
+
3. **`common_workflows`** — The "Committing code for a ticket" workflow guides agents step-by-step
|