Mcptix

🚀 mcptix 使用說明

mcptix 是一個實用的工具，可幫助用戶在項目中進行初始化、運行及集成 MCP 協議等操作，還支持高級配置以滿足不同需求。

🚀 快速開始

在項目中初始化並運行 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 已啟動');
});

💻 使用示例

基礎用法

# 初始化項目
npx mcptix init

# 運行並打開瀏覽器
npx mcptix start

高級用法

# 只啟動 API 服務
npx mcptix start --only-api

# 啟動 MCP 服務
npx mcptix mcp --port 5001

📚 詳細文檔

高級配置

修改 .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 路徑是否正確配置。
  • 確保所有依賴已正確安裝。

📄 許可證

mcptix 開源協議遵循 MIT License。更多信息請參考項目倉庫。

感謝使用 mcptix！如需更多幫助，請訪問我們的文檔或聯繫支持團隊。