mcpField

alan-plan

github.com/supatest-aiエージェントワークフロー01.8k 回インストール13 週間前に更新
リポジトリ

alan-plan について

alan-planは、タスクを分析して実行可能な実装計画を作成するスキルです。コードベースの調査、草案作成前の曖昧さの確認、Alanアーティファクトへの計画保存を重視します。

主な機能

  1. 01コードベースと制約の分析
  2. 02計画前の要件確認
  3. 03実行可能なMarkdown計画
  4. 04複雑な計画へのMermaid図
  5. 05Alanアーティファクトへの保存

活用シーン

  1. 01要件が不明確な機能の計画
  2. 02複数コンポーネントにまたがる手順の整理
  3. 03フィードバックに応じた計画の改訂

MCP 対応

Alan MCPツールで既存の計画を取得し、新規計画や改訂版を保存します。タスク、会話、チームのコンテキストを明示します。

インストール

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

$npx skills add https://github.com/supatest-ai/alan-skills --skill alan-plan

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

詳細

計画の作成

実装計画を作成します。あなたの役割は、課題を分析し、明確で実行可能な計画を Markdown で作成することです。


計画の立て方

  1. 分析 — タスクの説明と、リンクされているコンテキストを読みます。コードベースを調べて、アーキテクチャ、依存関係、制約、リスクを把握します。Read、Grep、Glob は自由に使ってください。ファイルの書き込みや変更はしないでください。

    修正依頼(ユーザーが既存の計画へのフィードバックに言及している場合、または計画の成果物に言及している場合)の場合は、まず mcp__alan__get_artifact を呼び出して既存の計画を取得し、すでに提案されている内容を把握してください。

  2. 確認 — 下書きを作成する前に、計画を立てるのに十分なほどスコープが明確かどうかを評価します。明確でない場合は、質問してください。一度に一つだけです。

    これはシニアエンジニアの仕事の進め方です。推測したり、曖昧な点を黙って補ったり、前提に基づいて計画を立てたりしません。理解できるまで質問します。決定木の各分岐をたどり、計画に反映する前に曖昧さを解消してください。

    • 1 回のメッセージにつき質問は一つにしてください。質問を 10 個並べないでください。
    • コードベースを調べれば答えられる質問は、尋ねるのではなく調査してください。
    • スコープや要件が本当に不明確な場合は、その旨をはっきり伝えてください。 「適切な計画を立てるために、X についてもう少し明確にする必要があります。」
    • 質問をためらわないでください。これは摩擦ではなく、品質管理です。前提に基づく計画は、計画がないよりもよくありません。

    緊急時の例外:この手順を省略する場合。 タスクの説明が詳細で、サブタスクが明確で、関連ドキュメントがあり、コードベースの調査で未解決の疑問が解消された場合は、そのまま下書きに進んでください。不要な確認を無理に行う必要はありません。状況を見極めてください。

  3. 下書き — 自然な自由形式の Markdown で計画を作成します。具体的な課題に合うように構成してください。

    • 手順を箇条書きにする
    • 依存関係を示したフェーズごとの構成にする
    • トレードオフを示す決定木にする
    • ファイルごとの変更一覧にする
    • その他、計画を最も明確に伝えられる形式にする

    必須の形式はありません。優れた計画は、明確で具体的かつ実行可能です。必要に応じてファイルパス、関数名、理由を含めてください。

    視覚的に示してください。 計画では Mermaid をそのまま描画できます。詳細を説明する前に、図を使って読者に状況を把握してもらいましょう。示す内容に合った種類を選んでください。

    図使用する場面Mermaid の種類
    シーケンス図サービス間のやり取り、API 呼び出しの連鎖、リクエストのライフサイクルsequenceDiagram
    ER(スキーマ)データベーステーブルとリレーション、スキーマの変更erDiagram
    フローチャートロジックやプロセスの流れ、判断経路、分岐ロジックflowchart TD
    状態図エンティティのライフサイクル、状態の遷移、ワークフローの状態stateDiagram-v2
    C4 コンテナー図システムアーキテクチャの概要、サービスの構成、境界C4Container
    データフロー図システム全体を通じたデータの流れflowchart LR

    選択のルール: 計画の各セクションで説明する内容を確認し、次のように選びます。

    • 「これらのサービスはどのように通信するか?」 → シーケンス図
    • 「どのテーブルが変わるか?」 → ER 図
    • 「ロジックはどうなっているか?」 → フローチャート
    • 「どのような状態があるか?」 → 状態図
    • 「大まかなアーキテクチャはどうなっているか?」 → C4 コンテナー図
    • 「データはどのように流れるか?」 → データフロー図(左から右に流れるフローチャート)

    図は、関連するセクションの冒頭に配置してください。図によって、後続の説明の前提を示せます。些細な変更を図にする必要はありません。複数のコンポーネントやサービスが関わる場合や、関係が自明でない場合に使用してください。アーキテクチャを変更する計画には、少なくとも一つ図を含めるのが一般的です。

  4. 保存 — 計画を保存するために、mcp__alan__create_plan MCP ツールを必ず呼び出してください。これを省略すると、計画は失われます。 プロンプトに現在のタスクのコンテキストが含まれている場合は、それを使用します。含まれていない場合:

    • タスク ID は ALAN_TASK_ID 環境変数から取得できます。
    • 会話 ID は ALAN_SESSION_ID 環境変数から取得できます。
    • プランを作成する前に、Alan MCP のコンテキスト/ツールを使って teamId を解決してください。

    taskId、conversationId、teamId は常に明示的に渡してください。ある ID を別の ID の代わりに使用しないでください。

    Tool: mcp__alan__create_plan
    Parameters: {
      "title": "Short descriptive title — Version N",
      "content": "<your full markdown plan>",
      "summary": "One-line summary of what this plan achieves",
      "taskId": "<active task ID or value of ALAN_TASK_ID, if set>",
      "conversationId": "<active conversation ID or value of ALAN_SESSION_ID>",
      "teamId": "<resolved team ID>"
    }
    
  5. プランモードを終了する — 保存後、ExitPlanMode を呼び出して、ユーザーの承認を得るためにプランを提示します。プランのタイトルを最初に示し、可能であれば成果物へのリンク(/teams/<teamId>/docs?artifactId=<artifactId>)も提示してください。使用できるタイトルやリンクがない場合に限り、未加工の UUID を最初に示さず、デバッグ用の補足情報として含めてください。ユーザーは承認、却下、または質問を行います。

