Agent skill

OpenMAIC Setup and Extension

by THU-MAIC in THU-MAIC/OpenMAIC

Guides setup, classroom generation and secondary development for OpenMAIC, the multi-agent interactive classroom, one confirmed phase at a time.

MITAuto-check: notesEducation

Install OpenMAIC Setup and Extension

skills CLI
$ npx skills add THU-MAIC/OpenMAIC --skill openmaic -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install THU-MAIC/OpenMAIC openmaic --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/THU-MAIC/OpenMAIC.git skills-src && mkdir -p .claude/skills && cp -r skills-src/skills/openmaic .claude/skills/openmaic && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
openmaic
GitHub stars
40k
Token cost
~1.7k tokens
SKILL.md length
875 words
Files
9 (incl. references)
Skills in repo
25
Repo updated
First seen
Licence
MIT

At a glance

Guides setup, classroom generation and secondary development for OpenMAIC, the multi-agent interactive classroom, one confirmed phase at a time.

  • Works in 6 steps: Choose Mode → Clone Or Reuse Existing Repo → Choose Startup Mode → …
  • Trying OpenMAIC through the Live Demo
  • SKILL.md covers Core Rules, Optional Skill Config, SOP Phases and Response Style
  • Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md

What it does

Setup runs as a confirmation-heavy procedure: one phase at a time, a confirmation before any action that changes state, and a look at existing local state with a question about keeping it. The agent does not assume its own model or API key will be reused, because OpenMAIC generates classrooms from its own server-side model configuration, in openmaic.yml and the web app's settings, with no request-time overrides.

It avoids asking you to paste API keys into chat, prefers to guide you to edit local config files yourself and does not offer to write keys for you. Once setup is complete and you clearly ask for a classroom, it submits the generation job without a second confirmation, though reading a local PDF before upload still gets one.

Phase 0 chooses a mode. A stored access code in the skill config sends returning users to the Live Demo, unless they want to extend or build on OpenMAIC and its SDK packages, which goes to the extend branch. Reference notes cover cloning, the extension cookbook and SDK, the generate flow, the live demo, provider keys and startup modes.

When your agent uses it

  • Trying OpenMAIC through the Live Demo
  • Setting up OpenMAIC locally and choosing a startup mode
  • Generating a multi-agent interactive classroom from a topic or PDF
  • Extending OpenMAIC with custom providers, storage, themes or routes

Example prompts

  • “Help me set up OpenMAIC locally and walk me through the provider keys.”
  • “Generate an interactive classroom on photosynthesis from the PDF in ./lessons/plants.pdf.”
  • “I want to fork OpenMAIC and add my own storage provider.”

Requirements

  • An OpenMAIC access code for the Live Demo, or a local OpenMAIC installation
  • Model provider keys in the server-side config

Workflow steps

6 steps, taken from the step headings in SKILL.md.

  1. Choose Mode
  2. Clone Or Reuse Existing Repo
  3. Choose Startup Mode
  4. Configure Provider Keys
  5. Start And Verify OpenMAIC
  6. Generate A Classroom

What it can do on your machine

Read from SKILL.md and the folder at commit 6a84dbe. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    No scripts in the folder and no shell commands in SKILL.md (its code samples are jsonc).

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

OpenMAIC Setup and Extension loads about 1.7k tokens when it runs, and up to ~15k if it reads all its reference files. Until then it costs about 111 tokens; SKILL.md has 875 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~111
When it runs · the whole SKILL.md, loaded when a task matches
~1.7k
With references · SKILL.md plus every file in references/, read only if the agent opens them
~15k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check: notes

The automated check noted patterns worth knowing about, such as sudo or a known installer.

  • NoteMentions a .env fileSKILL.md:84
    to edit themselves (`openmaic.yml` and `.env.local`, or the model settings in the web app). If generation later fails d

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from THU-MAIC/OpenMAIC at commit 6a84dbe, republished under its MIT licence (© THU-MAIC). 875 words, ~1,666 tokens.

