vibe-codepaladin
v1.1.0
Published
VibeGen CodePaladin - Deterministic code generation service driven by manifests
Maintainers
Readme
CodePaladin (代码侠)
VibeGen 双核架构 - MCP-2 代码英雄
CodePaladin是 VibeGen 系统中的"代码侠",作为可靠的代码执行引擎,它严格遵循由需求精灵 (SpecSprite)生成的项目蓝图 (prd.json),自动化地装配出高质量、可维护的Web应用。重要提示: 此服务是 VibeGen 双核架构的第二环,专注于代码生成,不参与需求对话。它需要与
SpecSprite协同工作。
CodePaladin 是一款基于模板和模块的智能代码生成器。它接收一个结构化的 prd.json 文件,并根据其中的定义,精确地构建出完整的项目代码。
特性
- 🎯 确定性构建 - 相同的 PRD 输入总是产生相同的项目输出
- 📋 严格验证 - 基于 JSON Schema 的 PRD 格式验证
- 🧩 模块化设计 - 基于功能模块的智能组合
- 🎨 多技术栈 - 支持 Next.js、Astro、Vue 等多种框架
- 🔧 模板驱动 - 复用 vibecli 的高质量模板系统
- 🚀 零配置 - 开箱即用的项目生成
- 📋 系统提示词 - 遵循清单驱动构建的行为准则
架构
CodePaladin 作为 MCP (Model Context Protocol) 服务运行,与 Cursor IDE 深度集成:
Cursor IDE → CodePaladin MCP → 项目代码
↓
PRD 验证 → 模板选择 → 代码生成支持的技术栈
前端框架
- Next.js
- Astro
- Vue
- React
- Svelte
UI 框架
- Tailwind + Radix
- Tailwind + Shadcn
- Chakra UI
- Material-UI
- Ant Design
数据库
- PostgreSQL
- MySQL
- SQLite
- Supabase
- MongoDB
认证方案
- Supabase
- NextAuth
- Firebase
- Clerk
- Auth0
快速开始
1. 安装依赖
npm install2. 构建项目
npm run build3. 启动服务
npm start在 Cursor 中配置
以下示例展示了如何在 Cursor IDE 与 Claude Desktop 中接入 CodePaladin 的 MCP 服务。
1. 配置 MCP 客户端
CodePaladin 以独立的 NPM 包 codepaladin-mcp 形式发布,启动时无需直接引用构建产物路径,只需通过 npx 拉起即可。
Cursor 配置
在 ~/.cursor/settings.json 中添加如下内容:
{
"mcpServers": {
"codepaladin": {
"command": "npx",
"args": ["-y", "codepaladin-mcp@latest"],
"env": {
"CODEPALADIN_CONFIG_PATH": "~/.codepaladin/config.json",
"NODE_ENV": "production"
}
}
}
}
-y参数用于在首次运行时自动确认 npx 下载提示,可按需移除。
Claude Desktop 配置
在 Claude Desktop 的配置文件中加入:
{
"mcpServers": {
"codepaladin": {
"command": "npx",
"args": ["codepaladin-mcp@latest"],
"env": {
"CODEPALADIN_CONFIG_PATH": "~/.codepaladin/config.json",
"NODE_ENV": "production"
}
}
}
}保存后,即可在对应客户端通过 @codepaladin 前缀调用 CodePaladin 提供的所有 MCP 工具。
Claude Code (CLI) 配置
使用 Claude Code 时,可通过以下命令添加 CodePaladin MCP 服务器(以 user 作用域为例,可按需改为 project 或 local):
claude mcp add codepaladin -s user -- npx -y codepaladin-mcp@latest如果需要自定义环境变量或配置路径,可以使用 -e 选项,例如:
claude mcp add codepaladin -s user -e CODEPALADIN_CONFIG_PATH=~/.codepaladin/config.json -- npx -y codepaladin-mcp@latest详细的 MCP 配置方法请参考官方文档 https://docs.anthropic.com/en/docs/claude-code/mcp。
保存后,即可在对应客户端通过 @codepaladin 前缀调用 CodePaladin 提供的所有 MCP 工具。
MCP 工具列表
build_project
构建完整的项目代码
validate_prd
验证 PRD 格式和内容
get_supported_tech_stack
获取支持的技术栈选项
get_available_features
获取可用功能模块
generate_sample_prd
生成示例 PRD
get_service_info
获取服务信息
health_check
执行健康检查
get_system_prompts
获取系统提示词信息和加载状态
PRD 格式示例
{
"project": {
"name": "my-awesome-app",
"displayName": "My Awesome App",
"description": "基于 VibeGen 生成的现代化 Web 应用",
"version": "1.0.0"
},
"techStack": {
"framework": "next.js",
"uiFramework": "tailwind-radix",
"database": "postgresql",
"auth": "supabase",
"deployment": "vercel"
},
"features": {
"auth": true,
"admin": false,
"upload": true,
"email": true,
"payment": false,
"realtime": false,
"analytics": true,
"i18n": false,
"pwa": false,
"seo": true
},
"pages": [
{
"route": "/",
"name": "HomePage",
"title": "首页",
"components": ["Hero", "Features", "CTA"],
"public": true
}
],
"environment": {
"variables": {
"NEXT_PUBLIC_APP_URL": "http://localhost:3000"
},
"secrets": ["DATABASE_URL", "SUPABASE_URL"]
},
"createdAt": "2024-01-01T00:00:00Z",
"version": "1.0.0"
}开发
项目结构
CodePaladin/
├── src/
│ ├── core/ # 核心逻辑
│ │ ├── types.ts # 类型定义
│ │ ├── prd-validator.ts # PRD 验证器
│ │ ├── project-generator.ts # 项目生成器
│ │ ├── system-prompt-loader.ts # 系统提示词加载器
│ │ └── codepaladin-service.ts # 核心服务
│ ├── prompts/ # 系统提示词
│ │ └── system/ # 系统级提示词
│ ├── schemas/ # JSON Schema
│ ├── templates/ # 代码模板
│ ├── server.ts # MCP 服务器
│ └── index.ts # 入口文件
├── dist/ # 构建输出
└── package.json脚本命令
npm run dev # 开发模式
npm run build # 构建项目
npm run start # 启动服务
npm run test # 运行测试
npm run lint # 代码检查贡献
欢迎贡献代码!请确保:
- 遵循现有的代码风格
- 添加必要的测试
- 更新相关文档
许可证
MIT License
CodePaladin - 让代码生成像侠客出剑一样精准 ⚔️✨

