使用说明

快速入门

在项目中初始化并运行 mcptix：

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

# 运行 mcptix 并自动打开浏览器
npx mcptix start

# 配置参数示例:
npx mcptix start --port 3001 --host 0.0.0.0 --no-open

MCP 协议集成

MCP 服务器配置步骤:

1. 初始化项目并安装依赖：

npm install @ownlytics/mcptix

2. 创建或修改 MCP 配置文件：

// .mcptix/mcptix.mcp.json
{
  "mcpEnabled": true,
  "mcpPort": 5001,
  "nodePath": "/usr/bin/node",
  "mcpServerPath": "./node_modules/.bin/mcptix-mcp"
}

3. 添加启动 MCP 服务器的脚本到 package.json：

{
  "scripts": {
    "start:mcp": "mcptix mcp --port ${NODE_PORT}"
  }
}

4. 在 AI 助手中启动 MCP 服务：

// 示例 Node.js 代码
const exec = require('child_process').exec;
exec('npm run start:mcp', (error, stdout) => {
    if (error) {
        console.error('MCP 启动失败:', error);
        return;
    }
    console.log('MCP 已启动');
});

高级配置

修改 .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 为其他数字
• 变更数据存储位置：若需更改数据目录，调整 dbPath

故障排除

安装问题

• "命令未找到" 当运行 mcptix

  • 确保已安装 mcptix (npm install @ownlytics/mcptix)
  • 尝试使用完整路径：./node_modules/.bin/mcptix

• 初始化失败

  • 检查是否具有写入当前目录的权限
  • 确认 Node.js 已安装且版本正确

mcptix UI 启动失败

• 端口已被占用

  • 修改 .mcptix/mcptix.config.js 中的端口
  • 检查是否有其他实例在运行

• 数据库错误

  • 确保 dbPath 正确且可访问
  • 检查日志文件以获取更多信息

AI 集成问题

• MCP 启动失败
  • 检查 Node.js 路径是否正确配置
  • 确保所有依赖已正确安装

命令行参考

# 初始化项目
npx mcptix init

# 运行并打开浏览器
npx mcptix start

# 只启动 API 服务
npx mcptix start --only-api

# 启动 MCP 服务
npx mcptix mcp --port 5001

许可证信息

mcptix 开源协议遵循 MIT License。更多信息请参考项目仓库。

感谢使用 mcptix！如需更多帮助，请访问我们的文档或联系支持团队。