Yeoman

🚀 MCP Manual Home Server

This is a server implementing the Model Context Protocol (MCP), offering integration with Yeoman generators. It allows AI agents to search for and run Yeoman templates.

🚀 Quick Start

This server implements a Model Context Protocol (MCP) and integrates with Yeoman generators, enabling AI agents to search for and run Yeoman templates.

✨ Features

The server implements the following MCP tools:

Template Search Method

1. yeoman_search_templates - Search for Yeoman templates on npm
   • Parameters:
     • query (string): Comma-separated keywords
     • pageSize (number, optional): Number of results per page (default: 20)

Generator Methods

2. yeoman_get_generator_options - Get the options and parameters required by a Yeoman generator

   • Parameters:
     • generatorName (string): Name of the generator (without the "generator-" prefix)

3. yeoman_generate - Run a Yeoman generator

   • Parameters:
     • generatorName (string): Name of the generator (without the "generator-" prefix)
     • cwd (string): Working directory where the generator runs
     • appName (string): Name of the application to be created
     • version (string): Version of the application to be created
     • options (object, optional): Options passed to the generator
     • args (array, optional): Additional positional arguments passed to the generator

📦 Installation

Install via Smithery

To automatically install mcp-yeoman for Claude Desktop via Smithery:

npx @smithery/cli@latest install mcp-yeoman --client claude

Prerequisites

• Node.js (v16 or higher)
• npm (Node Package Manager)

💻 Usage Examples

Basic Usage

To use the MCP Yeoman Server, follow these steps:

1. Clone this repository:

   git clone https://github.com/yourusername/mcp-yeeman.git
   cd mcp-yeeman
   

2. Install dependencies:

   npm install
   

3. Start the server:

   npm start
   

4. Access the console to view logs and status information.

Advanced Usage

To configure the server, edit the config.json file and then start the server:

npm run start -- --config config.json

🔧 Technical Details

This server includes comprehensive error handling:

• Validation errors for invalid parameters
• Detection and guidance for interactive prompts
• Detailed error logging for debugging
• Secure cleanup of temporary directories (unless using --generator-dir)
• Propagation of errors through the MCP protocol

📄 License

This MCP server is released under the MIT License. This means you are free to use, modify, and distribute the software, subject to the terms and conditions of the MIT License. For more details, please refer to the LICENSE file in the project repository.

🤝 Contribution

Contributions are welcome! Please feel free to submit a Pull Request. When contributing, please:

1. Fork the repository
2. Create a feature branch
3. Submit a Pull Request with a clear description of the changes
4. Ensure all tests pass and the code style is consistent