mcpField
A
app-brief

app-brief

github.com/cribl-community開発468 回インストール10 週間前に更新
リポジトリ

app-brief について

app-briefは、Criblアプリ開発向けのスキルです。APP_DEFINITION.mdからAPP_BRIEF.mdを作成し、定義の変更に応じて既存のブリーフを段階的に更新します。既存の補足を保ち、Claude Codeによる実装に利用できます。

主な機能

  1. 01初回のアプリブリーフを作成
  2. 02定義ファイルの変更を検出
  3. 03ワークフローと要件を段階的に更新
  4. 04既存の詳細と実装ガイダンスを保持

活用シーン

  1. 01アプリ定義から実装ブリーフを作成
  2. 02既存ブリーフに新しいワークフローを追加

インストール

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

$npx skills add https://github.com/cribl-community/claude-cribl-app-plugins --skill app-brief

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

詳細

app-brief APP_DEFINITION.md に基づいて、アプリの概要を生成または更新します。初回実行時は、APP_BRIEF.md を新規作成します。以降の実行では、APP_DEFINITION.md の変更を検出し、既存の概要を段階的に更新します。 /app-brief

事前確認

続行する前に、スキャフォールディング済みの Cribl アプリのフォルダー内にいることを確認してください。該当しない場合は、処理を中止し、ユーザーに「このスキルは、スキャフォールディング済みの Cribl アプリのフォルダー内で実行してください。」と伝えます。

トリガー: APP_DEFINITION.md があるフォルダーでこのスキルを実行します。

入力: APP_DEFINITION.md の内容(更新時は既存の APP_BRIEF.md も任意)

出力: Claude Code がアプリを実装する際に使用できる、編集機能を備えた包括的なアプリ概要。APP_BRIEF.md に保存されます。

使い方

  1. アプリのディレクトリーに cd します
  2. このスキルを実行します:/app-brief
    • 初回実行: 定義に基づいて APP_BRIEF.md を作成します
    • 以降の実行: APP_DEFINITION.md の変更に基づいて APP_BRIEF.md を更新します
  3. 生成された概要を確認して編集します
  4. /app-validate スキルを実行します
  5. 検証に失敗した場合は、概要を修正します。
  6. app-brief の内容をエージェント型ツール(Claude Code)に渡します

スキルのワークフロー

ステップ 1:既存の概要を確認する
  • APP_BRIEF.md が存在しない場合:「概要を生成する」ワークフロー(以下を参照)を実行します
  • APP_BRIEF.md がすでに存在する場合:「概要を更新する」ワークフロー(以下を参照)を実行します
ステップ 2A:概要を生成する(初回実行)

APP_BRIEF.md が存在しない場合は、APP_DEFINITION.md で提供された回答に基づいて、実装概要を新規作成します

# [App Name] - App Brief

## App ID
[The unique identifier for this app]

## Problem & Vision
[Summary of the problem the app solves and how users benefit]

