mcpField
O
openmaic

openmaic

github.com/thu-maicその他41.7k264 回インストール今日更新
リポジトリ

openmaic について

OpenMAIC の設定、授業生成、プロジェクト拡張を支援するガイド付きスキルです。状態を変更する前に確認を求め、段階ごとに進めます。モデルプロバイダーの設定はサーバー側に限定します。

主な機能

  1. 01設定と生成を段階的に案内
  2. 02Live Demo・ローカル・拡張の選択肢
  3. 03状態変更前の確認
  4. 04サーバー側のモデルプロバイダー設定案内
  5. 05ヘルスチェックと生成ジョブの手順

活用シーン

  1. 01アクセスコードで OpenMAIC Live Demo を開始
  2. 02ローカルの OpenMAIC インスタンスを設定
  3. 03提供資料から授業を生成
  4. 04OpenMAIC の拡張や SDK の利用

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/thu-maic/openmaic --skill openmaic

インストール後、Claude Code で/openmaicを入力して読み込まれたか確認します。

同梱ファイル

SKILL.md と一緒にインストールされる参考資料やスクリプト。

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

詳細

OpenMAIC スキル

これを、ガイド付きで確認を重視した SOP として使用してください。セットアップ全体を 1 つの返信にまとめて圧縮しないでください。また、ユーザーの明示的な確認なしに状態を変更する操作を実行しないでください。

基本ルール

  • 一度に 1 つのフェーズだけ進めてください。
  • 状態を変更する操作の前には、必ず確認を求めてください。
  • ローカルの状態がすでに存在する場合は、見つけた内容を提示し、それを保持するかどうかを尋ねてください。
  • OpenClaw エージェント自身のモデルや API キーが OpenMAIC によって再利用されると想定しないでください。
  • OpenMAIC の教室生成では、OpenMAIC のサーバー側モデル設定(openmaic.yml および Web アプリのモデル設定)を使用します。
  • このスキルは、リクエスト時のモデルやプロバイダーのオーバーライドに依存してはなりません。
  • プロバイダーの選択とデフォルトを制御できるのは、そのサーバー側設定だけです。
  • ユーザーに API キーをチャットに貼り付けるよう求めることをデフォルトにしないでください。
  • ユーザー自身がローカルの設定ファイルを編集できるよう導くことを優先してください。
  • ユーザーに代わって API キーを設定ファイルへ書き込むことを申し出ないでください。
  • セットアップが完了し、ユーザーが教室の生成を明確に希望したら、生成ジョブを送信する前に 2 回目の確認を求めないでください。
  • PDF をディスクから読み取ってアップロードする前など、ローカルファイルの読み取りに関する確認は維持してください。

オプションのスキル設定

存在する場合は、~/.openclaw/openclaw.json の以下の場所からデフォルトを読み取ってください:

{
  "skills": {
    "entries": {
      "openmaic": {
        "enabled": true,
        "config": {
          "accessCode": "sk-xxx",
          "repoDir": "/path/to/OpenMAIC",
          "url": "http://localhost:3000"
        }
      }
    }
  }
}
  • accessCode が存在する場合は、デフォルトで Live Demo モードにし、モード選択のプロンプトをスキップしてください — ただし、ユーザーの意図が OpenMAIC を拡張/構築することである場合を除きます(フェーズ 0 の例外を参照)。
  • repoDir と url は、ローカルモードのデフォルトとしてのみ使用してください。
  • 操作の前には、引き続き確認してください。

SOP フェーズ

0. モードの選択