Download SKILL.mdSave it as .claude/skills/openmaic/SKILL.md (or your agent's skills folder). This skill also uses 8 other files; get the full folder from GitHub.
name
openmaic
description
OpenMAIC assistant for setting up, generating, and extending OpenMAIC. Use when the user wants to use OpenMAIC, generate a multi-agent interactive classroom, or build on / extend / customize OpenMAIC and its @openmaic/* SDK (secondary development, 二开) — covers Live Demo or local setup, startup modes, provider keys, classroom generation, and secondary development (forking, providers/storage/themes, routes, or the renderer/editor).
user-invocable
true

OpenMAIC Skill

Use this as a guided, confirmation-heavy SOP. Do not compress the whole setup into one reply and do not perform state-changing actions without explicit user confirmation.

Core Rules

  • Move one phase at a time.
  • Before any state-changing action, ask for confirmation.
  • If local state already exists, show what you found and ask whether to keep it.
  • Do not assume the OpenClaw agent's own model or API key will be reused by OpenMAIC.
  • OpenMAIC classroom generation uses OpenMAIC's server-side model configuration (openmaic.yml and the model settings in the web app).
  • This skill must not rely on any request-time model or provider overrides.
  • Only that server-side configuration may control provider selection and defaults.
  • Do not default to asking the user to paste API keys into chat.
  • Prefer guiding the user to edit local config files themselves.
  • Do not offer to write API keys into config files on the user's behalf.
  • Once setup is complete and the user clearly asks to generate a classroom, do not ask for a second confirmation before submitting the generation job.
  • Keep confirmations for local file reads such as reading a PDF from disk before uploading it.

Optional Skill Config

If present, read defaults from ~/.openclaw/openclaw.json under:

jsonc
{
  "skills": {
    "entries": {
      "openmaic": {
        "enabled": true,
        "config": {
          "accessCode": "sk-xxx",
          "repoDir": "/path/to/OpenMAIC",
          "url": "http://localhost:3000"
        }
      }
    }
  }
}
  • If accessCode is present, default to Live Demo mode and skip the mode-selection prompt — unless the user's intent is to extend/build on OpenMAIC (see the exception in Phase 0).
  • Use repoDir and url only as defaults for local mode.
  • Still confirm before acting.

SOP Phases

0. Choose Mode

First check skill config for accessCode. If present, announce that a stored access code was found and proceed directly to Live Demo mode (load references/live-demo.md, skip phases 1–4). Do not ask the user to paste the code again. Exception: if the user's stated intent is to extend / build on / customize OpenMAIC or consume the @openmaic/* SDK (二次开发 / 二开 / SDK), do not auto-shortcut — go to the extend branch below regardless of accessCode. A returning Live Demo user who now wants to do 二开 should be routed to extend, not silently sent back to Live Demo.

If no accessCode in config (or the extend exception above applies), ask the user how they want to use OpenMAIC:

  1. Use the OpenMAIC Live Demo (recommended for quick start) — The cloud edition: the version officially deployed and hosted by the OpenMAIC team at open.maic.chat. Requires an access code (starts with sk-). Get yours by signing in at https://open.maic.chat, clicking your account in the top-right corner, opening "访问码设置" (access code settings), and generating a code; then add it to ~/.openclaw/openclaw.json under skills.entries.openmaic.config.accessCode. No local setup needed.
  2. Run locally — Clone the repo, configure provider keys, and run on your machine.
  3. Extend or build on OpenMAIC (二次开发) — Fork the repo and customize the product, or consume the @openmaic/* SDK to build something new.

If the user chooses Live Demo mode, load references/live-demo.md and skip phases 1–4. If the user chooses local mode, proceed to phase 1 as usual. If the user chooses to extend/build on OpenMAIC, load references/extend.md and skip the setup/generation phases.

1. Clone Or Reuse Existing Repo

Load references/clone.md.

Use this when the user has not installed OpenMAIC yet or when you need to confirm which local checkout to use.

Show full SKILL.md (340 more words)Show less
2. Choose Startup Mode

Load references/startup-modes.md.

Use this after the repo location is confirmed. Present the available startup modes, recommend one, and wait for the user's choice.

3. Configure Provider Keys

Load references/provider-keys.md.

Use this before starting classroom generation. Recommend a provider path and tell the user exactly what to edit themselves (openmaic.yml and .env.local, or the model settings in the web app). If generation later fails due to provider/model/auth issues, return to this phase and direct the user to update the same configuration.

After the core LLM key is configured, ask the user if they want to enable optional features (web search, image generation, video generation, TTS). Each is a slot with its own provider — see the "Optional Features" section in provider-keys.md.

4. Start And Verify OpenMAIC

After the user has chosen a startup mode and configured keys, start OpenMAIC using the chosen method, then verify the service with GET {url}/api/health.

5. Generate A Classroom

Load references/generate-flow.md.

Use this only after the service is healthy. Confirm before reading local files to upload. If the user has already clearly asked to generate, do not ask for a second confirmation before submitting the generation job, and then follow the polling loop until it succeeds or fails (a failed job may be retried; see the generate flow). Only send the supported fields (requirement, materialIds) for generation requests; optional features follow the server's provider config. Uploads and the submission must resolve to the same owner: in anonymous-cookie mode reuse the same cookie jar on every request. For long-running jobs, prefer sparse polling and tell the user to check back later if the turn ends before completion.

Response Style

  • Keep each step short and explicit.
  • Prefer 2-3 concrete options when the user must choose.
  • Always include the recommended option first and explain why in one sentence.
  • After a step completes, say what changed and what the next confirmation is for.
  • When returning a classroom link, place the raw absolute URL on its own line with no bold, markdown link syntax, code formatting, or tables.

© THU-MAIC, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

SKILL.md and 8 other files (references) in skills/openmaic of THU-MAIC/OpenMAIC.

  • SKILL.md
  • references/clone.md
  • references/extend-cookbook.md
  • references/extend-sdk.md
  • references/extend.md
  • references/generate-flow.md
  • references/live-demo.md
  • references/provider-keys.md
  • references/startup-modes.md

Open the folder on GitHubat commit 6a84dbe

Compare with similar skills

OpenMAIC Setup and Extension next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

OpenMAIC Setup and Extension compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
OpenMAIC Setup and Extension this skillTHU-MAIC/OpenMAIC40k—~1.7kAutomated safety check: NotesMIT
Claude Code Self-Assessment Advisorlhfer/claude-howto-zh-cn2.3k—~1.7kAutomated safety check: PassMIT
Codebase to Coursezarazhangrui/codebase-to-course5.7k—~4.4kAutomated safety check: PassNone
AI Engineering Project Tutorrohitg00/ai-engineering-from-scratch66k—~1.6kAutomated safety check: PassMIT
Hung-Yi Lee Teaching Stylevoidful/hung-yi-lee-skill1.3k—~13kAutomated safety check: PassNone
AI Engineering Course Guiderohitg00/ai-engineering-from-scratch66k—~1.7kAutomated safety check: PassMIT

Similar skills

  • Claude Code Self-Assessment Advisor

    lhfer/claude-howto-zh-cn

    Quizzes you on Claude Code in a quick or deep mode, scores your level across 10 topics and recommends what to learn next, in Chinese.

    2.3k GitHub stars~1.7k tokensUpdated 2 mo ago
    EducationAuto-check passed
  • Codebase to Course

    zarazhangrui/codebase-to-course

    Turns a codebase into an interactive single-page HTML course for non-technical learners, with scroll modules, animated diagrams, quizzes and plain-English code translations.

    5.7k GitHub stars~4.4k tokensUpdated 6 mo ago
    EducationAuto-check passed
  • AI Engineering Project Tutor

    rohitg00/ai-engineering-from-scratch

    Tutors a learner through one stage of a hands-on AI engineering project per session: lesson, prediction, code, grader run and reflection, with hints but never full solutions.

    66k GitHub stars~1.6k tokensUpdated today
    EducationAuto-check passed
  • Hung-Yi Lee Teaching Style

    voidful/hung-yi-lee-skill

    Explains machine learning, LLMs, AI agents and speech modeling in a Hung-Yi Lee-inspired teaching style, drawing on a knowledge base built from his lectures and research references.

    1.3k GitHub stars~13k tokensUpdated 1 mo ago
    EducationAuto-check passed
  • AI Engineering Course Guide

    rohitg00/ai-engineering-from-scratch

    Routes a topic, question or bug to the exact lessons in the AI Engineering from Scratch curriculum and suggests the next command to run.

    66k GitHub stars~1.7k tokensUpdated today
    EducationAuto-check passed
  • Claude Academy Guide

    anthropics/skills

    Official

    Adds a matching Claude Academy course, tutorial or use case to the end of an answer about learning to use Claude, but only when the match is strong.

    180k GitHub starsUsed in 3 repos~1.9k tokens
    EducationAuto-check passed

More from THU-MAIC/OpenMAIC

All 25 skills in this repo
  • Designs a Chinese K-12 classroom for one OpenMAIC stage around the core-literacy model, using authentic tasks, performance assessment and observable evidence.

    40k GitHub stars~2.4k tokensUpdated today
    Auto-check passed
  • Maps the structure of an OpenMAIC stage document so an agent can find the right path, read it and patch quizzes, widgets, actions and project pages without guessing.

    40k GitHub stars~2.4k tokensUpdated today
    Auto-check passed
  • Designs a review-and-practice lesson around an independent first attempt, targeted feedback, supported practice, a fresh independent check and a next step.

    40k GitHub stars~1.1k tokensUpdated today
    Auto-check passed
  • Derives a reusable personal skill for course-making from a representative sample of the user's own past classrooms and chat history, confirmed with them before saving.

    40k GitHub stars~678 tokensUpdated today
    Auto-check passed
  • Curriculum Planner

    THU-MAIC/OpenMAIC

    Plans a multi-classroom series such as a seven-day course, clarifies the brief in rounds, gets sign-off on the full lesson list, then builds each stage in a shared folder.

    40k GitHub stars~2.8k tokensUpdated today
    Auto-check passed
  • Plans online courses so learners manipulate simulations, diagrams, code, games or 3D scenes on most pages, with slides only for the opening and the close.

    40k GitHub stars~681 tokensUpdated today
    Auto-check passed

Questions about OpenMAIC Setup and Extension

What does OpenMAIC Setup and Extension do?

Guides setup, classroom generation and secondary development for OpenMAIC, the multi-agent interactive classroom, one confirmed phase at a time. Setup runs as a confirmation-heavy procedure: one phase at a time, a confirmation before any action that changes state, and a look at existing local state with a question about keeping it.yml and the web app's settings, with no request-time overrides.

When should I use OpenMAIC Setup and Extension?

OpenMAIC Setup and Extension fits situations like: trying OpenMAIC through the Live Demo; setting up OpenMAIC locally and choosing a startup mode; generating a multi-agent interactive classroom from a topic or PDF; extending OpenMAIC with custom providers, storage, themes or routes.

How do I install OpenMAIC Setup and Extension in Claude Code?

Run `npx skills add THU-MAIC/OpenMAIC --skill openmaic -a claude-code`. Or copy the skill folder (skills/openmaic in THU-MAIC/OpenMAIC) into .claude/skills/openmaic in your project. Claude Code loads it when a task matches its description.

How do I install OpenMAIC Setup and Extension in Codex?

Run `npx skills add THU-MAIC/OpenMAIC --skill openmaic -a codex`. Or copy the skill folder (skills/openmaic in THU-MAIC/OpenMAIC) into .agents/skills/openmaic in your project. Codex loads it when a task matches its description.

Can I use OpenMAIC Setup and Extension in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add THU-MAIC/OpenMAIC --skill openmaic -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/openmaic, .gemini/skills/openmaic, .github/skills/openmaic and .opencode/skills/openmaic in your project.

What does OpenMAIC Setup and Extension need to run?

SKILL.md names no scripts, command-line tools or credentials: OpenMAIC Setup and Extension is instructions for the agent only. Our summary lists: An OpenMAIC access code for the Live Demo, or a local OpenMAIC installation; Model provider keys in the server-side config.

Does OpenMAIC Setup and Extension access the network?

SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.

Is OpenMAIC Setup and Extension safe to install?

Our automated static check of SKILL.md found notes only (mentions a .env file), nothing it rates as a warning. It is not a guarantee. Review the folder before installing.

What licence does OpenMAIC Setup and Extension use?

OpenMAIC Setup and Extension is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does OpenMAIC Setup and Extension use?

About 1.7k tokens (SKILL.md is roughly 6.7k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full. Its references folder adds about 13k tokens, read only when the agent opens those files.

What are the alternatives to OpenMAIC Setup and Extension?

Skills that share tags, products or a category with OpenMAIC Setup and Extension: Claude Code Self-Assessment Advisor (lhfer/claude-howto-zh-cn, 2.3k stars), Codebase to Course (zarazhangrui/codebase-to-course, 5.7k stars), AI Engineering Project Tutor (rohitg00/ai-engineering-from-scratch, 66k stars) and Hung-Yi Lee Teaching Style (voidful/hung-yi-lee-skill, 1.3k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains OpenMAIC Setup and Extension?

THU-MAIC (a GitHub organization) maintains it in THU-MAIC/OpenMAIC, which has 40,213 GitHub stars. The repository holds 25 skills in this directory. The repository was last updated on October 9, 2026.

Source: THU-MAIC/OpenMAIC on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.