Yeoman

You can deploy a Model Context Protocol (MCP) server that integrates Yeoman generators, letting AI agents search for templates, fetch their options, and run generators to scaffold applications automatically. This server streamlines working with Yeoman templates from within an MCP-enabled workflow.

How to use

You interact with the Yeoman MCP server through your MCP client. Start the server in the environment you prefer (via npx or a direct Node.js invocation), then call the available tools to search for templates, retrieve generator options, and execute generators. The server exposes three core actions: search Yeoman templates, inspect a generator’s required options, and run a generator with a specified configuration.

Typical usage patterns include searching for templates related to a technology you plan to use, obtaining the exact options a generator requires, and programmatically launching a generator with your chosen settings and target directory. You can also configure a persistent generator directory to improve performance when repeatedly working with the same generators.

How to install

Prerequisites you need before installing: Node.js (version 16 or later) and a package manager such as npm or yarn.

Install via Smithery to automatically wire the MCP server for Claude Desktop:

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

Additional setup steps

Clone the project and install dependencies locally, then build the package to prepare the dist artifacts for running the MCP server.

# Clone the repository
git clone https://github.com/thirdstrandstudio/mcp-yeoman.git
cd mcp-yeoman

# Install dependencies
npm install

# Build the package
npm run build

Running options with MCP clients

You can run the MCP server either through an MCP-enabled client like Claude Desktop using npx or by invoking Node.js directly against the built distribution.

{
  "mcpServers": {
    "yeoman": {
      "command": "npx",
      "args": ["@thirdstrandstudio/mcp-yeoman"]
    }
  }
}

Direct Node.js run example

If you prefer to run the server directly from the built distribution, use Node.js with the path to the dist entry file.

{
  "mcpServers": {
    "yeoman": {
      "command": "node",
      "args": ["/path/to/mcp-yeoman/dist/index.js"]
    }
  }
}

Available tools

yeoman_search_templates

Search for Yeoman templates on npm using keywords to discover relevant generators and templates.

yeoman_get_generator_options

Retrieve the required options and arguments for a specific Yeoman generator so you can prepare the correct configuration before running it.

yeoman_generate

Execute a Yeoman generator with a given working directory, application name, version, and optional generator options and extra arguments.