Installation Guide

This guide will help you install and configure the gm-mcp scaffold tool.

System Requirements

• Node.js >= 16.0.0
• npm >= 7.0.0 or yarn >= 1.22.0

Installation Methods

Method 1: Global Installation (Recommended)

npm install -g @studiogm/gm-mcp

This is the simplest method. After installation, you can use the gm-mcp command anywhere.

Method 2: Using npx (No Installation Required)

npx gm-mcp init my-project

Automatically downloads the latest version each time you use it, suitable for occasional use.

Method 3: Install from Source

# Clone repository
git clone https://github.com/studiogmls/gm-mcp.git
cd gm-mcp

# Install dependencies
npm install

# Build project
npm run build

# Global link
npm link

Verify Installation

After installation, run the following command to verify successful installation:

gm-mcp --version

If the version number is displayed, the installation was successful.

View Help

gm-mcp --help

This will display all available commands and options.

Updates

Check for Updates

gm-mcp update

Manual Update

npm update -g @studiogm/gm-mcp

Uninstall

If you need to uninstall gm-mcp:

npm uninstall -g @studiogm/gm-mcp

Troubleshooting

Permission Issues

If you encounter permission errors, try:

# Use sudo (macOS/Linux)
sudo npm install -g @studiogm/gm-mcp

# Or configure npm to use a different directory
npm config set prefix ~/.npm-global
export PATH=~/.npm-global/bin:$PATH

Network Issues

If download speed is slow, configure npm mirror:

npm config set registry https://registry.npmmirror.com

Version Conflicts

If you encounter version conflicts:

# View installed version
npm list -g @studiogm/gm-mcp

# Force reinstall
npm uninstall -g @studiogm/gm-mcp
npm install -g @studiogm/gm-mcp

Next Steps

After installation, you can:

• Quick Start - Create your first project
• Basic Usage - Learn basic commands
• Template Overview - Learn about available templates