DocsGetting StartedInstallation

Installation Guide

Install MCPCodex CLI and SDKs on your system. Choose from multiple installation methods and get up and running in minutes.

System Requirements

Operating System

  • • macOS 10.15+ (Catalina)
  • • Windows 10/11
  • • Linux (Ubuntu 18.04+)
  • • Docker support

Runtime

  • • Node.js 18+ (for npm/yarn)
  • • Python 3.8+ (for pip)
  • • Go 1.19+ (for go get)
  • • Rust 1.70+ (for cargo)

Resources

  • • 4GB RAM minimum
  • • 1GB disk space
  • • Internet connection
  • • Git (recommended)

CLI Installation

Choose your preferred package manager to install the MCPCodex CLI:

Terminal
# Install MCPCodex CLI globally
npm install -g @mcpcodex/cli

# Verify installation
mcp --version

# Check available commands
mcp --help

SDK Installation

Install the MCPCodex SDK for your preferred programming language:

Multiple Languages
# JavaScript/TypeScript SDK
npm install @mcpcodex/sdk

# Python SDK
pip install mcpcodex

# Go SDK
go get github.com/mcpcodex/go-sdk

# Rust SDK
cargo add mcpcodex

# Java SDK
<dependency>
  <groupId>com.mcpcodex</groupId>
  <artifactId>mcpcodex-java</artifactId>
  <version>2.0.0</version>
</dependency>
🟡

JavaScript/TypeScript

Full-featured SDK with type safety and documentation.

View Docs
🐍

Python

Full-featured SDK with type safety and documentation.

View Docs
🐹

Go

Full-featured SDK with type safety and documentation.

View Docs
🦀

Rust

Full-featured SDK with type safety and documentation.

View Docs
☕

Java

Full-featured SDK with type safety and documentation.

View Docs
💜

C#

Full-featured SDK with type safety and documentation.

View Docs

Initial Configuration

1. Authenticate with MCPCodex

# Login with your MCPCodex account
mcp auth login

# Or set API key directly
mcp config set apiKey YOUR_API_KEY

# Verify authentication
mcp auth status

2. Configure Settings

MCPCodex stores configuration in ~/.mcpcodex/config.json:

config.json
// ~/.mcpcodex/config.json
{
  "apiKey": "your-api-key-here",
  "defaultModel": "claude-3-opus",
  "environment": "production",
  "outputFormat": "pretty",
  "autoUpdate": true,
  "telemetry": true,
  "editor": {
    "default": "vscode",
    "theme": "dark"
  },
  "agent": {
    "concurrency": 4,
    "timeout": 300,
    "retries": 3
  }
}

Verify Installation

Installation Verification Script

Use this script to verify your MCPCodex installation is working correctly:

verify-installation.sh
#!/bin/bash
# MCPCodex Installation Verification Script

echo "🔍 Verifying MCPCodex installation..."

# Check CLI installation
if command -v mcp &> /dev/null; then
    echo "✅ MCPCodex CLI is installed"
    echo "   Version: $(mcp --version)"
else
    echo "❌ MCPCodex CLI not found"
    exit 1
fi

# Check API key configuration
if mcp auth status &> /dev/null; then
    echo "✅ API key is configured and valid"
else
    echo "⚠️  API key not configured or invalid"
    echo "   Run: mcp auth login"
fi

# Test basic functionality
echo "🧪 Testing basic functionality..."
if mcp generate --test &> /dev/null; then
    echo "✅ Code generation is working"
else
    echo "❌ Code generation test failed"
fi

echo "🎉 Installation verification complete!"

Quick Test Commands

Check CLI Version
mcp --version
Test Authentication
mcp auth status
Generate Sample Code
mcp generate --test
List Available Models
mcp models list

Troubleshooting

Command not found: mcp

The CLI wasn't installed properly or isn't in your PATH. Try:

  • • Restart your terminal after installation
  • • Check if the package manager added MCPCodex to your PATH
  • • For npm: ensure global packages are in PATH
  • • For curl install: add ~/.mcpcodex/bin to PATH

Permission denied errors

Installation failed due to permission issues:

# Use sudo for global npm installs (Linux/macOS) sudo npm install -g @mcpcodex/cli # Or use a Node version manager like nvm nvm use node npm install -g @mcpcodex/cli

Network connection issues

MCPCodex requires internet access for AI model inference:

  • • Check firewall settings
  • • Verify corporate proxy configuration
  • • Ensure api.mcpcodex.com is accessible
  • • Test with: curl -I https://api.mcpcodex.com

Next Steps

Quick Start Guide

Create your first MCPCodex project and generate code with AI.

Start Building

Your First Project

Learn the fundamentals by building a complete application.

Learn More

Installation Issues?

Having trouble with installation? Our support team is here to help.

Get HelpReport IssueTroubleshooting