mcptix

一个简单而强大的工单跟踪系统，集成了 AI 助手。

什么是 mcptix？

mcptix 是一个工单跟踪系统，可以帮助您管理项目的任务、错误和功能。 它被设计成易于使用，并通过模型上下文协议 (MCP) 与 AI 助手集成。

• 📋 跟踪工单 - 为您的项目创建、更新和管理工单
• 🧠 衡量复杂性 - 使用复杂性智能引擎跟踪您的工单的复杂程度
• 💬 添加评论 - 通过工单上的评论进行协作
• 🤖 AI 集成 - 将您的 AI 助手连接到 mcptix

超级简单的设置（适用于所有人）

步骤 1：安装 mcptix

打开您的终端并运行：

npm install @ownlytics/mcptix

步骤 2：在您的项目中初始化 mcptix

npx mcptix init

这将：

• 在您的项目中创建一个 .mcptix 文件夹
• 添加配置文件
• 设置必要的配置文件

步骤 3：启动 mcptix

npx mcptix start

就是这样！ mcptix 将启动并在您的浏览器中自动打开。

使用 mcptix

看板

当您打开 mcptix 时，您将看到一个看板，其中包含不同工单状态的列：

• Backlog（待办事项） - 需要处理的工单
• Up Next（下一步） - 准备好处理的工单
• In Progress（进行中） - 当前正在处理的工单
• In Review（审核中） - 正在审核的工单
• Completed（已完成） - 已完成的工单

创建工单

1. 单击右上角的“New Ticket（新建工单）”按钮
2. 填写工单详细信息：
   • Title（标题）
   • Description（描述）
   • Status（状态）
   • Priority（优先级）
3. 单击“Save（保存）”

更新工单

1. 单击工单以打开它
2. 编辑工单详细信息
3. 更改会自动保存

添加评论

1. 打开一个工单
2. 向下滚动到“Comments（评论）”部分
3. 输入您的评论
4. 单击“Add Comment（添加评论）”

连接 AI 助手（MCP 配置）

mcptix 包含一个 MCP 服务器，允许 AI 助手与您的工单进行交互。 MCP 服务器旨在由您的 AI 助手启动，而不是由 mcptix 本身启动。

1. 安装 mcptix

如果您尚未安装，请安装 Epic Tracker：

npm install mcptix

2. 在您的项目中初始化 mcptix

npx mcptix init

这将在您的项目中创建一个 .mcptix 目录，其中包含所有必要的配置文件，包括位于 .mcptix/mcp-server-config.json 的 MCP 服务器配置文件。

3. 配置您的 AI 助手以使用 mcptix MCP 服务器

将 MCP 服务器配置文件复制到您的 AI 助手的配置目录：

对于 Roo：

cp .mcptix/mcp-server-config.json .roo/mcp.json

对于其他 AI 助手，请查阅他们的文档，了解如何配置 MCP 服务器。

配置文件包含您的 AI 助手启动和连接到 Epic Tracker MCP 服务器所需的所有必要信息。

mcptix MCP 服务器配置

此文件供 LLM 代理（如 Roo）用于连接到 mcptix MCP 服务器。 将此文件复制到您的 LLM 代理的配置目录。 对于 Roo，这通常是项目根目录中的 .roo/mcp.json。

重要提示：MCP 服务器应由 LLM 代理/扩展启动，而不是由 mcptix 启动。 您只需要运行 'npx mcptix start' 来启动 UI。

{
  "mcpServers": {
    "mcptix": {
      "command": "/absolute/path/to/your/node",
      "args": ["/absolute/path/to/node_modules/mcptix/dist/mcp/index.js"],
      "env": {
        "MCPTIX_HOME_DIR": "/absolute/path/to/.mcptix",
        "HOME": "/home/your-username"
      },
      "disabled": false,
      "alwaysAllow": []
    }
  }
}

4. 启动 mcptix UI

npx mcptix start

这将仅启动 mcptix UI（API 服务器）。 MCP 服务器将在需要时由您的 AI 助手启动。 这将仅启动 mcptix UI（API 服务器）。 MCP 服务器将在需要时由您的 AI 助手启动。

5. 将 mcptix 与您的 AI 助手一起使用

配置完成后，您的 AI 助手将能够：

• 列出、创建、更新和删除工单
• 向工单添加评论
• 搜索工单
• 获取有关您的工单的统计信息