## Target Users
[Who uses this app and what they're trying to accomplish]

## Key Workflows
### Workflow 1: [Name]
- **User sees**: [What appears on screen]
- **User does**: [What they click/configure/select]
- **Result**: [What gets created/changed/shown]
- **Permissions**: [Who can do this? Any restrictions?]

### Workflow 2: [Name]
- **User sees**: [What appears on screen]
- **User does**: [What they click/configure/select]
- **Result**: [What gets created/changed/shown]
- **Permissions**: [Who can do this? Any restrictions?]

[+ Additional workflows as needed]

## Data & Actions
**The app will fetch from Cribl:**
- [Resource type 1]: [Why? Used in which workflow?]
- [Resource type 2]: [Why? Used in which workflow?]

**The app will create/modify/delete in Cribl:**
- [Resource type 1]: [Which workflow creates/modifies/deletes this?]
- [Resource type 2]: [Which workflow creates/modifies/deletes this?]

**The app will remember (general state):**
- [State 1]: [What should be saved? When should it persist?]
- [State 2]: [What should be saved? When should it persist?]

(Or "None" if no general state)

**User-specific settings (stored per user):**
- [Setting 1]: [What is it? Which user(s) need it?]
- [Setting 2]: [What is it? Which user(s) need it?]

(Or "None" if no per-user settings)

**Secure secrets:**
- [Secret 1]: [What is it? How is it used?]
- [Secret 2]: [What is it? How is it used?]

(Or "None" if no secrets)

## UI Structure
### Overall Layout
[Recommended structure: wizard, dashboard, form, table, etc.]

### Key Screens/Pages
1. **[Screen Name]**: [What it shows, what user can interact with]
2. **[Screen Name]**: [What it shows, what user can interact with]
3. **[Screen Name]**: [What it shows, what user can interact with]

[Add more screens as needed]

## Permissions & Access
- **Who can use this app?**: [All members, or specific roles?]
- **Permission-aware behavior**: [How does the app respond if a user lacks access to an action?]

## External Integrations (if any)
- **[Service name]**: [What does the app do with it?]
- **[Service name]**: [What does the app do with it?]

(Or "None" if the app only works with Cribl)

## MVP Scope
**Must-have:**
- [Feature 1]
- [Feature 2]

**Nice-to-have (defer):**
- [Feature 1]
- [Feature 2]

**Out of scope:**
- [Feature 1]

## Edge Cases & Error Handling
- **If user lacks permission**: [What should the app show?]
- **If data is unavailable**: [What should the app show?]
- **If an action fails**: [What should the app show?]

## Implementation guidance (include this section verbatim)
- Read AGENTS.md first
- Then read openapi.json
- NEVER EVER use local storage 

---
ステップ 2B:概要を更新する(以降の実行)

APP_BRIEF.md がすでに存在する場合は、APP_DEFINITION.md の変更に基づいて適切に更新します。

変更の検出とマージのロジック:

  1. 2 つのファイルを比較し、APP_DEFINITION.md の変更点を特定します。

    • アプリ ID の変更
    • 新しいワークフローの追加
    • ワークフローの変更(名前、説明、または手順の変更)
    • 新しいデータ要件(新しい取得元、作成/変更/削除操作、状態フィールド)
    • 新しい UI 画面またはレイアウトの変更
    • 新しいスコープ項目(必須、あると望ましい、対象外)
    • 権限、インテグレーション、またはエッジケースの変更
  2. 新しいワークフローの場合: 既存のワークフローと同じ形式に従い、APP_BRIEF.md の「## 主要なワークフロー」セクションに追加します

  3. 変更されたワークフローの場合: 概要に追加された補足説明や例のうち、定義にはないものを保持しながら、該当するワークフローのセクションを新しい詳細で更新します

  4. 新しいデータ要件の場合: 該当する小見出し(取得、作成/変更/削除、状態、設定、シークレット)の下にある「## データとアクション」セクションに追加します

  5. 新しい UI 画面の場合: 「## UI 構成」セクションの「主要な画面/ページ」リストに追加します

  6. スコープの変更の場合: 該当する小見出しの下にある「## MVP のスコープ」セクションに新しい項目を追加します

  7. その他の変更の場合: 関連するセクション(課題とビジョン、対象ユーザー、権限とアクセス、外部インテグレーション、エッジケースとエラー処理)を更新します

保持ルール:

  • APP_BRIEF.md に存在し、更新後の APP_DEFINITION.md に記載されていないセクションやワークフローを削除しないでください
  • 定義にない内容として概要に追加された補足説明、例、実装の詳細はすべて保持してください
  • 定義内のワークフローの説明のほうが詳細な場合は、概要の内容を置き換えます。概要のほうが詳細な場合は、その内容を保持します
  • 「## 実装ガイダンス」セクションは常にそのまま保持してください

出力:

  • 変更の概要を表示します:「新しいワークフローを 1 件追加しました:[名前]。2 件のワークフローを更新しました:[名前]。データ要件を 3 件追加しました。」
  • 更新した概要を APP_BRIEF.md に保存します
  • 確認用に、更新したセクションをユーザーに表示します

ワークフローの終了

ブリーフの生成または更新が完了すると、最終版のブリーフを次の用途に使用できます。

  • 初回実行:内容を確認し、必要に応じて編集してから、/app-validate を実行して整合性を検証します
  • 2 回目以降の実行:差分の概要を確認し、更新されたセクションをチェックしてから、/app-implement で変更をコミットします

主な原則

  • 専門用語を使わない:ユーザーが問題を説明し、Claude が実装方法を判断します
  • Markdown で保存:読みやすく、編集やバージョン管理も簡単です
  • 反復的な更新:要件の変化に応じて、ブリーフを再生成・更新できます
  • 段階的な更新:変更されたセクションのみを書き換え、既存の詳細な説明は保持します
  • ファイルを直接編集:ユーザーは APP_BRIEF.md を直接編集して、すばやく反復できます
  • API は Claude が処理:Claude は openapi.json を使って、呼び出す Cribl API を判断します
  • ユーザーごとのストレージ:ユーザーごとの設定には、ユーザー ID が自動的に接頭辞として付加されます
  • MVP を優先:必要最小限のものをリリースし、反復して改善することを推奨します
  • 外部連携のみ:アプリが呼び出す場合に限り、サードパーティーのサービスを記載します
  • 信頼できる唯一の情報源:APP_DEFINITION.md が正式な情報源です。ここでの変更がブリーフの更新に反映されます

ワークフローの例:新機能の追加

  1. APP_DEFINITION.md を編集して、新しいワークフロー(例:「連携機能の一括有効化/無効化」)を追加します
  2. /app-brief を実行します。スキルが新しいワークフローを検出し、ブリーフに追加します
  3. 更新されたブリーフを確認し、新しいワークフローが既存のワークフローに組み込まれていることを確認します
  4. /app-validate を実行して、更新されたブリーフに問題がないことを確認します
  5. /app-implement を実行して、新しいワークフローを実装します

リソース

コメント