KnBn MCP服务器
一种模型上下文协议(MCP)服务器,为AI助手提供对看板功能的结构化访问。建在 KnBn CLI工具,此服务器通过MCP工具和资源公开看板操作。
概述
KnBn MCP Server使AI助手能够使用标准化的MCP协议以编程方式与看板进行交互。它提供了三种主要的交互方法:
- MCP工具:用于创建、更新和管理板、任务、列、标签和冲刺的交互式操作
- MCP资源:使用结构化URI模式对板数据进行只读访问
- CLI集成:基于经过验证的KnBn CLI构建,可实现可靠的电路板操作
特性
- 董事会管理:创建、列出和迁移看板
- 任务操作:完整的CRUD操作,包括批量更新
- 栏目管理:创建、更新、删除和列出板列
- 标签系统:添加、更新、删除和列出带有颜色的任务标签
- Sprint管理:创建和管理开发冲刺
- 资源访问:通过MCP资源进行只读数据访问
- 迁移支持:将电路板文件升级到最新格式版本
安装
作为MCP服务器
- 安装软件包:
npm install knbn-mcp- 在MCP客户端(例如Claude Desktop)中配置:
{
"mcpServers": {
"knbn": {
"command": "npx",
"args": ["knbn-mcp"]
}
}
}为了发展
- 克隆存储库:
git clone https://github.com/mattbalmer/knbn-mcp.git
cd knbn-mcp- 安装依赖项:
npm install- 构建项目:
npm run build- 运行测试:
npm test用法
MCP工具
服务器提供有组织的工具类别:
电路板工具
list_boards-列出所有.knbn板文件get_board-获取完整的板内容create_board-创建带有名称和描述的新板migrate-将电路板文件迁移到最新版本
任务工具
create_task-创建带有标题、描述、优先级、故事点的任务get_task-按ID获取任务详细信息list_tasks-按列、标签、优先级、冲刺列出/过滤任务update_task-更新任务属性update_tasks_batch-高效地更新多个任务
列工具
create_column-在指定位置添加新列list_columns-列出所有具有可选任务计数的列update_column-重命名现有列remove_column-删除列
标签工具
add_label-创建带有名称和颜色的标签list_labels-列出所有可用标签update_label-修改标签名称或颜色remove_label-从板上删除标签
Sprint工具
add_sprint-创建带有日期、容量和描述的冲刺list_sprints-列出按状态筛选的冲刺update_sprint-修改sprint属性remove_sprint-删除冲刺
MCP资源
通过结构化URI访问板数据:
knbn://boards-所有电路板文件列表knbn://board/{filename}-完整的电路板数据knbn://board/{filename}/summary-董事会总结及指标knbn://board/{filename}/tasks-来自董事会的所有任务
示例用法
// Create a new board
await mcpClient.callTool("create_board", {
name: "Project Alpha",
description: "Development board for Project Alpha",
filename: "alpha.knbn"
});
// Create a task
await mcpClient.callTool("create_task", {
title: "Implement authentication",
description: "Add login and registration functionality",
column: "To Do",
priority: 1,
storyPoints: 5,
labels: ["backend", "security"],
filename: "alpha.knbn"
});
// Move task to different column
await mcpClient.callTool("update_task", {
id: 1,
column: "In Progress",
filename: "alpha.knbn"
});
// Get board summary
const summary = await mcpClient.readResource("knbn://board/alpha.knbn/summary");发展
脚本
npm run build-将TypeScript编译为JavaScriptnpm test-运行Jest测试npm run test:watch-在监视模式下运行测试npm run test:coverage-生成覆盖率报告
建筑
src/
├── server.ts # Main MCP server entry point
├── patch.ts # MCP SDK extensions
├── tools/ # MCP tools organized by domain
│ ├── board/ # Board management tools
│ ├── tasks/ # Task management tools
│ ├── columns/ # Column management tools
│ ├── labels/ # Label management tools
│ └── sprints/ # Sprint management tools
└── resources/ # MCP resources for data access
└── board-resource.ts测试
测试位于 tests/ 带有固定装置 tests/fixtures/.运行测试套件:
npm test生成覆盖率报告:
npm run test:coverage电路板文件格式
电路板数据存储在 .knbn 使用结构化格式的文件。MCP服务器自动处理所有文件操作,但您也可以使用 KnBn命令行界面.
贡献
- 分叉存储库
- 创建要素分支
- 进行更改
- 添加新功能的测试
- 运行测试套件
- 提交拉取请求
许可证
MIT许可证-请参阅 许可证 了解详情。
