Quick Start Guide

Get up and running with MCPCodex in under 5 minutes

Prerequisites

  • Node.js 18+ installed
  • npm or yarn package manager
  • MCPCodex API key (sign up at mcpcodex.com)

1Installation

Install the MCPCodex CLI globally using npm:

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

# Verify installation
mcp --version

2Create Your First Project

Initialize a new MCPCodex project:

Terminal
# Create a new project
mcp init my-project

# Navigate to project directory
cd my-project

# Install dependencies
npm install

3Configuration

Configure your project with your API key and preferences:

mcpcodex.config.js
// mcpcodex.config.js
export default {
  model: 'claude-3-opus',
  apiKey: process.env.MCP_API_KEY,
  agents: {
    coder: { temperature: 0.2 },
    reviewer: { temperature: 0.1 },
    tester: { temperature: 0.3 }
  },
  integrations: {
    github: true,
    vscode: true
  }
};

⚠ Security Note: Never commit your API key to version control. Use environment variables or a secure configuration management system.

4Generate Your First Code

Try these commands to see MCPCodex in action:

Terminal
# Generate a simple API endpoint
mcp generate "Create a REST API endpoint for user authentication with JWT"

# Start development server
mcp dev

# Run tests
mcp test

5Using the SDK

For programmatic access, use the MCPCodex SDK:

JavaScript/TypeScript
import { MCPCodex } from '@mcpcodex/sdk';

const mcp = new MCPCodex({
  apiKey: process.env.MCP_API_KEY,
  model: 'claude-3-opus'
});

// Generate code
const result = await mcp.generate({
  prompt: "Create a TypeScript function that validates email addresses",
  context: {
    language: "typescript",
    framework: "node.js"
  }
});

console.log(result.code);

Need Help?

Stuck? Our community and support team are here to help.