使用说明

项目简介

TaskBoardAI 是一个轻量级、基于文件的看板应用，专为AI Agent设计，并提供Web界面以支持人机协作 (HIL)。其核心特性之一是内置了 MCP服务器，使得AI Agent可以通过标准化的 MCP 协议访问和操作看板数据。

主要功能点

资源 (Resources) 管理: 托管和管理项目看板数据（Resources），允许AI Agent读取、创建、更新和删除看板。
数据访问能力: 通过 MCP 协议提供结构化的看板数据访问接口，使AI Agent能够获取项目上下文信息。
Prompt 模板 (Prompts) 支持: 虽然文档中没有明确提及Prompt模板，但MCP服务器的集成为未来扩展 Prompt 功能奠定了基础。
易于安装和使用: 可以通过 npm 或直接从仓库克隆安装，启动命令简单易用。
Web界面: 提供友好的 Web 界面，方便人机协作和看板管理。
Webhook 集成: 支持 Webhook，可以与其他服务集成，实现事件驱动的工作流。

安装步骤

通过 npm 安装 (推荐): 打开终端，运行以下命令全局安装 TaskBoardAI：

npm install -g taskboardai

或者在你的项目目录中本地安装：

npm install taskboardai

克隆仓库安装 (开发模式): 如果需要进行开发或使用仓库版本，请克隆仓库：

git clone https://github.com/TuckerTucker/TaskBoardAI.git
cd TaskBoardAI
npm install

服务器配置

以下 JSON 配置信息用于 MCP 客户端连接 TaskBoardAI MCP 服务器。您需要在您的 MCP 客户端 (如 Claude Code, Cursor, Windsurf 等) 中配置以下信息。

{
  "serverName": "TaskBoardAI MCP Server",
  "command": "taskboard-mcp",
  "args": [],
  "description": "TaskBoardAI MCP Server for AI Agent integration",
  "capabilities": [
    "resource",
    "tool",
    "prompt"
  ],
  "transport": "stdio"
}

配置参数说明:

'serverName': MCP 服务器的名称，可以自定义，用于在客户端中识别和管理服务器连接。
'command': 启动 MCP 服务器的命令。全局 npm 安装时使用 'taskboard-mcp'，如果使用仓库版本，请使用 './_start_mcp' (或 './_start_all' 同时启动看板和 MCP 服务器)。
'args': 启动命令的参数，此 MCP 服务器启动命令无需参数，因此为空数组 '[]'。
'description': 服务器的描述信息，用于在客户端界面显示，方便用户了解服务器用途。
'capabilities': 声明服务器支持的 MCP 功能，TaskBoardAI MCP 服务器主要提供 'resource' (资源管理), 'tool' (工具执行), 'prompt' (Prompt模板) 能力。
'transport': 指定 MCP 服务器使用的传输协议，TaskBoardAI MCP 服务器使用标准输入输出流 'stdio' 进行通信。

基本使用方法

启动 MCP 服务器: 在终端中运行以下命令启动 MCP 服务器 (如果使用全局 npm 安装)：
```
taskboard-mcp
```
或者使用仓库版本：
```
./_start_mcp
```
或者同时启动看板 Web 服务和 MCP 服务器：
```
taskboard-all  # npm 安装版本
./_start_all   # 仓库版本
```
MCP 服务器默认运行在端口 3002 (如果同时启动 Web 服务，Web 服务默认端口为 3001)。
在 MCP 客户端中配置服务器: 根据您的 MCP 客户端 (如 Claude Code, Cursor, Windsurf 等) 的文档，添加新的 MCP 服务器连接，并使用上述 JSON 配置信息进行配置。
通过 AI Agent 使用: 配置完成后，您可以使用支持 MCP 协议的 AI Agent (如 Claude Code, Cursor, Windsurf 等) 与 TaskBoardAI MCP 服务器进行交互，例如：
- "Show me all my kanban boards" (列出所有看板)
- "Create a new kanban board called 'Project X'" (创建新看板)
- "Show me the details of Project X" (查看看板详情)
- "Update the Project X board with our progress" (更新看板)
- "Delete the Project X board" (删除看板)
具体指令取决于您的 AI Agent 的自然语言理解能力和 MCP 客户端的实现。请参考您的 AI Agent 和 MCP 客户端的文档获取更详细的使用方法。

关键词