mcp-new 0.1.0 → 1.2.0

package/README.md

@@ -1,162 +1,246 @@
+<div align="center">
+
 # mcp-new
 
-> CLI generator for MCP servers in seconds. Like `create-react-app`, but for MCP.
+**CLI generator for MCP servers in seconds**
 
-## Quick Start
+[![npm version](https://img.shields.io/npm/v/mcp-new.svg?style=flat-square)](https://www.npmjs.com/package/mcp-new)
+[![npm downloads](https://img.shields.io/npm/dm/mcp-new.svg?style=flat-square)](https://www.npmjs.com/package/mcp-new)
+[![license](https://img.shields.io/npm/l/mcp-new.svg?style=flat-square)](https://github.com/d1maash/mcp-new/blob/main/LICENSE)
 
-```bash
-npx mcp-new my-server
-```
+Like `create-react-app`, but for [Model Context Protocol](https://spec.modelcontextprotocol.io/) servers.
 
-## Features
+[Getting Started](#-getting-started) •
+[Features](#-features) •
+[Presets](#-presets) •
+[Documentation](#-documentation) •
+[Contributing](#-contributing)
 
-- **Interactive wizard** — create MCP server through step-by-step prompts
-- **TypeScript and Python** — support for both languages
-- **OpenAPI generation** — auto-create tools from OpenAPI/Swagger specification
-- **AI generation** — create tools from text description using Claude
-- **Ready-to-use templates** — working code with examples out of the box
+</div>
 
-## Installation
+---
+
+## ⚡ Getting Started
 
 ```bash
-npm install -g mcp-new
+npx mcp-new my-server
 ```
 
-Or use directly via npx:
+Or install globally:
 
 ```bash
-npx mcp-new my-server
+npm install -g mcp-new
+mcp-new my-server
 ```
 
-## Usage
+---
 
-### Basic creation
+## ✨ Features
 
-```bash
-npx mcp-new my-weather-api
+| Feature | Description |
+|---------|-------------|
+| 🧙 **Interactive Wizard** | Step-by-step prompts to configure your MCP server |
+| 🌍 **Multi-Language** | TypeScript, Python, Go, and Rust support |
+| 📦 **Preset Templates** | Ready-to-use templates for common use cases |
+| 📄 **OpenAPI Import** | Auto-generate tools from OpenAPI/Swagger specs |
+| 🤖 **AI Generation** | Create tools from natural language using Claude |
+| 📚 **Rich Documentation** | Generated README with examples and Claude Desktop config |
 
-# Answer the questions:
-# ? Project name: my-weather-api
-# ? Select language: TypeScript
-# ? Select transport: stdio
-# ? Add example tool? Yes
+---
 
-# Done!
-cd my-weather-api
-npm install
-npm run dev
-```
+## 🎯 Presets
 
-### With flags
+Skip the setup and start with pre-configured tools:
 
 ```bash
-# TypeScript project (skips language prompt)
-npx mcp-new my-server -t
+mcp-new my-project --preset <name> -y
+```
 
-# Python project (skips language prompt)
-npx mcp-new my-server -p
+| Preset | Description | Included Tools |
+|--------|-------------|----------------|
+| `database` | Database CRUD operations | `query` `insert` `update` `delete` `list_tables` |
+| `rest-api` | HTTP client wrapper | `http_get` `http_post` `http_put` `http_delete` `set_base_url` |
+| `filesystem` | File system operations | `read_file` `write_file` `list_directory` `search_files` `file_info` |
 
-# Skip dependency installation
-npx mcp-new my-server --skip-install
+<details>
+<summary>📋 Example: Database preset</summary>
 
-# Use default values
-npx mcp-new my-server -y
+```bash
+mcp-new my-db --preset database -t -y
 ```
 
-### From OpenAPI specification
+Creates a TypeScript MCP server with these tools ready to implement:
+
+- **query** — Execute SQL queries with parameters
+- **insert** — Insert records into tables
+- **update** — Update existing records
+- **delete** — Delete records from tables
+- **list_tables** — List all database tables
+
+</details>
+
+---
+
+## 🚀 Usage
+
+### Basic Creation
 
 ```bash
-npx mcp-new stripe-mcp --from-openapi ./stripe-api.yaml
+# Interactive mode
+mcp-new my-server
+
+# With language flag
+mcp-new my-server -t          # TypeScript
+mcp-new my-server -p          # Python
+mcp-new my-server -g          # Go
+mcp-new my-server -r          # Rust
 
-# CLI will show found endpoints and let you select the ones you need
+# Skip prompts with defaults
+mcp-new my-server -t -y
 ```
 
-### From text description (AI)
+### From OpenAPI Specification
 
 ```bash
-npx mcp-new notion-mcp --from-prompt
-
-# Describe your API in the editor
-# Claude will generate tools automatically
+mcp-new my-api --from-openapi ./openapi.yaml
 ```
 
-Requires `ANTHROPIC_API_KEY` environment variable.
+Select which endpoints to include as MCP tools.
 
-### Initialize in existing project
+### From AI Description
 
 ```bash
-cd my-existing-project
-npx mcp-new init
+export ANTHROPIC_API_KEY=your-key
+mcp-new my-server --from-prompt
 ```
 
-### Add new tool
+Describe your API in natural language, Claude generates the tools.
+
+### Additional Commands
 
 ```bash
-cd my-mcp-server
-npx mcp-new add-tool
+# Initialize in existing directory
+mcp-new init
+
+# Add a new tool to existing project
+mcp-new add-tool
 ```
 
-## CLI Commands
+---
 
-| Command | Description |
-|---------|-------------|
-| `mcp-new <name>` | Create new MCP server |
-| `mcp-new init` | Initialize MCP in current directory |
-| `mcp-new add-tool` | Add tool to existing server |
+## 📖 Documentation
 
-## Options
+### CLI Reference
 
-| Flag | Description |
-|------|-------------|
-| `-t, --typescript` | Use TypeScript (skips language prompt) |
-| `-p, --python` | Use Python (skips language prompt) |
-| `--skip-install` | Skip dependency installation |
-| `--from-openapi <path>` | Create from OpenAPI specification |
-| `--from-prompt` | Create via AI from description |
-| `-y, --yes` | Use default values |
+```
+Usage: mcp-new [options] [command] [project-name]
+
+Options:
+  -t, --typescript       Use TypeScript
+  -p, --python           Use Python
+  -g, --go               Use Go
+  -r, --rust             Use Rust
+  --preset <name>        Use preset (database, rest-api, filesystem)
+  --from-openapi <path>  Generate from OpenAPI spec
+  --from-prompt          Generate using AI
+  --skip-install         Skip dependency installation
+  -y, --yes              Use defaults
+  -V, --version          Show version
+  -h, --help             Show help
+
+Commands:
+  init                   Initialize in current directory
+  add-tool               Add tool to existing project
+```
 
-## Generated Project Structure
+### Generated Project Structure
 
-### TypeScript
+<details>
+<summary>TypeScript</summary>
 
 ```
 my-server/
+├── src/
+│   └── index.ts
 ├── package.json
 ├── tsconfig.json
 ├── README.md
 ├── .gitignore
-├── .env.example
-└── src/
-    ├── index.ts          # Main server file
-    └── tools/
-        └── example-tool.ts
+└── .env.example
 ```
 
-### Python
+</details>
+
+<details>
+<summary>Python</summary>
 
 ```
 my-server/
+├── src/
+│   ├── __init__.py
+│   ├── server.py
+│   └── tools/
+│       └── __init__.py
 ├── pyproject.toml
 ├── requirements.txt
 ├── README.md
 ├── .gitignore
-├── .env.example
-└── src/
-    ├── __init__.py
-    ├── server.py         # Main server file
-    └── tools/
-        ├── __init__.py
-        └── example_tool.py
+└── .env.example
 ```
 
-## Development
+</details>
+
+<details>
+<summary>Go</summary>
+
+```
+my-server/
+├── cmd/
+│   └── server/
+│       └── main.go
+├── internal/
+│   └── tools/
+├── go.mod
+├── README.md
+├── .gitignore
+└── .env.example
+```
+
+</details>
+
+<details>
+<summary>Rust</summary>
+
+```
+my-server/
+├── src/
+│   ├── main.rs
+│   └── tools.rs
+├── Cargo.toml
+├── README.md
+├── .gitignore
+└── .env.example
+```
+
+</details>
+
+### Generated README
+
+Each project includes a detailed README with:
+
+- ✅ Parameter tables for each tool
+- ✅ JSON examples for tool calls
+- ✅ Claude Desktop configuration snippet
+- ✅ Project structure overview
+
+---
+
+## 🛠 Development
 
 ```bash
-# Clone repository
+# Clone and install
 git clone https://github.com/d1maash/mcp-new.git
 cd mcp-new
-
-# Install dependencies
 npm install
 
 # Development
@@ -165,20 +249,45 @@ npm run dev
 # Build
 npm run build
 
-# Tests
-npm test
-
-# Local CLI testing
+# Test locally
 npm link
-mcp-new test-project
+mcp-new test-project --preset database -t -y
 ```
 
-## Links
+---
+
+## 🔗 Resources
 
 - [MCP Specification](https://spec.modelcontextprotocol.io/)
-- [MCP TypeScript SDK](https://github.com/modelcontextprotocol/typescript-sdk)
-- [MCP Python SDK](https://github.com/modelcontextprotocol/python-sdk)
+- [TypeScript SDK](https://github.com/modelcontextprotocol/typescript-sdk)
+- [Python SDK](https://github.com/modelcontextprotocol/python-sdk)
+- [Go SDK](https://github.com/mark3labs/mcp-go)
+- [Rust SDK](https://github.com/modelcontextprotocol/rust-sdk)
+
+---
+
+## 🤝 Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/amazing-feature`)
+3. Commit your changes (`git commit -m 'Add amazing feature'`)
+4. Push to the branch (`git push origin feature/amazing-feature`)
+5. Open a Pull Request
+
+---
+
+## 📄 License
+
+MIT © [Dinmukhanbet Aizharykov](https://github.com/d1maash)
+
+---
+
+<div align="center">
+
+**[⬆ Back to top](#mcp-new)**
 
-## License
+Made with ❤️ for the MCP community
 
-MIT
+</div>