massgen-config-creator

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Config Creator

配置创建器

This skill provides guidance for creating new YAML configuration files that follow MassGen conventions and best practices.
本技能提供创建符合MassGen规范和最佳实践的全新YAML配置文件的指导。

Purpose

用途

The config-creator skill helps you create well-structured, validated configuration files for MassGen agents. It ensures consistency across the codebase and helps avoid common mistakes.
config-creator技能可帮助你为MassGen Agent创建结构合理、经过验证的配置文件,确保整个代码库的一致性,避免常见错误。

When to Use This Skill

何时使用该技能

Use the config-creator skill when you need to:
  • Create example configs demonstrating new features
  • Write configs for case studies or releases
  • Build reusable multi-agent workflow configs
  • Test new backend or tool integrations
  • Share configuration patterns with users
当你需要执行以下操作时可使用config-creator技能:
  • 创建用于演示新功能的示例配置
  • 编写案例研究或版本发布用的配置
  • 构建可复用的多Agent工作流配置
  • 测试新的后端或工具集成
  • 向用户分享配置模式

Authoritative Documentation

权威文档

IMPORTANT: The primary source of truth for config creation is:
📖
docs/source/development/writing_configs.rst
This file contains:
  • Complete config creation workflow
  • All current conventions and rules
  • Property placement reference
  • Validation checklist
  • Common patterns and examples
  • Up-to-date templates
Always consult this document for the latest configuration standards.
重要提示: 配置创建的唯一可信来源是:
📖
docs/source/development/writing_configs.rst
该文件包含:
  • 完整的配置创建工作流
  • 所有当前生效的规范和规则
  • 属性位置参考
  • 校验检查清单
  • 通用模式和示例
  • 最新模板
请始终查阅该文档获取最新的配置标准。

Critical Rules (Quick Reference)

核心规则(快速参考)

1. Never Invent Properties

1. 切勿自行定义属性

ALWAYS read 2-3 existing configs first to understand current conventions:
bash
undefined
请务必先阅读2-3份现有配置,了解当前规范:
bash
undefined

Find similar configs

查找类似配置

ls massgen/configs/tools/{category}/
ls massgen/configs/tools/{category}/

Read examples

阅读示例

cat massgen/configs/basic/multi/two_agents_gemini.yaml cat massgen/configs/tools/mcp/filesystem_claude.yaml
undefined
cat massgen/configs/basic/multi/two_agents_gemini.yaml cat massgen/configs/tools/mcp/filesystem_claude.yaml
undefined

2. Property Placement Matters

2. 属性放置位置至关重要

  • cwd
    BACKEND-level (individual agent workspace)
  • context_paths
    ORCHESTRATOR-level (shared read-only files)
  • enable_web_search
    BACKEND-level
  • enable_planning_mode
    ORCHESTRATOR.COORDINATION-level
See
docs/source/development/writing_configs.rst
for complete property reference.
  • cwd
    BACKEND级别(单个Agent的工作区)
  • context_paths
    编排器级别(共享只读文件)
  • enable_web_search
    BACKEND级别
  • enable_planning_mode
    ORCHESTRATOR.COORDINATION级别
完整属性参考请查看
docs/source/development/writing_configs.rst

3. Key Conventions

3. 关键规范

DO:
  • Prefer cost-effective models (gpt-5-nano, gpt-5-mini, gemini-2.5-flash)
  • Give all agents identical
    system_message
  • Use separate workspaces per agent
  • Include "What happens" comments explaining execution flow
DON'T:
  • Reference massgen v1 or legacy paths
  • Invent new properties
  • Suggest cleanup commands that delete logs
推荐做法:
  • 优先选择高性价比模型(gpt-5-nano、gpt-5-mini、gemini-2.5-flash)
  • 为所有Agent设置相同的
    system_message
  • 每个Agent使用独立工作区
  • 加入「执行逻辑说明」注释解释执行流程
禁止做法:
  • 引用MassGen v1或旧版路径
  • 自行定义新属性
  • 提供会删除日志的清理命令建议

Quick Start Workflow

快速开始工作流

Step 1: Research Existing Configs

步骤1:调研现有配置

bash
undefined
bash
undefined

Find configs in your category

查找对应分类下的配置

ls massgen/configs/tools/{relevant_category}/
ls massgen/configs/tools/{relevant_category}/

Read 2-3 similar examples

阅读2-3份相似示例

cat massgen/configs/basic/multi/two_agents_gemini.yaml
undefined
cat massgen/configs/basic/multi/two_agents_gemini.yaml
undefined

Step 2: Copy and Adapt

步骤2:复制并适配

  • Copy a similar config as your starting point
  • Adapt values, never invent properties
  • Follow the structure from existing configs
  • 复制一份相似配置作为起点
  • 仅调整参数值,切勿自行定义属性
  • 遵循现有配置的结构

Step 3: Test

