@kanbodev/mcp 1.0.2
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 +258 -0
- package/dist/index.js +42794 -0
- package/docs/SETUP.md +216 -0
- package/docs/VSCODE.md +207 -0
- package/package.json +46 -0
package/docs/SETUP.md
ADDED
|
@@ -0,0 +1,216 @@
|
|
|
1
|
+
# Kanbo MCP Setup Guide
|
|
2
|
+
|
|
3
|
+
This guide covers two ways to set up the Kanbo MCP server for use with AI assistants like Claude.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## Option 1: Install via npm (Recommended)
|
|
8
|
+
|
|
9
|
+
The easiest way to get started. One command to authenticate, then configure your AI assistant.
|
|
10
|
+
|
|
11
|
+
### Step 1: Authenticate
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
npx @kanbodev/mcp login
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
This will:
|
|
18
|
+
1. Open your browser to sign in with your Kanbo account
|
|
19
|
+
2. Let you select which organization to use
|
|
20
|
+
3. Automatically create and store an API key
|
|
21
|
+
|
|
22
|
+
You'll see a success message when complete:
|
|
23
|
+
|
|
24
|
+
```
|
|
25
|
+
✓ Successfully authenticated!
|
|
26
|
+
|
|
27
|
+
Email: you@example.com
|
|
28
|
+
Organization: My Team
|
|
29
|
+
API Key: kanbo_pat_a1b2...
|
|
30
|
+
|
|
31
|
+
Config saved to: ~/.kanbo/config.json
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
### Step 2: Configure Claude Desktop
|
|
35
|
+
|
|
36
|
+
Add Kanbo to your Claude Desktop configuration:
|
|
37
|
+
|
|
38
|
+
**macOS:** `~/Library/Application Support/Claude/claude_desktop_config.json`
|
|
39
|
+
**Windows:** `%APPDATA%\Claude\claude_desktop_config.json`
|
|
40
|
+
|
|
41
|
+
```json
|
|
42
|
+
{
|
|
43
|
+
"mcpServers": {
|
|
44
|
+
"kanbo": {
|
|
45
|
+
"command": "npx",
|
|
46
|
+
"args": ["@kanbodev/mcp"]
|
|
47
|
+
}
|
|
48
|
+
}
|
|
49
|
+
}
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
That's it! Restart Claude Desktop and you can start managing your projects with AI.
|
|
53
|
+
|
|
54
|
+
### Other CLI Commands
|
|
55
|
+
|
|
56
|
+
```bash
|
|
57
|
+
npx @kanbodev/mcp whoami # Check current authentication status
|
|
58
|
+
npx @kanbodev/mcp logout # Remove stored credentials
|
|
59
|
+
npx @kanbodev/mcp help # Show all available commands
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
---
|
|
63
|
+
|
|
64
|
+
## Option 2: Manual Setup with API Key
|
|
65
|
+
|
|
66
|
+
If you prefer to manage your API key manually, or need to configure multiple environments.
|
|
67
|
+
|
|
68
|
+
### Step 1: Create an API Key
|
|
69
|
+
|
|
70
|
+
1. Go to your Kanbo dashboard
|
|
71
|
+
2. Navigate to **Settings → API Keys**
|
|
72
|
+
3. Click **Create API Key**
|
|
73
|
+
4. Give it a name (e.g., "Claude Desktop")
|
|
74
|
+
5. Copy the token (it will only be shown once!)
|
|
75
|
+
|
|
76
|
+
The token looks like: `kanbo_pat_a1b2c3d4e5f6...`
|
|
77
|
+
|
|
78
|
+
### Step 2: Configure Claude Desktop
|
|
79
|
+
|
|
80
|
+
Add Kanbo to your Claude Desktop configuration with the API key:
|
|
81
|
+
|
|
82
|
+
**macOS:** `~/Library/Application Support/Claude/claude_desktop_config.json`
|
|
83
|
+
**Windows:** `%APPDATA%\Claude\claude_desktop_config.json`
|
|
84
|
+
|
|
85
|
+
```json
|
|
86
|
+
{
|
|
87
|
+
"mcpServers": {
|
|
88
|
+
"kanbo": {
|
|
89
|
+
"command": "npx",
|
|
90
|
+
"args": ["@kanbodev/mcp"],
|
|
91
|
+
"env": {
|
|
92
|
+
"KANBO_API_KEY": "kanbo_pat_your_token_here"
|
|
93
|
+
}
|
|
94
|
+
}
|
|
95
|
+
}
|
|
96
|
+
}
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
### Step 3: Restart Claude Desktop
|
|
100
|
+
|
|
101
|
+
Close and reopen Claude Desktop to load the new configuration.
|
|
102
|
+
|
|
103
|
+
---
|
|
104
|
+
|
|
105
|
+
## Configuration Options
|
|
106
|
+
|
|
107
|
+
### Environment Variables
|
|
108
|
+
|
|
109
|
+
| Variable | Description | Default |
|
|
110
|
+
|----------|-------------|---------|
|
|
111
|
+
| `KANBO_API_KEY` | Your Personal Access Token | (from ~/.kanbo/config.json) |
|
|
112
|
+
| `KANBO_API_URL` | API server URL | `https://api.kanbo.dev` |
|
|
113
|
+
| `KANBO_ORG_ID` | Override organization ID | (from token) |
|
|
114
|
+
|
|
115
|
+
### Priority Order
|
|
116
|
+
|
|
117
|
+
The MCP server loads configuration in this order (first found wins):
|
|
118
|
+
|
|
119
|
+
1. **Environment variables** - Set in Claude Desktop config or shell
|
|
120
|
+
2. **Config file** - `~/.kanbo/config.json` (created by `login` command)
|
|
121
|
+
|
|
122
|
+
This means you can:
|
|
123
|
+
- Use `npx @kanbodev/mcp login` for easy setup
|
|
124
|
+
- Override with env vars for specific use cases
|
|
125
|
+
|
|
126
|
+
---
|
|
127
|
+
|
|
128
|
+
## Using with Other AI Tools
|
|
129
|
+
|
|
130
|
+
### Cursor
|
|
131
|
+
|
|
132
|
+
Add to your Cursor MCP settings:
|
|
133
|
+
|
|
134
|
+
```json
|
|
135
|
+
{
|
|
136
|
+
"mcpServers": {
|
|
137
|
+
"kanbo": {
|
|
138
|
+
"command": "npx",
|
|
139
|
+
"args": ["@kanbodev/mcp"]
|
|
140
|
+
}
|
|
141
|
+
}
|
|
142
|
+
}
|
|
143
|
+
```
|
|
144
|
+
|
|
145
|
+
### VS Code
|
|
146
|
+
|
|
147
|
+
See the full [VS Code setup guide](VSCODE.md) for native MCP support (v1.99+), Claude Code extension, and Cursor/Windsurf.
|
|
148
|
+
|
|
149
|
+
### Claude Code CLI
|
|
150
|
+
|
|
151
|
+
```bash
|
|
152
|
+
claude mcp add kanbo -- npx @kanbodev/mcp
|
|
153
|
+
```
|
|
154
|
+
|
|
155
|
+
---
|
|
156
|
+
|
|
157
|
+
## Troubleshooting
|
|
158
|
+
|
|
159
|
+
### "Not authenticated" error
|
|
160
|
+
|
|
161
|
+
Run `npx @kanbodev/mcp whoami` to check your auth status. If not logged in:
|
|
162
|
+
|
|
163
|
+
```bash
|
|
164
|
+
npx @kanbodev/mcp login
|
|
165
|
+
```
|
|
166
|
+
|
|
167
|
+
### "Invalid API key" error
|
|
168
|
+
|
|
169
|
+
Your API key may have been revoked. Create a new one:
|
|
170
|
+
|
|
171
|
+
1. Go to Kanbo dashboard → Settings → API Keys
|
|
172
|
+
2. Revoke the old key
|
|
173
|
+
3. Create a new one
|
|
174
|
+
4. Update your configuration
|
|
175
|
+
|
|
176
|
+
### Connection issues
|
|
177
|
+
|
|
178
|
+
Check the API URL is correct:
|
|
179
|
+
|
|
180
|
+
```bash
|
|
181
|
+
# Test with explicit URL
|
|
182
|
+
KANBO_API_URL=https://api.kanbo.dev npx @kanbodev/mcp whoami
|
|
183
|
+
```
|
|
184
|
+
|
|
185
|
+
### Clear stored credentials
|
|
186
|
+
|
|
187
|
+
```bash
|
|
188
|
+
npx @kanbodev/mcp logout
|
|
189
|
+
```
|
|
190
|
+
|
|
191
|
+
Or manually delete the config file:
|
|
192
|
+
|
|
193
|
+
```bash
|
|
194
|
+
rm ~/.kanbo/config.json
|
|
195
|
+
```
|
|
196
|
+
|
|
197
|
+
---
|
|
198
|
+
|
|
199
|
+
## Security Notes
|
|
200
|
+
|
|
201
|
+
- **API keys are stored securely** in `~/.kanbo/config.json` with owner-only permissions (0600)
|
|
202
|
+
- **Never commit API keys** to version control
|
|
203
|
+
- **Revoke unused keys** from the Kanbo dashboard
|
|
204
|
+
- **Each key is organization-scoped** - it can only access data in that organization
|
|
205
|
+
|
|
206
|
+
---
|
|
207
|
+
|
|
208
|
+
## Quick Reference
|
|
209
|
+
|
|
210
|
+
| Task | Command |
|
|
211
|
+
|------|---------|
|
|
212
|
+
| Authenticate | `npx @kanbodev/mcp login` |
|
|
213
|
+
| Check status | `npx @kanbodev/mcp whoami` |
|
|
214
|
+
| Logout | `npx @kanbodev/mcp logout` |
|
|
215
|
+
| Start server | `npx @kanbodev/mcp` |
|
|
216
|
+
| Show help | `npx @kanbodev/mcp help` |
|
package/docs/VSCODE.md
ADDED
|
@@ -0,0 +1,207 @@
|
|
|
1
|
+
# Using Kanbo MCP with VS Code
|
|
2
|
+
|
|
3
|
+
Connect Kanbo to your VS Code environment and manage projects, tickets, and workflows through AI-powered conversation — without leaving your editor.
|
|
4
|
+
|
|
5
|
+
## Prerequisites
|
|
6
|
+
|
|
7
|
+
**Authenticate first** (one-time setup):
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
npx @kanbodev/mcp login
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
This opens your browser, signs you in, and stores your credentials locally at `~/.kanbo/config.json`.
|
|
14
|
+
|
|
15
|
+
Verify it worked:
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
npx @kanbodev/mcp whoami
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
---
|
|
22
|
+
|
|
23
|
+
## VS Code Native MCP (v1.99+)
|
|
24
|
+
|
|
25
|
+
VS Code 1.99 and later has built-in MCP support through GitHub Copilot Chat. This is the simplest way to get started.
|
|
26
|
+
|
|
27
|
+
### Workspace-level setup
|
|
28
|
+
|
|
29
|
+
Add to `.vscode/settings.json` in your project:
|
|
30
|
+
|
|
31
|
+
```json
|
|
32
|
+
{
|
|
33
|
+
"mcp": {
|
|
34
|
+
"servers": {
|
|
35
|
+
"kanbo": {
|
|
36
|
+
"command": "npx",
|
|
37
|
+
"args": ["@kanbodev/mcp"]
|
|
38
|
+
}
|
|
39
|
+
}
|
|
40
|
+
}
|
|
41
|
+
}
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
### User-level setup
|
|
45
|
+
|
|
46
|
+
To make Kanbo available across all your projects, add the same config to your **User Settings** (JSON):
|
|
47
|
+
|
|
48
|
+
1. Open Command Palette (`Cmd+Shift+P` / `Ctrl+Shift+P`)
|
|
49
|
+
2. Select **Preferences: Open User Settings (JSON)**
|
|
50
|
+
3. Add the `mcp` block above
|
|
51
|
+
|
|
52
|
+
### Using a manual API key
|
|
53
|
+
|
|
54
|
+
If you prefer environment variables over the login flow:
|
|
55
|
+
|
|
56
|
+
```json
|
|
57
|
+
{
|
|
58
|
+
"mcp": {
|
|
59
|
+
"servers": {
|
|
60
|
+
"kanbo": {
|
|
61
|
+
"command": "npx",
|
|
62
|
+
"args": ["@kanbodev/mcp"],
|
|
63
|
+
"env": {
|
|
64
|
+
"KANBO_API_KEY": "kanbo_pat_your_token_here"
|
|
65
|
+
}
|
|
66
|
+
}
|
|
67
|
+
}
|
|
68
|
+
}
|
|
69
|
+
}
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
### Verify
|
|
73
|
+
|
|
74
|
+
1. Reload the VS Code window (`Cmd+Shift+P` → **Developer: Reload Window**)
|
|
75
|
+
2. Open Copilot Chat (`Cmd+Shift+I` / `Ctrl+Shift+I`)
|
|
76
|
+
3. Switch to **Agent** mode
|
|
77
|
+
4. You should see Kanbo tools listed under the tools icon
|
|
78
|
+
|
|
79
|
+
---
|
|
80
|
+
|
|
81
|
+
## Claude Code Extension
|
|
82
|
+
|
|
83
|
+
If you use the [Claude Code extension](https://marketplace.visualstudio.com/items?itemName=anthropic.claude-code) for VS Code:
|
|
84
|
+
|
|
85
|
+
### Via CLI
|
|
86
|
+
|
|
87
|
+
Open the terminal in VS Code and run:
|
|
88
|
+
|
|
89
|
+
```bash
|
|
90
|
+
claude mcp add kanbo -- npx @kanbodev/mcp
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
This writes the config to `~/.claude.json` (global) by default.
|
|
94
|
+
|
|
95
|
+
### Via config file
|
|
96
|
+
|
|
97
|
+
Create or edit `.mcp.json` in your project root:
|
|
98
|
+
|
|
99
|
+
```json
|
|
100
|
+
{
|
|
101
|
+
"mcpServers": {
|
|
102
|
+
"kanbo": {
|
|
103
|
+
"command": "npx",
|
|
104
|
+
"args": ["@kanbodev/mcp"]
|
|
105
|
+
}
|
|
106
|
+
}
|
|
107
|
+
}
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
Then restart Claude Code.
|
|
111
|
+
|
|
112
|
+
---
|
|
113
|
+
|
|
114
|
+
## Cursor
|
|
115
|
+
|
|
116
|
+
Add to your Cursor MCP settings (Settings → MCP → Add Server):
|
|
117
|
+
|
|
118
|
+
```json
|
|
119
|
+
{
|
|
120
|
+
"mcpServers": {
|
|
121
|
+
"kanbo": {
|
|
122
|
+
"command": "npx",
|
|
123
|
+
"args": ["@kanbodev/mcp"]
|
|
124
|
+
}
|
|
125
|
+
}
|
|
126
|
+
}
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
---
|
|
130
|
+
|
|
131
|
+
## Windsurf
|
|
132
|
+
|
|
133
|
+
Add to `~/.codeium/windsurf/mcp_config.json`:
|
|
134
|
+
|
|
135
|
+
```json
|
|
136
|
+
{
|
|
137
|
+
"mcpServers": {
|
|
138
|
+
"kanbo": {
|
|
139
|
+
"command": "npx",
|
|
140
|
+
"args": ["@kanbodev/mcp"]
|
|
141
|
+
}
|
|
142
|
+
}
|
|
143
|
+
}
|
|
144
|
+
```
|
|
145
|
+
|
|
146
|
+
---
|
|
147
|
+
|
|
148
|
+
## Troubleshooting
|
|
149
|
+
|
|
150
|
+
### Server not appearing
|
|
151
|
+
|
|
152
|
+
- Make sure you've reloaded the VS Code window after adding the config
|
|
153
|
+
- Check that `npx @kanbodev/mcp` works in your terminal: `npx @kanbodev/mcp whoami`
|
|
154
|
+
- Ensure Node.js 18+ is installed: `node --version`
|
|
155
|
+
|
|
156
|
+
### "Not authenticated" error
|
|
157
|
+
|
|
158
|
+
```bash
|
|
159
|
+
npx @kanbodev/mcp login
|
|
160
|
+
```
|
|
161
|
+
|
|
162
|
+
### Tools not showing up in Copilot Chat
|
|
163
|
+
|
|
164
|
+
- Switch to **Agent** mode in the Copilot Chat panel (not Ask or Edit mode)
|
|
165
|
+
- Click the tools icon to verify Kanbo is listed
|
|
166
|
+
- Try reloading the window
|
|
167
|
+
|
|
168
|
+
### Using a specific version
|
|
169
|
+
|
|
170
|
+
Pin to a version to avoid unexpected updates:
|
|
171
|
+
|
|
172
|
+
```json
|
|
173
|
+
{
|
|
174
|
+
"command": "npx",
|
|
175
|
+
"args": ["@kanbodev/mcp@1.0.0"]
|
|
176
|
+
}
|
|
177
|
+
```
|
|
178
|
+
|
|
179
|
+
Or always use the latest:
|
|
180
|
+
|
|
181
|
+
```json
|
|
182
|
+
{
|
|
183
|
+
"command": "npx",
|
|
184
|
+
"args": ["@kanbodev/mcp@latest"]
|
|
185
|
+
}
|
|
186
|
+
```
|
|
187
|
+
|
|
188
|
+
### Logs
|
|
189
|
+
|
|
190
|
+
Check the MCP server output in VS Code:
|
|
191
|
+
|
|
192
|
+
1. Open Command Palette → **Output: Show Output Channel**
|
|
193
|
+
2. Select the Kanbo MCP channel from the dropdown
|
|
194
|
+
|
|
195
|
+
---
|
|
196
|
+
|
|
197
|
+
## What You Can Do
|
|
198
|
+
|
|
199
|
+
Once connected, switch to Agent mode in Copilot Chat and try:
|
|
200
|
+
|
|
201
|
+
- *"What Kanbo projects do I have?"*
|
|
202
|
+
- *"Show me my assigned tickets"*
|
|
203
|
+
- *"Create a bug ticket in the Frontend project: login button unresponsive on mobile"*
|
|
204
|
+
- *"Move PROJ-123 to In Progress"*
|
|
205
|
+
- *"What's overdue this week?"*
|
|
206
|
+
|
|
207
|
+
See the full [User Guide](../README.md#user-guide) for all available commands.
|
package/package.json
ADDED
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@kanbodev/mcp",
|
|
3
|
+
"version": "1.0.2",
|
|
4
|
+
"description": "MCP (Model Context Protocol) server for Kanbo - AI-native project management",
|
|
5
|
+
"type": "module",
|
|
6
|
+
"main": "dist/index.js",
|
|
7
|
+
"bin": {
|
|
8
|
+
"kanbo-mcp": "./dist/index.js"
|
|
9
|
+
},
|
|
10
|
+
"scripts": {
|
|
11
|
+
"dev": "bun run --watch src/index.ts",
|
|
12
|
+
"dev:http": "TRANSPORT=http bun run --watch src/index.ts",
|
|
13
|
+
"build": "bun build src/index.ts --outdir dist --target bun --format esm",
|
|
14
|
+
"build:node": "bun build src/index.ts --outdir dist --target node --format esm",
|
|
15
|
+
"start": "bun run dist/index.js",
|
|
16
|
+
"start:http": "TRANSPORT=http bun run dist/index.js",
|
|
17
|
+
"typecheck": "tsc --noEmit",
|
|
18
|
+
"test": "bun test",
|
|
19
|
+
"test:watch": "bun test --watch",
|
|
20
|
+
"test:coverage": "bun test --coverage",
|
|
21
|
+
"clean": "rm -rf dist"
|
|
22
|
+
},
|
|
23
|
+
"dependencies": {
|
|
24
|
+
"@modelcontextprotocol/sdk": "^1.26.0",
|
|
25
|
+
"elysia": "^1.0.0",
|
|
26
|
+
"open": "^11.0.0",
|
|
27
|
+
"pino": "^10.3.0"
|
|
28
|
+
},
|
|
29
|
+
"devDependencies": {
|
|
30
|
+
"@types/bun": "^1.1.0",
|
|
31
|
+
"typescript": "^5.3.0"
|
|
32
|
+
},
|
|
33
|
+
"engines": {
|
|
34
|
+
"node": ">=18.0.0"
|
|
35
|
+
},
|
|
36
|
+
"keywords": [
|
|
37
|
+
"mcp",
|
|
38
|
+
"kanbo",
|
|
39
|
+
"ai",
|
|
40
|
+
"project-management",
|
|
41
|
+
"claude",
|
|
42
|
+
"cursor"
|
|
43
|
+
],
|
|
44
|
+
"author": "Kanbo",
|
|
45
|
+
"license": "MIT"
|
|
46
|
+
}
|