まず設定に accessCode があるか確認してください。存在する場合は、保存されたアクセスコードがあったことを伝え、そのまま Live Demo モードへ進んでください(references/live-demo.md を読み込み、フェーズ 1〜4 をスキップします)。ユーザーにコードを再度尋ねないでください。例外: ユーザーが表明した意図が、OpenMAIC の拡張/構築/カスタマイズ、または @openmaic/* SDK の利用(二次開発 / 二開 / SDK)である場合は、自動ショートカットを行わないでください — accessCode の有無にかかわらず、以下の拡張ブランチへ進んでください。復帰した Live Demo ユーザーが今度は二開を希望する場合は、拡張へルーティングすべきであり、黙って Live Demo に戻してはなりません。

設定に accessCode がない場合(または上記の拡張例外が該当する場合)は、OpenMAIC をどのように使用したいかをユーザーに尋ねてください:

  1. OpenMAIC Live Demo を使用する(クイックスタートに推奨) — クラウド版: OpenMAIC チームが open.maic.chat で公式にデプロイしてホストしているバージョンです。アクセスコード(sk- で始まります)が必要です。取得するには https://open.maic.chat にサインインし、右上隅のアカウントをクリックして「访问码设置」(アクセスコード設定)を開き、コードを生成します。その後、~/.openclaw/openclaw.json の skills.entries.openmaic.config.accessCode に追加してください。ローカルセットアップは不要です。
  2. ローカルで実行する — リポジトリをクローンし、プロバイダーキーを設定して、自分のマシンで実行します。
  3. OpenMAIC を拡張または構築する(二次開発) — リポジトリをフォークして製品をカスタマイズするか、@openmaic/* SDK を利用して新しいものを構築します。

ユーザーが Live Demo モードを選択した場合は、references/live-demo.md を読み込み、フェーズ 1〜4 をスキップしてください。 ユーザーがローカルモードを選択した場合は、通常どおりフェーズ 1 へ進んでください。 ユーザーが OpenMAIC の拡張/構築を選択した場合は、references/extend.md を読み込み、セットアップ/生成のフェーズをスキップしてください。

1. 既存リポジトリのクローンまたは再利用

references/clone.md を読み込んでください。

これは、ユーザーがまだ OpenMAIC をインストールしていない場合、またはどのローカルチェックアウトを使用するかを確認する必要がある場合に使用します。

2. 起動モードの選択

references/startup-modes.md を読み込んでください。

これは、リポジトリの場所が確認された後に使用します。利用可能な起動モードを提示し、1 つを推奨し、ユーザーの選択を待ちます。

3. プロバイダーキーを設定する

references/provider-keys.md を読み込みます。

これは授業の生成を開始する前に使用します。プロバイダーのパスを推奨し、ユーザーが自分で編集すべき箇所(openmaic.yml と .env.local、または Web アプリのモデル設定)を正確に伝えます。後でプロバイダー/モデル/認証の問題により生成が失敗した場合は、このフェーズに戻り、ユーザーに同じ設定を更新するよう案内します。

コアとなる LLM キーを設定した後、ユーザーにオプション機能(Web 検索、画像生成、動画生成、TTS)を有効にするかどうかを尋ねます。それぞれが独自のプロバイダーを持つスロットです。provider-keys.md の「Optional Features」セクションを参照してください。

4. OpenMAIC を起動して検証する

ユーザーが起動モードを選択し、キーを設定した後、選択された方法で OpenMAIC を起動し、GET {url}/api/health でサービスを検証します。

5. 授業を生成する

references/generate-flow.md を読み込みます。

これはサービスの正常性が確認された後にのみ使用します。アップロードするローカルファイルを読み込む前に確認します。ユーザーがすでに生成を明確に要求している場合は、生成ジョブを送信する前に再度の確認を求めず、その後成功または失敗するまでポーリングループに従います(失敗したジョブは再試行できます。generate フローを参照してください)。生成リクエストにはサポートされているフィールド(requirement、materialIds)のみを送信します。オプション機能はサーバーのプロバイダー設定に従います。アップロードと送信は同じオーナーに解決される必要があります。匿名 Cookie モードでは、すべてのリクエストで同じ Cookie ジャーを再利用します。長時間実行されるジョブでは、間隔を空けたポーリングを優先し、ターンが完了前に終了した場合は後で確認するようユーザーに伝えます。

レスポンススタイル

  • 各ステップを短く明確に保ちます。
  • ユーザーが選択する必要がある場合は、2〜3 個の具体的な選択肢を優先します。
  • 常に推奨オプションを最初に示し、その理由を 1 文で説明します。
  • ステップが完了したら、何が変わったか、次に何を確認するのかを伝えます。
  • 授業のリンクを返すときは、生の絶対 URL を太字、Markdown リンク構文、コード書式、表を使わずに単独の行に配置します。

コメント