Overview
What is Yeoman?
Yeoman is a Model Context Protocol (MCP) server that integrates Yeoman generators with AI agents, enabling them to search for and run Yeoman templates programmatically.
How to use Yeoman?
Install via Smithery (npx @smithery/cli@latest install mcp-yeoman --client claude) or manually by cloning the repository, running npm install and npm run build. Then add a yeoman entry to your claude_desktop_config.json with the npx or node command. Optionally pass --generator-dir <path> to use a persistent directory for generator installations.
Key features of Yeoman
- Search for Yeoman templates on npm by keyword.
- Retrieve required options and arguments for a generator.
- Run any Yeoman generator with custom options and arguments.
- Supports persistent generator directory for repeated use.
- Comprehensive error handling and validation.
Use cases of Yeoman
- Search for React or TypeScript templates from an AI assistant.
- Get available options for a specific generator before running it.
- Scaffold a new project by running a Yeoman generator via MCP.
- Automate project setup with different generators in different directories.
FAQ from Yeoman
What are the prerequisites for using Yeoman?
Node.js v16 or later and npm or yarn are required.
Where are Yeoman generators installed by default?
Generators are installed in a temporary directory that is removed when the operation completes. Use the --generator-dir option to specify a persistent directory.
How do I configure Yeoman with Claude Desktop?
Add a yeoman entry to claude_desktop_config.json using either npx @thirdstrandstudio/mcp-yeoman or the local node path to dist/index.js.
What tools does Yeoman provide?
Three tools: yeoman_search_templates (search npm), yeoman_get_generator_options (get generator options), and yeoman_generate (run a generator with parameters).
How does Yeoman handle errors?
It validates parameters, detects interactive prompts and guides the user, logs detailed errors, cleans up temporary directories automatically (unless --generator-dir is set), and propagates errors safely through the MCP protocol.
