AUTO-MAS-Project/AUTO-MAS / .agents/skills/mas-plan-schedule
mas-plan-schedule
VerifiedUse when adding, refactoring, or reviewing AUTO-MAS plan schedule types, including backend PlanConfig registration, plan API/schema contracts, plan combobox consumers, frontend plan type registry, and per-plan table integration.
MAS Plan Schedule
Objective
Keep AUTO-MAS plan schedules easy to extend without turning them into a generic field engine. Each schedule type owns its data model, config class, table UI, and user consumption path. Shared code should only cover type registration, API dispatch, list selection, and CRUD orchestration.
Current Architecture
Backend has one shared multi-config collection and one lightweight registration table.
app/models/schema.pyDefines API-facing schedule schemas and shared aliases:WeeklyPlanConfig,PlanConfigType,PlanCreateType,PlanConfigData,PlanComboxConsumer.app/models/config.pyDefines concreteConfigBaseschedule classes such asMaaPlanConfigandMaaEndPlanConfig. Registers them inPLAN_BOOK.app/core/config.pyUsesPLAN_BOOKto create plans, delete referenced plans, filter combobox options by consumer, and wireGlobalConfig.PlanConfig.app/api/plan.pyUses schema models plusPLAN_BOOKfor plan CRUD serialization.app/api/info.pyExposes consumer-specific plan combobox routes throughPlanComboxIn.consumer.
Frontend has one runtime descriptor registry and separate table implementations.
frontend/src/utils/planTypeRegistry.tsOwns runtime plan descriptors: config type, create type, label, default name, selector tag, reload behavior, and table component.frontend/src/views/plan/index.vueOrchestrates plan list state, current plan selection, CRUD calls, name editing, and table dispatch.frontend/src/views/plan/tables/*.vueOwns concrete table UI and per-type field behavior.frontend/src/composables/usePlanApi.tsWraps plan API calls. Do not duplicate generated OpenAPI models here.frontend/src/utils/planNameUtils.tsReads the registry for labels/default names.
Where Things Belong
Use types/ for type-only shapes that are not already exported by OpenAPI.
Use utils/ or a feature folder for runtime registries, constants, validators, and label maps.
planTypeRegistry.ts is runtime code because it imports Vue defineAsyncComponent and generated API enum values. Do not move it into types/ unless it is split into a type-only file and a runtime registry file.
Do not put plan schedule types in frontend/src/types/script.ts. Script types and schedule types are separate domains.
Adding A New Schedule Type
Follow this order.
- Add backend config class
Create a concrete
ConfigBaseplan class inapp/models/config.py. AddConfigItemfields beforesuper().__init__(). ReuseWeeklyPlanConfigonly if the new type has the sameInfo + ALL + weekdaysshape. - Add backend schema
Create the matching Pydantic schema item/info classes in
app/models/schema.py. Extend all four aliases:PlanConfigType,PlanCreateType,PlanConfigData, andPlanComboxConsumer. Keepmodel_config = ConfigDict(extra="forbid")on schedule config models. - Add the consumer constant
Append the new consumer string to
PLAN_CONSUMER_VALUESinapp/utils/constants.py.PLAN_BOOKdoes not hold consumer literals directly; it indexes this tuple (PLAN_CONSUMER_VALUES[0],[1], ...), so a new type has nothing to reference until the tuple grows. This tuple and thePlanComboxConsumerliteral inapp/models/schema.pyare two independent hardcoded lists of the same values with no generated link. Update both, and keep them in the same order — existingPLAN_BOOKentries reference the tuple positionally, so inserting rather than appending silently repoints existing plan types at the wrong consumer. - Register in
PLAN_BOOKAddcreate_type,config_class,schema_class,consumer,script_class, andfield_name. This is the backend source of truth for plan CRUD, deletion reference cleanup, and combobox filtering. - Wire the user consumer
Add or extend the user config field that stores the selected plan ID.
Use type-specific validation or runtime type checks before dereferencing the plan as a concrete class.
When deleting a plan,
field_nameshould be reset only for the bound consumer type. - Add frontend descriptor
Register the type in
frontend/src/utils/planTypeRegistry.ts. Use generated OpenAPI enum values from@/api. PointtableComponentto the type-specific table component. - Add frontend table
Create a dedicated table component under
frontend/src/views/plan/tables/. Keep per-type field logic in the table or a type-specific utility/composable. Do not build a generic field renderer unless multiple real schedule types share the same behavior. - Regenerate OpenAPI client
Never edit generated files under
frontend/src/api/by hand. Ask the developer to run the project API generation command after backend schema changes. Frontend plan types derive from generated OpenAPI (PlanIndexItem.type,PlanCreateIn.type), so the registry cannot see a new type until regeneration runs.
Review Checklist
Use this checklist for plan schedule PRs.
PLAN_BOOKis the only backend registration source for supported plan config classes.PlanConfigType,PlanCreateType,PlanConfigData, andPlanComboxConsumermatch registered backend types.PLAN_CONSUMER_VALUESinapp/utils/constants.pyand thePlanComboxConsumerliteral agree in both content and order, and existingPLAN_BOOKpositional indexes still point at their original consumers.- Plan CRUD does not default unknown types to
MaaPlan. - Consumer comboboxes only return plans of the matching config class.
- Deleting a plan only clears the matching user reference field.
- Frontend type labels, default names, create types, and table components come from
planTypeRegistry.ts. - Unknown plan types fail clearly instead of rendering as a different known type.
- Type-specific table behavior stays in the type-specific table or nearby type-specific utility.
- No plan schedule types are redefined in
script.tsor generated OpenAPI files. - New fallback paths are justified by production compatibility needs, not by non-production leftovers.
Avoid
- Do not add
GeneralPlan,CustomPlan, or placeholder mappings without a complete backend, frontend, and user consumption path. - Do not add a shared schedule field engine for one or two unrelated tables.
- Do not create a new wrapper/helper that is only called once if the current flow stays clearer inline.
- Do not preserve deleted compatibility routes unless the feature has shipped and needs migration support.
- Do not duplicate generated API types in hand-written frontend files.
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| brainstormingobra/superpowersYou MUST use this before any creative work - creating features, building components, adding functionality, modifying behavior, or planning anything new, in software or out of it (a talk, a business, a renovation). | Stars: 321k | Updated | Claude CodeCodex | Verified | Install |
| brand-guidelinesanthropics/skillsApplies Anthropic's official brand colors and typography to any sort of artifact that may benefit from having Anthropic's look-and-feel. Use it when brand colors or style guidelines, visual formatting, or company design standards apply. | Stars: 197k | Updated | Claude CodeCodex | Verified | Install |
| frontend-designanthropics/skillsGuidance for distinctive, intentional visual design when building new UI or reshaping an existing one. Helps with aesthetic direction, typography, and making choices that don't read as templated defaults. | Stars: 197k | Updated | Claude CodeCodex | Verified | Install |
| mcp-builderanthropics/skillsGuide for creating high-quality MCP (Model Context Protocol) servers that enable LLMs to interact with external services through well-designed tools. Use when building MCP servers to integrate external APIs or services, whether in Python (FastMCP) or Node/TypeScript (MCP SDK). | Stars: 197k | Updated | Claude CodeCodex | Verified | Install |