@flowboardlabs/mcp-server 0.1.0 → 0.1.1
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 +96 -0
- package/package.json +3 -2
package/README.md
ADDED
|
@@ -0,0 +1,96 @@
|
|
|
1
|
+
# @flowboardlabs/mcp-server
|
|
2
|
+
|
|
3
|
+
MCP (Model Context Protocol) server for [FlowBoard](https://flowboard.app) — lets AI tools like Claude Code, Cursor, and other MCP-compatible assistants manage your projects, tasks, ideas, and releases directly from your IDE.
|
|
4
|
+
|
|
5
|
+
## Setup
|
|
6
|
+
|
|
7
|
+
### 1. Get an API Key
|
|
8
|
+
|
|
9
|
+
Go to **Settings > Integrations > API Keys** in your FlowBoard workspace. Click "Generate API Key" and copy it.
|
|
10
|
+
|
|
11
|
+
### 2. Configure Your AI Tool
|
|
12
|
+
|
|
13
|
+
Add the following to your MCP server configuration:
|
|
14
|
+
|
|
15
|
+
**macOS / Linux:**
|
|
16
|
+
|
|
17
|
+
```json
|
|
18
|
+
{
|
|
19
|
+
"mcpServers": {
|
|
20
|
+
"flowboard": {
|
|
21
|
+
"command": "npx",
|
|
22
|
+
"args": ["-y", "@flowboardlabs/mcp-server"],
|
|
23
|
+
"env": {
|
|
24
|
+
"FLOWBOARD_API_KEY": "your-api-key-here"
|
|
25
|
+
}
|
|
26
|
+
}
|
|
27
|
+
}
|
|
28
|
+
}
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
**Windows (REQUIRED — npx needs cmd wrapper):**
|
|
32
|
+
|
|
33
|
+
```json
|
|
34
|
+
{
|
|
35
|
+
"mcpServers": {
|
|
36
|
+
"flowboard": {
|
|
37
|
+
"command": "cmd",
|
|
38
|
+
"args": ["/c", "npx", "-y", "@flowboardlabs/mcp-server"],
|
|
39
|
+
"env": {
|
|
40
|
+
"FLOWBOARD_API_KEY": "your-api-key-here"
|
|
41
|
+
}
|
|
42
|
+
}
|
|
43
|
+
}
|
|
44
|
+
}
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
> **Important:** On Windows, you **must** use the `cmd /c` wrapper. Using `npx` directly as the command will fail silently.
|
|
48
|
+
|
|
49
|
+
### Where to put this config
|
|
50
|
+
|
|
51
|
+
- **Claude Code:** `.mcp.json` in your project root
|
|
52
|
+
- **Cursor:** Cursor MCP settings
|
|
53
|
+
- **Other tools:** Check your tool's MCP configuration docs
|
|
54
|
+
|
|
55
|
+
## Environment Variables
|
|
56
|
+
|
|
57
|
+
| Variable | Required | Description |
|
|
58
|
+
|----------|----------|-------------|
|
|
59
|
+
| `FLOWBOARD_API_KEY` | Yes | Your FlowBoard API key |
|
|
60
|
+
| `FLOWBOARD_API_URL` | No | Custom API URL (for self-hosted instances) |
|
|
61
|
+
|
|
62
|
+
## Available Tools
|
|
63
|
+
|
|
64
|
+
| Tool | Description |
|
|
65
|
+
|------|-------------|
|
|
66
|
+
| `list_projects` | List all projects in your workspace |
|
|
67
|
+
| `search_tasks` | Search and filter tasks by board, status, project, assignee, type, or tags |
|
|
68
|
+
| `get_task` | Get a single task with its comments |
|
|
69
|
+
| `create_task` | Create a new idea or bug |
|
|
70
|
+
| `update_task` | Change status, add comment, link a PR, assign someone |
|
|
71
|
+
| `delete_task` | Soft-delete (trash) a task |
|
|
72
|
+
| `list_ideas` | List ideas with optional filtering |
|
|
73
|
+
| `vote_idea` | Toggle a vote on an idea |
|
|
74
|
+
| `list_releases` | List releases in the workspace |
|
|
75
|
+
| `get_release` | Get a release with its associated tasks |
|
|
76
|
+
| `get_comments` | Get comments for a task |
|
|
77
|
+
| `add_comment` | Add a comment to a task |
|
|
78
|
+
|
|
79
|
+
## Example Prompts
|
|
80
|
+
|
|
81
|
+
Once configured, just ask naturally:
|
|
82
|
+
|
|
83
|
+
- "Show me all open bugs in the backend project"
|
|
84
|
+
- "Create a bug: login page returns 500 when email contains a plus sign"
|
|
85
|
+
- "Move task abc123 to in_progress and assign it to me"
|
|
86
|
+
- "What are the latest releases?"
|
|
87
|
+
- "Add a comment to task xyz: Fixed in PR #42"
|
|
88
|
+
|
|
89
|
+
## Requirements
|
|
90
|
+
|
|
91
|
+
- Node.js >= 18
|
|
92
|
+
- A FlowBoard workspace with an API key
|
|
93
|
+
|
|
94
|
+
## License
|
|
95
|
+
|
|
96
|
+
MIT
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@flowboardlabs/mcp-server",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.1",
|
|
4
4
|
"description": "FlowBoard MCP Server — lets AI tools manage projects, tasks, ideas, and releases",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"bin": {
|
|
@@ -24,6 +24,7 @@
|
|
|
24
24
|
"@types/node": "^20.0.0"
|
|
25
25
|
},
|
|
26
26
|
"files": [
|
|
27
|
-
"dist"
|
|
27
|
+
"dist",
|
|
28
|
+
"README.md"
|
|
28
29
|
]
|
|
29
30
|
}
|