MCP 服务器通过您的 AI 助手可以使用的工具和资源提供这些功能。

自定义 mcptix

您可以通过编辑项目中的 .mcptix/mcptix.config.js 文件来自定义 mcptix：

module.exports = {
  // 数据库配置
  dbPath: './.mcptix/data/mcptix.db',

  // API 服务器配置
  apiPort: 3000,
  apiHost: 'localhost',

  // 服务器选项
  mcpEnabled: false, // 默认禁用 - MCP 服务器应由 LLM 代理启动
  apiEnabled: true,

  // 日志配置
  logLevel: 'info',

  // 数据管理
  clearDataOnInit: false,
};

常见自定义项

• 更改端口：如果端口 3000 已在使用中，请将 apiPort 更改为另一个数字
• 启用 MCP 进行测试：如果您想直接测试 MCP 服务器，请将 mcpEnabled 设置为 true
• 更改数据位置：如果您想将数据存储在其他位置，请更改 dbPath

开发工作流程

如果您希望在本地开发 mcptix，请查看 Development Workflow 指南。

故障排除

mcptix 无法启动

如果 mcptix 无法启动，请检查：

1. 另一个应用程序是否正在使用端口 3000？ 更改配置文件中的端口。
2. 您是否有权写入数据目录？ 检查文件权限。
3. 是否已安装 Node.js 并且是最新的？ mcptix 需要 Node.js 14 或更高版本。

无法连接 AI 助手

如果您的 AI 助手无法连接到 mcptix：

1. 检查您的 MCP 配置文件是否已正确复制到您的 AI 助手的配置目录
2. 验证 MCP 配置文件中的路径是否正确
3. 确保您的 AI 助手支持模型上下文协议
4. 确保 MCP 服务器可以访问数据库路径

命令行选项

mcptix 提供了几个命令行选项：

# 在您的项目中初始化 mcptix
npx mcptix init

# 启动 mcptix
npx mcptix start

# 使用自定义端口和主机启动
npx mcptix start --port 3001 --host 0.0.0.0

# 启动时不打开浏览器
npx mcptix start --no-open

# 仅启动 MCP 服务器（用于开发/测试目的）
npx mcptix mcp

关于 MCP 服务器的重要说明

MCP 服务器旨在由您的 AI 助手启动，而不是由 mcptix 本身启动。 这是为什么：

1. mcpEnabled 选项默认设置为 false
2. npx mcptix start 命令仅启动 UI（API 服务器）
3. MCP 服务器配置文件在初始化期间生成

npx mcptix mcp 命令仅用于开发和测试目的。 在正常操作中，您不需要手动启动 MCP 服务器。

当您的 AI 助手需要与 mcptix 交互时，它将：

1. 从其配置目录读取 MCP 配置文件
2. 按照配置中的指定启动 MCP 服务器
3. 连接到 MCP 服务器
4. 使用 MCP 服务器提供的工具和资源与 mcptix 交互

这种架构确保：

1. MCP 服务器仅在需要时运行
2. MCP 服务器可以访问正确的数据库
3. MCP 服务器已针对您的 AI 助手正确配置

适用于高级用户

如果您熟悉代码，您也可以以编程方式使用 mcptix：

const { createMcpTix } = require('mcptix');

// 创建一个 mcptix 实例
const mcpTix = createMcpTix();

// 启动 API 服务器 (UI)
// 注意：MCP 服务器默认禁用
await mcpTix.start();

// 获取用于编程访问的工单查询
const ticketQueries = mcpTix.getTicketQueries();

// 创建一个工单
const ticketId = ticketQueries.createTicket({
  title: 'Example Ticket',
  description: 'This is an example ticket.',
  priority: 'medium',
  status: 'backlog',
});

// 完成后关闭
await mcpTix.shutdown();

🛡️ 许可证和使用

本项目采用 Business Source License 1.1 (BSL 1.1) 许可证。

欢迎您出于非商业目的使用、修改和探索此软件，包括内部评估、实验或研究。

商业用途 — 包括在生产、付费服务或企业环境中使用 — 需要从 Tesseract Labs, LLC 获得商业许可证。

我们很乐意支持希望使用此工具进行集成或扩展的团队。 请联系我们以获取许可或咨询：

📧 tim@ownlytics.ai 📄 查看完整许可条款

遵守此许可证有助于支持持续的开发和创新。