Mcptix

🚀 mcptix

mcptix is a tool that provides initialization, operation, and configuration functions for projects, integrating MCP protocol and offering advanced customization options.

🚀 Quick Start

Initialize and run mcptix in your project:

# Initialize mcptix in the project
npx mcptix init

# Run mcptix and automatically open the browser
npx mcptix start

# Example of configuration parameters:
npx mcptix start --port 3001 --host 0.0.0.0 --no-open

✨ Features

MCP Protocol Integration

MCP Server Configuration Steps:

1. Initialize the project and install dependencies:

npm install @ownlytics/mcptix

2. Create or modify the MCP configuration file:

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

3. Add a script to start the MCP server to package.json:

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

4. Start the MCP service in the AI assistant:

// Example Node.js code
const exec = require('child_process').exec;
exec('npm run start:mcp', (error, stdout) => {
    if (error) {
        console.error('Failed to start MCP:', error);
        return;
    }
    console.log('MCP has been started');
});

Advanced Configuration

Modify the .mcptix/mcptix.config.js file to customize mcptix:

module.exports = {
  // Database configuration
  dbPath: './.mcptix/data/mcptix.db',

  // API server configuration
  apiPort: 3000,
  apiHost: 'localhost',

  // Server options
  mcpEnabled: false, // Disabled by default - MCP service is started by the LLM assistant
  apiEnabled: true,

  // Log configuration
  logLevel: 'info',

  // Data management
  clearDataOnInit: false,
};

Common Customizations

• Change the port: If port 3000 is occupied, modify apiPort to another number.
• Change the data storage location: If you need to change the data directory, adjust dbPath.

📚 Documentation

Troubleshooting

Installation Issues

• "Command not found" when running mcptix

  • Ensure that mcptix is installed (npm install @ownlytics/mcptix).
  • Try using the full path: ./node_modules/.bin/mcptix.

• Initialization failure

  • Check if you have write permissions in the current directory.
  • Confirm that Node.js is installed and the version is correct.

mcptix UI Startup Failure

• Port is already occupied

  • Modify the port in .mcptix/mcptix.config.js.
  • Check if there are other instances running.

• Database error

  • Ensure that dbPath is correct and accessible.
  • Check the log file for more information.

AI Integration Issues

• MCP startup failure
  • Check if the Node.js path is correctly configured.
  • Ensure that all dependencies are correctly installed.

Command Line Reference

# Initialize the project
npx mcptix init

# Run and open the browser
npx mcptix start

# Start only the API service
npx mcptix start --only-api

# Start the MCP service
npx mcptix mcp --port 5001

📄 License

mcptix is open - source and follows the MIT License. For more information, please refer to the project repository.

Thank you for using mcptix! For more help, please visit our documentation or contact the support team.