Quick Start

Welcome to gm-mcp! This is a scaffold tool for quickly creating MCP TypeScript projects.

What is MCP?

MCP (Model Context Protocol) is an open protocol for connecting AI models with external data sources. It allows AI models to securely access and operate various tools, data sources, and services.

Why Choose gm-mcp?

• 🚀 Quick Start: Create complete MCP projects in seconds
• 📦 Multiple Templates: Choose from basic, advanced, and minimal templates
• 🎨 Beautiful Interface: Elegant console output and loading animations
• ⚡ Interactive Configuration: Smart project configuration wizard
• 🔧 Complete Toolchain: Integrated TypeScript, testing, ESLint, and more

Installation

Global Installation

npm install -g @studiogm/gm-mcp

Verify Installation

gm-mcp --version

Create Your First Project

1. Interactive Creation

gm-mcp init my-mcp-project

This will start an interactive wizard to guide you through project creation:

• Choose project template
• Configure project options
• Automatically install dependencies

2. Quick Creation

# Use default configuration
gm-mcp init my-project --yes

# Specify template
gm-mcp init my-project --template advanced

3. Start Development

cd my-mcp-project
npm run dev

Project Structure

The created project will have the following structure:

my-mcp-project/
├── src/
│   ├── index.ts          # Main entry file
│   ├── tools/            # Tool definitions
│   └── utils/            # Utility functions
├── dist/                 # Compiled output
├── package.json          # Project configuration
├── tsconfig.json         # TypeScript configuration
└── README.md             # Project documentation

Next Steps

• Installation Guide - Detailed installation instructions
• Basic Usage - Learn basic commands
• Advanced Usage - Explore advanced features
• Template Overview - Learn about all available templates