MCP Yeoman 服务器

一个模型上下文协议 (MCP) 服务器，提供与 Yeoman 生成器的集成，允许 AI 代理以编程方式搜索和运行 Yeoman 模板。

<img width="832" alt="Cursor_CIuNzjl6ca" src="https://github.com/user-attachments/assets/d062eb45-320e-4f4a-8bfa-121bb522b8b7" />

工具

此服务器实现了以下 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

安装包

# 克隆仓库
git clone https://github.com/thirdstrandstudio/mcp-yeoman.git
cd mcp-yeoman

# 安装依赖
npm install

# 构建包
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"]
    }
  }
}

示例

搜索模板

// 搜索与 React 相关的模板
const templates = await callTool("yeoman_search_templates", {
  query: "react,typescript",
  pageSize: 10
});

获取生成器选项

// 获取 React 生成器的选项
const options = await callTool("yeoman_get_generator_options", {
  generatorName: "react"
});

运行生成器

// 运行 React 生成器
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
  }
});

开发

# 安装依赖
npm install

# 在开发模式下启动服务器
npm start

# 构建服务器
npm run build

错误处理

服务器包括全面的错误处理：

• 无效参数的验证错误
• 交互式提示检测和所需选项的指导
• 用于调试的详细错误日志记录
• 自动清理临时目录（除非使用 --generator-dir）
• 通过 MCP 协议安全地传播错误

许可证

此 MCP 服务器在 MIT 许可证下获得许可。 这意味着您可以自由使用、修改和分发该软件，但须遵守 MIT 许可证的条款和条件。 有关更多详细信息，请参阅项目存储库中的 LICENSE 文件。

贡献

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

1. Fork 仓库
2. 创建一个功能分支
3. 提交一个 Pull Request，其中包含对更改的清晰描述
4. 确保所有测试通过并且代码风格得到维护