Frequently Asked Questions (FAQ) about MCP Yeoman Server

Q: What is the MCP Yeoman Server? A: The MCP Yeoman Server is a Model Context Protocol (MCP) server that integrates Yeoman generators with AI agents, allowing for programmatic project scaffolding.

Q: What is MCP? A: MCP (Model Context Protocol) is an open protocol that standardizes how applications provide context to Large Language Models (LLMs).

Q: What is Yeoman? A: Yeoman is a scaffolding tool that automates the creation of new projects, modules, or components based on pre-defined templates.

Q: How does the MCP Yeoman Server work? A: It allows AI agents to search for and run Yeoman templates programmatically, automating project setup and code generation.

Q: What are the key features of the MCP Yeoman Server? A: Key features include template search methods (yeoman_search_templates), generator methods (yeoman_get_generator_options, yeoman_generate), and integration with Claude Desktop.

Q: What is yeoman_search_templates? A: This method allows AI agents to search for Yeoman templates on npm using keywords.

Q: What parameters does yeoman_search_templates accept? A: It accepts query (search keywords) and pageSize (number of results to return).

Q: What is yeoman_get_generator_options? A: This method retrieves the required options and arguments for a specific Yeoman generator.

Q: What parameter does yeoman_get_generator_options accept? A: It accepts generatorName (name of the generator without the ‘generator-’ prefix).

Q: What is yeoman_generate? A: This method executes a Yeoman generator with specified parameters.

Q: What parameters does yeoman_generate accept? A: It accepts generatorName, cwd (working directory), appName (application name), version (application version), options (generator options), and args (additional arguments).

Q: How do I install the MCP Yeoman Server? A: You can install it using Smithery or manually by cloning the repository, installing dependencies, and building the package.

Q: How do I install the MCP Yeoman Server using Smithery? A: Run the command: npx @smithery/cli@latest install mcp-yeoman --client claude.

Q: What are the prerequisites for installing the MCP Yeoman Server? A: You need Node.js (v16 or later) and npm or yarn.

Q: How do I configure the MCP Yeoman Server for use with Claude Desktop? A: Add the MCP server configuration to your claude_desktop_config.json file, specifying the command and arguments.

Q: Can I use npx to run the MCP Yeoman Server with Claude Desktop? A: Yes, you can use npx. See the example configuration in the documentation.

Q: Can I use a direct Node.js path to run the MCP Yeoman Server with Claude Desktop? A: Yes, you can use a direct path to the index.js file. See the example configuration in the documentation.

Q: What command-line arguments does the MCP Yeoman Server support? A: It supports the --generator-dir argument to specify a persistent directory for installing Yeoman generators.

Q: Why would I use the --generator-dir argument? A: Using a persistent directory can improve performance for repeated operations with the same generators.

Q: Where can I find examples of how to use the MCP Yeoman Server? A: Examples are provided in the documentation for searching templates, getting generator options, and running a generator.

Q: How do I contribute to the MCP Yeoman Server? A: Fork the repository, create a feature branch, submit a pull request with a clear description of changes, and ensure all tests pass.

Q: What license is the MCP Yeoman Server released under? A: The MCP Yeoman Server is licensed under the MIT License.

Q: What is UBOS? A: UBOS is a full-stack AI Agent Development Platform focused on bringing AI Agents to every business department. It allows you to orchestrate AI Agents, connect them with your enterprise data, build custom AI Agents, and create Multi-Agent Systems.