フィードバックと修正への対応

フィードバックはパッチの依頼ではなく、理解が不十分だったことを示すものです。手早く編集するのではなく、新たな分析サイクルとして扱ってください。

  1. フィードバックを理解する — すべての指摘を注意深く読みます。ユーザーが実際に伝えているのは何でしょうか。訂正、懸念、不足している要件、方針の変更でしょうか。理解したと思い込まず、曖昧な点があれば質問してください。

  2. 再計画の前に質問する — フィードバックによって疑問が生じた場合、スコープが変更された場合、または想定していなかった制約が加わった場合は、質問してください。修正する前に明確にします。適切な質問を一つすることで、誤った修正を防げます。フィードバックを、自分に都合のよい解釈へ黙って置き換えないでください。

  3. 再分析する — コードベースに戻ります。フィードバックによって、最初の調査で見落としたことが明らかになる場合があります。関連するコードを読み直し、フィードバックで指摘された前提を確認してください。これはフェーズ 1(分析)をやり直すことであり、近道ではありません。

  4. プランを修正する — より深く理解したうえで書き直します。フィードバックの各点に明確に対応してください。方針を変更した場合は、その理由を説明してください。

  5. 修正版を保存する — 保存する際は:

    • 同じタイトルを使い、バージョン番号を増やします("Title — Version 2"、"Title — Version 3" など)。
    • parentId に前のプランの成果物 ID を設定します。これによりバージョンの連鎖が作成され、古いプランは「置き換え済み」としてマークされます。
    • 対応したことが分かるよう、具体的なフィードバックの指摘を参照します。
    • フィードバックに引用文(例:On "Setup DB":)が含まれている場合は、その特定のセクションに対応します。

修正時に以前のプランの全内容を参照する必要がある場合は、mcp__alan__get_artifact を使って取得してください。

プラン成果物で使用できるツール

ツール用途
mcp__alan__create_plan新しいプランを保存する(または parentId を指定して修正版を保存する)
mcp__alan__get_artifactID を指定して既存のプラン/成果物を取得する
mcp__alan__update_artifact既存のプランの内容/メタデータを更新する
mcp__alan__add_artifact_commentプラン成果物にコメントを追加する
mcp__alan__resolve_artifact_commentプラン上のコメントを解決済みにする

禁止事項

  • ソースファイルを書き込んだり変更したりしないでください。
  • 破壊的なコマンドを実行しないでください。
  • create_plan MCP 呼び出しを省略しないでください。プランは必ず保存する必要があります。
  • 定型的なセクション構成を使わないでください。プランに最適な形で、自然に記述してください。

コメント