使用说明

项目简介

Markdown Ticket Board是一个创新的项目管理工具，它利用Markdown文件的灵活性和Git的版本控制能力，结合LLM（大型语言模型）的强大AI能力，实现了从需求讨论、工单创建、任务分配到代码实现和评审的全流程自动化。用户可以将项目工单、需求文档等以Markdown格式存储，并通过直观的看板界面进行管理，同时赋予AI助手直接读写和更新工单的能力，从而显著提升开发效率和协作质量。

主要功能点

Markdown文档管理: 以Markdown文件形式存储所有工单和项目文档，支持美观渲染、代码高亮和Mermaid图表。
AI上下文持久化: 通过原生MCP（Model Context Protocol）集成，确保AI助手在不同会话中能够持续访问项目上下文，避免信息丢失。
规范驱动的工作流: 定义详细的需求规范，然后由AI助手根据规范进行代码实现，确保符合预期。
看板式工单组织: 提供拖放式界面，按状态列组织工单，支持可视化进度跟踪和多项目管理。
AI工具集: LLM可调用'list_projects'、'get_project_info'、'list_crs'、'get_cr'、'create_cr'、'update_cr_status'、'manage_cr_sections'等工具来管理工单。
Git版本控制: 所有工单和文档都存储在Git仓库中，确保完整的历史记录和团队协作无冲突。
无需数据库: 基于文件系统存储，部署轻量，支持Docker一键部署。

安装步骤

克隆仓库:

git clone https://github.com/andkirby/markdown-ticket.git

进入目录:
```
cd markdown-ticket
```
启动Docker (推荐):
```
bin/dc up -d
```
或者本地启动:
- 构建JavaScript代码:
```
npm run build:all
```
- 启动生产环境服务 (前端/后端):
```
./start.sh
```

MCP服务器配置

MCP服务器需要配置到你的LLM客户端（如Claude Code或兼容的MCP客户端）中。你可以选择HTTP或STDIO两种传输协议。

HTTP传输协议配置 (Docker部署):
- 服务器名称: 'mdt-all' (在客户端中标识此MCP服务器的名称，可自定义)
- 传输协议: 'http'
- 服务器地址: 'http://localhost:3012/mcp'
STDIO传输协议配置 (本地部署或Docker容器内):
- 服务器名称: 'mdt-all' (在客户端中标识此MCP服务器的名称，可自定义)
- 传输协议: 'stdio' (通过命令行直接执行服务器进程)
- 服务器启动命令 (command): 'node'
- 服务器启动参数 (args): '["$PWD/mcp-server/dist/index.js"]' (本地) 或 '["/app/mcp-server/dist/index.js"]' (Docker容器内)。请注意，'$PWD' 会被替换为当前工作目录的绝对路径。
MCP客户端配置示例 (非代码，仅为说明格式，实际操作请参考你的MCP客户端文档): 假设你的MCP客户端有一个添加服务器的界面或命令行工具，你需要提供如下信息：
- 对于HTTP传输：
  - 'Name': 'mdt-all'
  - 'Transport Protocol': 'HTTP'
  - 'Endpoint URL': 'http://localhost:3012/mcp'
- 对于STDIO传输：
  - 'Name': 'mdt-all'
  - 'Transport Protocol': 'STDIO'
  - 'Command': 'node'
  - 'Arguments': '["$PWD/mcp-server/dist/index.js"]' (或对应Docker路径)

基本使用方法

访问Web界面: 启动服务器后，通过浏览器访问Web界面。
- Docker部署: 'http://localhost:5174'
- 本地生产环境: 'http://localhost:4173'
创建/管理项目: 通过Web界面或命令行工具 'project-cli' (例如 'npm run project:create') 创建和管理项目。
与AI助手协作: 在LLM客户端中配置好MCP服务器后，LLM即可调用MCP服务器提供的工具来：
- 读取资源: 获取项目列表、工单详情 ('list_projects', 'get_project_info', 'list_crs', 'get_cr')。
- 创建工单: 依据LLM与用户讨论的结果，生成结构化的Markdown工单 ('create_cr')。
- 更新工单: LLM可根据用户指令或自身逻辑，更新工单状态 ('update_cr_status')、修改工单属性 ('update_cr_attrs') 或管理工单内容的不同部分 ('manage_cr_sections')。
- 利用Prompt模板: 在与AI助手交互时，可以使用仓库中提供的'prompts/mdt-ticket-creation.md'等模板，生成高质量的结构化工单。
Git同步: 所有更改都反映在Markdown文件中，并可轻松通过Git进行版本控制和团队协作。

关键词