Yeoman

MCP Yeoman 服务

一个用于集成 Yeoman 生成器的模型上下文协议（MCP）服务，可让 AI Agent 以编程方式搜索并运行 Yeoman 模板。

工具

此服务实现了以下 MCP 工具：

模板搜索方法

1. yeoman_search_templates - 在 npm 上搜索 Yeoman 模板
   • 参数：
     • query（字符串）：以逗号分隔的搜索关键词
     • pageSize（数字，可选）：返回结果数量（默认值：20）

生成器方法

2. yeoman_get_generator_options - 获取 Yeoman 生成器所需的选项和参数

   • 参数：
     • generatorName（字符串）：生成器名称（不含 generator- 前缀）

3. yeoman_generate - 运行 Yeoman 生成器

   • 参数：
     • generatorName（字符串）：生成器名称（不含 generator- 前缀）
     • cwd（字符串）：生成器运行所在的工作目录
     • appName（字符串）：要创建的应用名称
     • version（字符串）：要创建的应用版本
     • options（对象，可选）：传递给生成器的选项
     • args（数组，可选）：传递给生成器的其他位置参数

安装

通过 Smithery 安装

若要通过 Smithery 为 Claude Desktop 自动安装 mcp-yeoman：

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

前置要求

• Node.js（v16 或更高版本）
• npm 或 yarn

安装软件包

# 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

在 Claude Desktop 中使用

将以下内容添加到你的 claude_desktop_config.json：

使用 npx

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

直接使用 Node.js

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

将 /path/to/mcp-yeoman 替换为仓库的实际路径。

命令行参数

此服务支持以下命令行参数：

• --generator-dir <path>：指定用于安装 Yeoman 生成器的持久目录。默认情况下，生成器会安装在临时目录中，操作完成后该目录将被删除。使用持久目录可提升使用同一生成器重复执行操作时的性能。

示例：

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

示例

搜索模板

// Search for React-related templates
const templates = await callTool("yeoman_search_templates", {
  query: "react,typescript",
  pageSize: 10
});

获取生成器选项

// Get options for the React generator
const options = await callTool("yeoman_get_generator_options", {
  generatorName: "react"
});

运行生成器

// Run the React generator
const result = await callTool("yeoman_generate", {
  generatorName: "react",
  cwd: "/path/to/project",
  appName: "my-react-app",
  version: "1.0.0",
  options: {
    typescript: true,
    sass: true
  }
});

开发

# Install dependencies
npm install

# Start the server in development mode
npm start

# Build the server
npm run build

错误处理

此服务包含全面的错误处理：

• 对无效参数进行验证并报告错误
• 检测交互式提示词，并为必需选项提供指导
• 记录详细错误日志以便调试
• 自动清理临时目录（使用 --generator-dir 时除外）
• 通过 MCP 协议安全地传递错误

许可证

此 MCP 服务采用 MIT 许可证。这意味着你可以自由使用、修改和分发本软件，但须遵守 MIT 许可证的条款和条件。有关详情，请参阅项目仓库中的 LICENSE 文件。

贡献

欢迎贡献！欢迎提交 Pull Request。贡献时，请：

1. Fork 此仓库
2. 创建功能分支
3. 提交清晰说明变更内容的 pull request
4. 确保所有测试通过，并保持代码风格一致