步骤3:测试

bash
massgen --config massgen/configs/tools/{category}/{your_config}.yaml "Test prompt"
bash
massgen --config massgen/configs/tools/{category}/{your_config}.yaml "Test prompt"

Step 4: Validate

步骤4:校验

Refer to the validation checklist in
docs/source/development/writing_configs.rst
参考
docs/source/development/writing_configs.rst
中的校验检查清单完成校验。

File Naming and Location

文件命名与存放位置

Naming Pattern:
{agent_description}_{feature}.yaml
Location Categories:
  • massgen/configs/basic/
    - Simple examples
  • massgen/configs/tools/filesystem/
    - Filesystem operations
  • massgen/configs/tools/web-search/
    - Web search
  • massgen/configs/tools/code-execution/
    - Code execution
  • massgen/configs/tools/multimodal/
    - Image, vision, audio
  • massgen/configs/tools/mcp/
    - MCP integrations
  • massgen/configs/tools/planning/
    - Planning mode
命名规则:
{agent_description}_{feature}.yaml
存放分类:
  • massgen/configs/basic/
    - 简单示例
  • massgen/configs/tools/filesystem/
    - 文件系统操作
  • massgen/configs/tools/web-search/
    - 网页搜索
  • massgen/configs/tools/code-execution/
    - 代码执行
  • massgen/configs/tools/multimodal/
    - 图像、视觉、音频
  • massgen/configs/tools/mcp/
    - MCP集成
  • massgen/configs/tools/planning/
    - 规划模式

Common Patterns (Quick Reference)

通用模式(快速参考)

Single Agent

单Agent

yaml
agent:  # Singular
  id: "my_agent"
  backend:
    type: "claude"
    model: "claude-sonnet-4"
yaml
agent:  # 单数形式
  id: "my_agent"
  backend:
    type: "claude"
    model: "claude-sonnet-4"

Multi-Agent

多Agent

yaml
agents:  # Plural
  - id: "agent_a"
    backend:
      type: "openai"
      model: "gpt-5-mini"
    system_message: "Shared task description"

  - id: "agent_b"
    backend:
      type: "gemini"
      model: "gemini-2.5-flash"
    system_message: "Shared task description"
yaml
agents:  # 复数形式
  - id: "agent_a"
    backend:
      type: "openai"
      model: "gpt-5-mini"
    system_message: "Shared task description"

  - id: "agent_b"
    backend:
      type: "gemini"
      model: "gemini-2.5-flash"
    system_message: "Shared task description"

With Filesystem Access

带文件系统访问权限

yaml
agents:
  - backend:
      cwd: "workspace1"  # Backend-level

orchestrator:
  context_paths:  # Orchestrator-level
    - path: "massgen/configs/resources/v0.0.29-example/source"
      permission: "read"
yaml
agents:
  - backend:
      cwd: "workspace1"  # Backend级别

orchestrator:
  context_paths:  # 编排器级别
    - path: "massgen/configs/resources/v0.0.29-example/source"
      permission: "read"

Reference Files

参考文件

Primary Documentation:
  • Config writing guide:
    docs/source/development/writing_configs.rst
    ⭐ START HERE
  • YAML schema reference:
    docs/source/reference/yaml_schema.rst
  • Example configs:
    massgen/configs/
Supporting Documentation:
  • Supported models:
    docs/source/reference/supported_models.rst
  • Backend configuration:
    docs/source/user_guide/backends.rst
  • MCP integration:
    docs/source/user_guide/mcp_integration.rst
核心文档:
  • 配置编写指南:
    docs/source/development/writing_configs.rst
    ⭐ 首选入口
  • YAML schema参考:
    docs/source/reference/yaml_schema.rst
  • 示例配置:
    massgen/configs/
辅助文档:
  • 支持的模型:
    docs/source/reference/supported_models.rst
  • 后端配置:
    docs/source/user_guide/backends.rst
  • MCP集成:
    docs/source/user_guide/mcp_integration.rst

Tips for Agents

给Agent的提示

When creating configs programmatically:
  1. Always read the authoritative docs first:
    docs/source/development/writing_configs.rst
  2. Read existing configs to understand current patterns
  3. Copy structure from similar configs, don't invent
  4. Test immediately after creating
  5. When in doubt, consult the full guide in
    docs/source/development/writing_configs.rst
This skill is a quick reference guide. For comprehensive, up-to-date information, always refer to the official documentation files listed above.
以编程方式创建配置时:
  1. 请务必先阅读权威文档:
    docs/source/development/writing_configs.rst
  2. 阅读现有配置了解当前模式
  3. 复制相似配置的结构,不要自行创造
  4. 创建完成后立即测试
  5. 存在疑问时,查阅
    docs/source/development/writing_configs.rst
    中的完整指南
本技能是快速参考指南,如需获取全面、最新的信息,请始终查阅上文列出的官方文档文件。