AI Code Toolkit

AI代码工具包

此回购提供：

• 通过模板构建项目和功能脚手架
• 编辑前的文件级设计指南
• 编辑后基于规则的审查
• 前端工作的设计系统发现

为什么存在

随着项目规模的扩大，文档中的约定如下 CLAUDE.md, AGENTS.md，风格指南变得难以保持简洁，AI代理也难以始终如一地应用。该工具包将这些约定转换为可重用的模板配置(scaffold.yaml, architect.yaml, RULES.yaml)因此，代理只能在需要时发现相关的指导。

快速开始

要求：

• Node.js>=18
• MCP兼容代理，如Claude Code、Cursor或Gemini CLI

1.初始化工作区

# Existing project
npx @agiflowai/aicode-toolkit init

# New project
npx @agiflowai/aicode-toolkit init --name my-app --project-type monolith

这创造了 templates/ 和 .toolkit/settings.yaml.项目参考模板通过 sourceTemplate 在 project.json 或 .toolkit/settings.yaml.

2.配置MCP

init 可以自动配置MCP。对于手动设置，请将所需的服务器添加到代理配置中。

克劳德代码示例：

{
  "mcpServers": {
    "scaffold-mcp": {
      "command": "npx",
      "args": ["-y", "@agiflowai/scaffold-mcp", "mcp-serve", "--admin-enable"]
    },
    "architect-mcp": {
      "command": "npx",
      "args": [
        "-y", "@agiflowai/architect-mcp", "mcp-serve",
        "--admin-enable",
        "--design-pattern-tool", "codex",
        "--review-tool", "gemini-cli"
      ]
    },
    "style-system": {
      "command": "npx",
      "args": ["-y", "@agiflowai/style-system", "mcp-serve"]
    }
  }
}

有用的标志：

• --admin-enable：启用管理员/模板创作工具
• --design-pattern-tool ：使用LLM过滤设计模式
• --review-tool ：使用LLM进行审查输出

3.验证

问代理人：

What boilerplates are available?

它应该呼叫 list-boilerplates。如果没有，请重新启动代理。

回购布局

AI agent
  ├─ scaffold-mcp
  ├─ architect-mcp
  ├─ style-system
  └─ one-mcp
        ↓
     templates/
       ├─ scaffold.yaml
       ├─ architect.yaml
       └─ RULES.yaml

脚手架mcp

从模板生成项目和功能样板。

核心工具：

• list-boilerplates
• use-boilerplate
• list-scaffolding-methods
• use-scaffold-method

管理工具：

• generate-boilerplate
• generate-feature-scaffold
• generate-boilerplate-file

建筑师mcp

在编辑之前提供特定于文件的模式，并根据 RULES.yaml.

核心工具：

• get-file-design-pattern
• review-code-change

管理工具：

• add-design-pattern
• add-rule

风格系统

提供主题、CSS类和组件发现工具。

核心工具：

• list_themes
• get_css_classes
• get_component_visual
• list_shared_components
• list_app_components

一个mcp

提供渐进式工具发现，以减少MCP提示开销。

典型工作流程

创建项目

User: "Create a Next.js app called dashboard"

Agent:
1. list-boilerplates
2. use-boilerplate
3. Project is generated

添加功能

User: "Add a products API route"

Agent:
1. list-scaffolding-methods
2. use-scaffold-method
3. Feature files are generated

安全地编辑文件

User: "Add a products page"

Agent:
1. get-file-design-pattern
2. edit the file using the returned patterns and rules
3. review-code-change
4. fix any violations

设置组件样式

User: "Style the button with our theme colors"

Agent:
1. get_css_classes
2. list_shared_components
3. update the component
4. get_component_visual

模板结构

templates/
└── nextjs-15/
    ├── scaffold.yaml
    ├── architect.yaml
    ├── RULES.yaml
    └── boilerplate/

scaffold.yaml

定义样板和特征支架。

boilerplates:
  - name: nextjs-15-app
    description: "Next.js 15 with App Router"
    targetFolder: apps
    includes:
      - boilerplate/**/*

features:
  - name: add-route
    description: "Add route with page and layout"
    variables_schema:
      name: { type: string, required: true }
    includes:
      - features/route/**/*

architect.yaml

定义编辑前应显示的文件级模式。

patterns:
  - name: server-component
    description: "Default for page components"
    file_patterns:
      - "**/app/**/page.tsx"
    description: |
      - Use async/await for data fetching
      - Keep components focused on rendering
      - Move business logic to server actions

RULES.yaml

定义审核规则。规则可以从全局继承 templates/RULES.yaml.

version: '1.0'
template: typescript-lib
rules:
  - pattern: src/services/**/*.ts
    description: Service Layer Implementation Standards
    must_do:
      - rule: Create class-based services with single responsibility
        codeExample: |-
          export class DataProcessorService {
            async processData(input: string): Promise
 {
              // Implementation
            }
          }
      - rule: Use dependency injection for composability
    must_not_do:
      - rule: Create static-only utility classes - use functions
        codeExample: |-
          // ❌ BAD
          export class Utils {
            static format(s: string) {}
          }

          // ✅ GOOD
          export function format(s: string): string {}

项目类型

单体仓库

每个项目都引用其模板 project.json.

my-workspace/
├── apps/
│   └── web-app/
│       └── project.json
├── packages/
│   └── shared-lib/
│       └── project.json
└── templates/

巨型独石

单片使用 .toolkit/settings.yaml.

version: "1.0"
projectType: monolith
sourceTemplate: nextjs-15

内置模板

包含的模板：

自定义模板

对于模板创作，请从现有的仓库或模板开始，并使用管理员提示：

/generate-boilerplate
/generate-feature-scaffold

对于设计/规则编写，请使用：

• add-design-pattern
• add-rule

支持的代理

包裹

贡献

看 贡献.md.

许可证

AGPL-3.0

______________________________________________________________________