@amazon-devices/amazon-devices-buildertools-mcp 0.1.24 → 0.1.26
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.ja.md +119 -14
- package/README.md +178 -27
- package/dist/assets/vega-developer-context.db +0 -0
- package/dist/startserver +5 -5
- package/package.json +1 -1
package/README.ja.md
CHANGED
|
@@ -21,6 +21,8 @@ Amazon Devices Builder Tools MCPは以下の機能をサポートしています
|
|
|
21
21
|
| **UI開発** | スクリーンショットとデザインモックアップからVegaアプリのUIを作成 | <ul><li>`{image_path}に画像があります。サンプルテンプレートを使用して新しいフォルダを作成し、画像に合わせてサンプルテストアプリを更新して、アプリをビルドして実行できることを確認してください。`</li></ul> |
|
|
22
22
|
| **フォーカス管理** | TVインターフェース用のD-Padナビゲーションとフォーカス管理を実装 | <ul><li>`フォーカス管理を示すために2つのボタンを持つアプリを作成できますか?`</li></ul> |
|
|
23
23
|
| **SDK & CLI** | SDKのインストール/更新と、仕様駆動型CLIを介した効率的なCLIツールの実行 | <ul><li>`AIエージェントからSDKをインストール/更新`</li><li>`アプリをビルド`</li><li>`仮想デバイスでアプリを実行`</li><li>`物理デバイスでアプリを実行`</li><li>`KPI Visualizerを実行してパフォーマンス結果を取得`</li></ul> |
|
|
24
|
+
| **クラッシュ分析** | JavaScript、Native、LMK、ANRクラッシュの自動ACR分析による診断 | <ul><li>`なぜアプリがクラッシュしたのですか?`</li><li>`このACRファイルを分析してください /path/to/crash.acr`</li></ul> |
|
|
25
|
+
| **フィードバックの提供** | MCPの使用体験についてAmazonにフィードバックを提供 | <ul><li>`フィードバックを提供したい`</li><li>`Vega MCPのフィードバックを提供するにはどうすればよいですか?`</li></ul> |
|
|
24
26
|
|
|
25
27
|
## ワンクリックインストール
|
|
26
28
|
|
|
@@ -43,14 +45,21 @@ Amazon Devices Builder Tools MCPは以下の機能をサポートしています
|
|
|
43
45
|
|
|
44
46
|
以下のコマンドを実行して、AIエージェントにAmazon Devices Builder Tools MCPを**自動的に**インストールし、AIエージェントをガイドするためのVega固有のコンテキストドキュメントをプロジェクトに追加します:
|
|
45
47
|
|
|
46
|
-
> ℹ️ 重要: MCPのワンクリックインストール後でも、`npx -y @amazon-devices/amazon-devices-buildertools-mcp@latest
|
|
48
|
+
> ℹ️ 重要: MCPのワンクリックインストール後でも、`npx -y @amazon-devices/amazon-devices-buildertools-mcp@latest init-context` を実行して、プロジェクトディレクトリに優先AIエージェント用のVegaコンテキストドキュメントをインストールすることが重要です。
|
|
49
|
+
|
|
50
|
+
> ⚠️ **非推奨のお知らせ**: `--init-context` フラグは非推奨であり、将来のバージョンで削除されます。代わりに `init-context` サブコマンドを使用してください。
|
|
47
51
|
|
|
48
52
|
```bash
|
|
53
|
+
# 推奨(新しいサブコマンド)
|
|
54
|
+
npx -y @amazon-devices/amazon-devices-buildertools-mcp@latest init-context
|
|
55
|
+
|
|
56
|
+
# 非推奨(削除予定)
|
|
49
57
|
npx -y @amazon-devices/amazon-devices-buildertools-mcp@latest --init-context
|
|
50
58
|
```
|
|
51
59
|
|
|
52
|
-
|
|
60
|
+
このコマンドは**インタラクティブ**モードと**非インタラクティブ**モードの両方をサポートしています:
|
|
53
61
|
|
|
62
|
+
**インタラクティブモード(デフォルト):**
|
|
54
63
|
1. **利用可能なAIエージェント**とそのコンテキストファイル要件を表示
|
|
55
64
|
2. サポートされているリストから**優先AIエージェントを選択**
|
|
56
65
|
3. Amazon Devices Builder Tools MCPサーバーを設定するために**選択したエージェントのMCP設定を更新**
|
|
@@ -58,21 +67,58 @@ npx -y @amazon-devices/amazon-devices-buildertools-mcp@latest --init-context
|
|
|
58
67
|
5. マージまたは更新コンテンツを提供することで**既存のコンテキストファイルを処理**
|
|
59
68
|
6. 選択したAIエージェントの正しい場所に**適切なコンテキストファイルを作成**
|
|
60
69
|
|
|
70
|
+
**非インタラクティブモード:**
|
|
71
|
+
コマンドラインオプションを使用してプロンプトをスキップし、セットアッププロセスを自動化します。
|
|
72
|
+
|
|
73
|
+
### コマンドラインオプション
|
|
74
|
+
|
|
75
|
+
```bash
|
|
76
|
+
init-context [options]
|
|
77
|
+
|
|
78
|
+
オプション:
|
|
79
|
+
-a, --agent <type> 対象のAIエージェント(cursor、cline、kiro、claude-code-cli、
|
|
80
|
+
claude-code-desktop、github-copilot、amazon-q、other)
|
|
81
|
+
-p, --context-document-path コンテキストドキュメントを保存するパス
|
|
82
|
+
-d, --skip-context-document コンテキストドキュメントのインストールをスキップ(MCP設定のみ)
|
|
83
|
+
-m, --skip-mcp-config MCP設定をスキップ(コンテキストドキュメントのみ)
|
|
84
|
+
-f, --force すべての確認プロンプトをスキップして強制上書き
|
|
85
|
+
-h, --help init-contextコマンドのヘルプを表示
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
> ⚠️ **注意**: コマンドラインオプションは `init-context` サブコマンドでのみサポートされています。非推奨の `--init-context` フラグはこれらのオプションをサポートしていません。
|
|
89
|
+
|
|
61
90
|
### 使用例
|
|
62
91
|
|
|
63
92
|
```bash
|
|
64
93
|
# プロジェクトディレクトリに移動
|
|
65
94
|
cd my-vega-project
|
|
66
95
|
|
|
67
|
-
#
|
|
68
|
-
npx -y @amazon-devices/amazon-devices-buildertools-mcp@latest
|
|
96
|
+
# インタラクティブモード(デフォルト)
|
|
97
|
+
npx -y @amazon-devices/amazon-devices-buildertools-mcp@latest init-context
|
|
69
98
|
|
|
70
|
-
#
|
|
71
|
-
|
|
99
|
+
# 特定のエージェントで非インタラクティブ
|
|
100
|
+
npx -y @amazon-devices/amazon-devices-buildertools-mcp@latest init-context --agent cursor --force
|
|
101
|
+
npx -y @amazon-devices/amazon-devices-buildertools-mcp@latest init-context -a cursor -f
|
|
102
|
+
|
|
103
|
+
# MCP設定のみ(コンテキストドキュメントをスキップ)
|
|
104
|
+
npx -y @amazon-devices/amazon-devices-buildertools-mcp@latest init-context --agent cursor --skip-context-document
|
|
105
|
+
npx -y @amazon-devices/amazon-devices-buildertools-mcp@latest init-context -a cursor -d
|
|
106
|
+
|
|
107
|
+
# カスタムパスでコンテキストドキュメントのみ(MCP設定をスキップ)
|
|
108
|
+
npx -y @amazon-devices/amazon-devices-buildertools-mcp@latest init-context --agent kiro --context-document-path ./docs --skip-mcp-config
|
|
109
|
+
npx -y @amazon-devices/amazon-devices-buildertools-mcp@latest init-context -a kiro -p ./docs -m
|
|
110
|
+
|
|
111
|
+
# ヘルプを表示
|
|
112
|
+
npx -y @amazon-devices/amazon-devices-buildertools-mcp@latest init-context --help
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
### インタラクティブモードのプロンプト
|
|
116
|
+
|
|
117
|
+
インタラクティブモードで実行すると、以下のガイドが表示されます:
|
|
118
|
+
# 1. AIエージェントを選択(例:Cursorの場合は「1」、Kiroの場合は「6」、その他/カスタムの場合は「8」)
|
|
72
119
|
# 2. エージェントのMCP設定ファイルを自動的に更新するにはy/nを入力
|
|
73
120
|
# 3. デフォルトのコンテキストドキュメントインストールパスを選択するか、カスタムパスを入力
|
|
74
121
|
# 4. アクションを選択:マージ、更新、またはファイルを保存。続行する前にインストールされたコンテキストドキュメントを確認してください。
|
|
75
|
-
```
|
|
76
122
|
|
|
77
123
|
### 他のAIエージェントでの使用
|
|
78
124
|
|
|
@@ -103,28 +149,73 @@ Amazon Devices Builder Tools MCPを手動で設定するには、AIエージェ
|
|
|
103
149
|
| --- | ---------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
104
150
|
| 1 | Cursor | [手順](https://cursor.com/docs/context/mcp#using-mcpjson) |
|
|
105
151
|
| 2 | Github Copilot | [手順](https://docs.github.com/en/copilot/how-tos/provide-context/use-mcp/extend-copilot-chat-with-mcp) 次に「Configuring MCP Servers Manually」を選択 |
|
|
106
|
-
| 3 | Claude Code
|
|
107
|
-
| 4 |
|
|
108
|
-
| 5 | Amazon Q
|
|
109
|
-
| 6 |
|
|
110
|
-
| 7 |
|
|
152
|
+
| 3 | Claude Code | [手順](https://code.claude.com/docs/en/mcp#option-3%3A-add-a-local-stdio-server) |
|
|
153
|
+
| 4 | Claude Code Desktop | [手順](https://support.claude.com/en/articles/10949351-getting-started-with-local-mcp-servers-on-claude-desktop) |
|
|
154
|
+
| 5 | Amazon Q IDE Extension | [手順](https://docs.aws.amazon.com/amazonq/latest/qdeveloper-ug/mcp-ide.html) |
|
|
155
|
+
| 6 | Amazon Q CLI | [手順](https://docs.aws.amazon.com/amazonq/latest/qdeveloper-ug/command-line-mcp-config-CLI.html) |
|
|
156
|
+
| 7 | Kiro | [手順](https://kiro.dev/docs/mcp/) |
|
|
157
|
+
| 8 | Cline | [手順](https://docs.cline.bot/mcp/configuring-mcp-servers) |
|
|
111
158
|
|
|
112
159
|
_エージェントがリストにない場合は、続行する前にMCPをサポートしていることを確認してください。_
|
|
113
160
|
|
|
114
|
-
> ℹ️ 重要: 設定後、`npx -y @amazon-devices/amazon-devices-buildertools-mcp@latest
|
|
161
|
+
> ℹ️ 重要: 設定後、`npx -y @amazon-devices/amazon-devices-buildertools-mcp@latest init-context` を実行して、プロジェクトディレクトリに優先AIエージェント用のVegaコンテキストドキュメントをインストールしてください
|
|
115
162
|
|
|
116
163
|
## 使用方法
|
|
117
164
|
|
|
118
165
|
### コマンドラインオプション
|
|
119
166
|
|
|
120
167
|
```bash
|
|
121
|
-
npx -y @amazon-devices/amazon-devices-buildertools-mcp@latest
|
|
168
|
+
npx -y @amazon-devices/amazon-devices-buildertools-mcp@latest init-context # Amazon Devices Builder Tools MCPをインストールし、AIエージェント用のVegaコンテキストを初期化
|
|
169
|
+
npx -y @amazon-devices/amazon-devices-buildertools-mcp@latest check-status # AIエージェントのセットアップステータスを確認
|
|
122
170
|
npx -y @amazon-devices/amazon-devices-buildertools-mcp@latest --version # バージョン情報を表示
|
|
123
171
|
npx -y @amazon-devices/amazon-devices-buildertools-mcp@latest -v # バージョン情報を表示(エイリアス)
|
|
124
172
|
npx -y @amazon-devices/amazon-devices-buildertools-mcp@latest --help # ヘルプメッセージを表示
|
|
125
173
|
npx -y @amazon-devices/amazon-devices-buildertools-mcp@latest -h # ヘルプメッセージを表示(エイリアス)
|
|
126
174
|
```
|
|
127
175
|
|
|
176
|
+
### エージェントセットアップステータスの確認
|
|
177
|
+
|
|
178
|
+
MCPサーバーとコンテキストドキュメントをインストールした後、`check-status` コマンドを使用してセットアップを確認できます:
|
|
179
|
+
|
|
180
|
+
```bash
|
|
181
|
+
# すべてのエージェントを確認
|
|
182
|
+
npx -y @amazon-devices/amazon-devices-buildertools-mcp@latest check-status
|
|
183
|
+
|
|
184
|
+
# 特定のエージェントを確認
|
|
185
|
+
npx -y @amazon-devices/amazon-devices-buildertools-mcp@latest check-status --agent kiro
|
|
186
|
+
npx -y @amazon-devices/amazon-devices-buildertools-mcp@latest check-status -a cursor
|
|
187
|
+
|
|
188
|
+
# ヘルプを表示
|
|
189
|
+
npx -y @amazon-devices/amazon-devices-buildertools-mcp@latest check-status --help
|
|
190
|
+
```
|
|
191
|
+
|
|
192
|
+
**確認内容:**
|
|
193
|
+
- ✅ コンテキストドキュメントのインストール状態とバージョン
|
|
194
|
+
- ✅ MCP設定の状態
|
|
195
|
+
- ✅ レガシー設定の検出
|
|
196
|
+
- ✅ 全体的なセットアップの概要
|
|
197
|
+
|
|
198
|
+
**出力例:**
|
|
199
|
+
|
|
200
|
+
```
|
|
201
|
+
====================================================
|
|
202
|
+
🔍 Checking Agent Setup Status
|
|
203
|
+
====================================================
|
|
204
|
+
|
|
205
|
+
─────────────────────────────────────────────────────────────────────────────
|
|
206
|
+
Agent │ Context Document │ MCP Configuration
|
|
207
|
+
─────────────────────────────────────────────────────────────────────────────
|
|
208
|
+
Cursor │ ✅ v5.1 │ ✅ Configured
|
|
209
|
+
Kiro │ ✅ v5.1 │ ✅ Configured
|
|
210
|
+
─────────────────────────────────────────────────────────────────────────────
|
|
211
|
+
|
|
212
|
+
📊 Summary:
|
|
213
|
+
Total agents checked: 2
|
|
214
|
+
✅ Fully configured: 2
|
|
215
|
+
⚠️ Partially configured: 0
|
|
216
|
+
❌ Not configured: 0
|
|
217
|
+
```
|
|
218
|
+
|
|
128
219
|
### AIエージェントにAmazon Devices Builder Tools MCPがインストールされていることを確認
|
|
129
220
|
|
|
130
221
|
AIエージェントのチャットインターフェースで、以下のプロンプトを実行します
|
|
@@ -281,3 +372,17 @@ Amazon Devices Builder Tools MCPは、AIエージェントの`/prompts`でワン
|
|
|
281
372
|
```
|
|
282
373
|
> @upgrade_carousel_component /path/to/HomeScreen.tsx 1.0.6 2.0.0
|
|
283
374
|
```
|
|
375
|
+
|
|
376
|
+
### 6. `diagnose_crash`
|
|
377
|
+
|
|
378
|
+
**説明:** JavaScript、Native、LMK(Low Memory Killer)、ANR(Application Not Responding)クラッシュを含むVegaアプリケーションのクラッシュを診断します。ACRファイルを自動検出し、スタックトレースをシンボリケートし、適切な分析ワークフローにルーティングします。
|
|
379
|
+
|
|
380
|
+
**パラメータ:**
|
|
381
|
+
|
|
382
|
+
- `acr_file_path`(任意、文字列): ACRファイルへのパス。指定しない場合、デバイスの一時ディレクトリからACRファイルを自動検出します。
|
|
383
|
+
|
|
384
|
+
**使用例:**
|
|
385
|
+
|
|
386
|
+
```
|
|
387
|
+
> @diagnose_crash /path/to/crash.acr
|
|
388
|
+
```
|
package/README.md
CHANGED
|
@@ -12,15 +12,17 @@ A Model Context Protocol (MCP) server that provides context and tools for AI age
|
|
|
12
12
|
|
|
13
13
|
The Amazon Devices Builder Tools MCP supports the following capabilities:
|
|
14
14
|
|
|
15
|
-
| App Dev Area
|
|
16
|
-
|
|
17
|
-
| **Onboarding**
|
|
18
|
-
| **Performance**
|
|
19
|
-
| **Performance Best Practices** | Analyze components and code to ensure they follow React Native Vega performance best practices
|
|
20
|
-
| **Best Practices**
|
|
21
|
-
| **UI Development**
|
|
22
|
-
| **Focus Management**
|
|
23
|
-
| **
|
|
15
|
+
| App Dev Area | Description | Example Prompts |
|
|
16
|
+
| ------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
17
|
+
| **Onboarding** | Onboard to Vega app development using AI agents with setup guidance and Q&A support | <ul><li>`Help me set up Vega app project and test my VPKG on Virtual Device?`</li><li>`Help me setup Vega SDK?`</li><li>`Build and run the app on Virtual device/Connected Device.`</li><li>`Can you tell me about vega app development?`</li><li>`What is the Vega CLI command for measuring cpu usage on a Vega device?`</li></ul> |
|
|
18
|
+
| **Performance** | Debug and fix Time to First Frame (TTFF), Time to Fully Drawn (TTFD), and UI re-rendering issues | <ul><li>`Why is the TTFF higher for my Vega app?`</li><li>`Can you help me debug and fix Time to First Frame issue in my Vega app?`</li><li>`Why is the TTFD higher for my Vega app?`</li><li>`Can you help me minimize unnecessary re-renders in my app?`</li><li>`Find any re-rendering issues in my app.`</li></ul> |
|
|
19
|
+
| **Performance Best Practices** | Analyze components and code to ensure they follow React Native Vega performance best practices | <ul><li>`Help me analyze if this component is following React Native Vega performance best practices`</li></ul> |
|
|
20
|
+
| **Best Practices** | Validate manifest files and implement Vega components following best practices | <ul><li>`Can you help me upgrade my MovieCarousel.tsx from Carousel V1 to V2?`</li><li>`Can you help me implement Carousel?`</li><li>`Can you validate my manifest file and update as needed for my app?`</li></ul> |
|
|
21
|
+
| **UI Development** | Create Vega app UI from screenshots and design mockups | <ul><li>`I have an image at {image_path}. Create a Vega app by creating a new folder using the sample template, update the sample test app to match the image, and confirm that the app can be built and run.`</li></ul> |
|
|
22
|
+
| **Focus Management** | Implement D-Pad navigation and focus management for TV interfaces | <ul><li>`Can you create an app with 2 buttons to show case focus management?`</li></ul> |
|
|
23
|
+
| **Give Feedback** | Provide feedback to Amazon about your experience with the MCP | <ul><li>`I want to provide feedback`</li><li>`How can I provide vega mcp feedback?`</li></ul> |
|
|
24
|
+
| **Crash Analysis** | Diagnose JavaScript, Native, LMK, and ANR crashes with automated ACR analysis | <ul><li>`Why did my app crash?`</li><li>`Help me analyze this ACR file /path/to/crash.acr`</li></ul> |
|
|
25
|
+
| **SDK & CLI** | Install/update SDK and efficiently run CLI tools via spec-driven CLI | <ul><li>`Install/update SDK from AI agents`</li><li>`Build my app`</li><li>`Run my app on virtual device`</li><li>`Run my app on physical device`</li><li>`Run KPI Visualizer and get performance results`</li></ul> |
|
|
24
26
|
|
|
25
27
|
## One-Click Installation
|
|
26
28
|
|
|
@@ -38,48 +40,96 @@ Some of the popular AI Agents support installing MCP servers with a single click
|
|
|
38
40
|
|
|
39
41
|
[Add to VSCode](vscode:mcp/install?%7B%22name%22%3A%22amazon-devices-buildertools-mcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40amazon-devices%2Famazon-devices-buildertools-mcp%40latest%22%5D%7D)
|
|
40
42
|
|
|
41
|
-
|
|
42
43
|
## Installation with script
|
|
43
44
|
|
|
44
45
|
Run the following command to **automatically** install Amazon Devices Builder Tools MCP in your AI Agent and add Vega-specific context document to your project to guide AI agents:
|
|
45
46
|
|
|
46
|
-
> ℹ️ Important: It is important to run `npx -y @amazon-devices/amazon-devices-buildertools-mcp@latest
|
|
47
|
+
> ℹ️ Important: It is important to run `npx -y @amazon-devices/amazon-devices-buildertools-mcp@latest init-context` to install the Vega-context document for your preferred AI agent in the project directory. This step is required even after one-click install of mcp.
|
|
48
|
+
|
|
49
|
+
> ⚠️ **Deprecation Notice**: The `--init-context` flag is deprecated and will be removed in a future version. Please use the `init-context` subcommand instead.
|
|
47
50
|
|
|
48
51
|
```bash
|
|
52
|
+
# Recommended (new subcommand)
|
|
53
|
+
npx -y @amazon-devices/amazon-devices-buildertools-mcp@latest init-context
|
|
54
|
+
|
|
55
|
+
# Deprecated (will be removed)
|
|
49
56
|
npx -y @amazon-devices/amazon-devices-buildertools-mcp@latest --init-context
|
|
50
57
|
```
|
|
51
58
|
|
|
52
|
-
This interactive
|
|
59
|
+
This command supports both **interactive** and **non-interactive** modes:
|
|
60
|
+
|
|
61
|
+
**Interactive Mode (default):**
|
|
53
62
|
|
|
54
63
|
1. **Display available AI agents** and their context file requirements
|
|
55
64
|
2. **Let you select your preferred AI agent** from the supported list
|
|
56
|
-
3. **Update selected agent's MCP settings** to configure the Amazon Devices Builder Tools MCP server
|
|
65
|
+
3. **Update selected agent's MCP settings** to configure the Amazon Devices Builder Tools MCP server
|
|
57
66
|
4. **Ask for context installation directory** (defaults to current working directory)
|
|
58
67
|
5. **Handle existing context files** by offering to merge or update content
|
|
59
68
|
6. **Create the appropriate context file** in the correct location for your chosen AI agent
|
|
60
69
|
|
|
70
|
+
**Non-Interactive Mode:**
|
|
71
|
+
Use command-line options to skip prompts and automate the setup process.
|
|
72
|
+
|
|
73
|
+
### Command Line Options
|
|
74
|
+
|
|
75
|
+
```bash
|
|
76
|
+
init-context [options]
|
|
77
|
+
|
|
78
|
+
Options:
|
|
79
|
+
-a, --agent <type> Target AI agent (cursor, cline, kiro, claude-code-cli,
|
|
80
|
+
claude-code-desktop, github-copilot, amazon-q, other)
|
|
81
|
+
-p, --context-document-path Path to save context document
|
|
82
|
+
-d, --skip-context-document Skip context document installation (MCP config only)
|
|
83
|
+
-m, --skip-mcp-config Skip MCP configuration (context document only)
|
|
84
|
+
-f, --force Skip all confirmation prompts and force overwrite
|
|
85
|
+
-h, --help Show help for init-context command
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
> ⚠️ **Note**: Command-line options are only supported with the `init-context` subcommand. The deprecated `--init-context` flag does not support these options.
|
|
89
|
+
|
|
61
90
|
### Example Usage
|
|
62
91
|
|
|
63
92
|
```bash
|
|
64
93
|
# Navigate to your project directory
|
|
65
94
|
cd my-vega-project
|
|
66
95
|
|
|
67
|
-
#
|
|
68
|
-
npx -y @amazon-devices/amazon-devices-buildertools-mcp@latest
|
|
96
|
+
# Interactive mode (default)
|
|
97
|
+
npx -y @amazon-devices/amazon-devices-buildertools-mcp@latest init-context
|
|
98
|
+
|
|
99
|
+
# Non-interactive with specific agent
|
|
100
|
+
npx -y @amazon-devices/amazon-devices-buildertools-mcp@latest init-context --agent cursor --force
|
|
101
|
+
npx -y @amazon-devices/amazon-devices-buildertools-mcp@latest init-context -a cursor -f
|
|
102
|
+
|
|
103
|
+
# MCP config only (skip context document)
|
|
104
|
+
npx -y @amazon-devices/amazon-devices-buildertools-mcp@latest init-context --agent cursor --skip-context-document
|
|
105
|
+
npx -y @amazon-devices/amazon-devices-buildertools-mcp@latest init-context -a cursor -d
|
|
106
|
+
|
|
107
|
+
# Context document only with custom path (skip MCP config)
|
|
108
|
+
npx -y @amazon-devices/amazon-devices-buildertools-mcp@latest init-context --agent kiro --context-document-path ./docs --skip-mcp-config
|
|
109
|
+
npx -y @amazon-devices/amazon-devices-buildertools-mcp@latest init-context -a kiro -p ./docs -m
|
|
110
|
+
|
|
111
|
+
# Show help
|
|
112
|
+
npx -y @amazon-devices/amazon-devices-buildertools-mcp@latest init-context --help
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
### Interactive Mode Prompts
|
|
116
|
+
|
|
117
|
+
When running in interactive mode, you'll be guided through:
|
|
118
|
+
|
|
119
|
+
# 1. Select your AI agent (e.g., "1" for Cursor, "6" for Kiro, "8" for Other/Custom)
|
|
69
120
|
|
|
70
|
-
# Follow the interactive prompts:
|
|
71
|
-
# 1. Select your AI agent (e.g., "5" for Kiro, "7" for Other/Custom)
|
|
72
121
|
# 2. Enter y/n to automatically update Agent's MCP settings file
|
|
122
|
+
|
|
73
123
|
# 3. Choose default context document installation path or enter custom path
|
|
124
|
+
|
|
74
125
|
# 4. Choose action: merge, update or save file. Review the installed context document before proceeding.
|
|
75
|
-
```
|
|
76
126
|
|
|
77
127
|
### Using with Other AI Agents
|
|
78
128
|
|
|
79
129
|
If your AI agent isn't in the supported list, select **"Other/Custom Agent"** which provides:
|
|
80
130
|
|
|
81
|
-
-
|
|
82
|
-
-
|
|
131
|
+
- **View full content**: Display the complete context for manual copying
|
|
132
|
+
- **Manual setup**: Copy the content to your agent's configuration directory
|
|
83
133
|
|
|
84
134
|
> ℹ️ Important: Start the MCP Server from Agent's MCP config, if not already started - check your current running MCPs to ensure the amazon-devices-buildertools-mcp is listed as running/connected.
|
|
85
135
|
|
|
@@ -103,28 +153,73 @@ Below we list some popular AI agents and the link to how to install MCP servers.
|
|
|
103
153
|
| --- | ---------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
104
154
|
| 1 | Cursor | [Instructions](https://cursor.com/docs/context/mcp#using-mcpjson) |
|
|
105
155
|
| 2 | Github Copilot | [Instructions](https://docs.github.com/en/copilot/how-tos/provide-context/use-mcp/extend-copilot-chat-with-mcp) then choose "Configuring MCP Servers Manually" |
|
|
106
|
-
| 3 | Claude Code
|
|
107
|
-
| 4 |
|
|
108
|
-
| 5 | Amazon Q
|
|
109
|
-
| 6 |
|
|
110
|
-
| 7 |
|
|
156
|
+
| 3 | Claude Code | [Instructions](https://code.claude.com/docs/en/mcp#option-3%3A-add-a-local-stdio-server) |
|
|
157
|
+
| 4 | Claude Code Desktop | [Instructions](https://support.claude.com/en/articles/10949351-getting-started-with-local-mcp-servers-on-claude-desktop) |
|
|
158
|
+
| 5 | Amazon Q IDE Extension | [Instructions](https://docs.aws.amazon.com/amazonq/latest/qdeveloper-ug/mcp-ide.html) |
|
|
159
|
+
| 6 | Amazon Q CLI | [Instructions](https://docs.aws.amazon.com/amazonq/latest/qdeveloper-ug/command-line-mcp-config-CLI.html) |
|
|
160
|
+
| 7 | Kiro | [Instructions](https://kiro.dev/docs/mcp/) |
|
|
161
|
+
| 8 | Cline | [Instructions](https://docs.cline.bot/mcp/configuring-mcp-servers) |
|
|
111
162
|
|
|
112
163
|
_If your agent is not listed, please ensure it supports MCP before continuing._
|
|
113
164
|
|
|
114
|
-
> ℹ️ Important: Once configured, run `npx -y @amazon-devices/amazon-devices-buildertools-mcp@latest
|
|
165
|
+
> ℹ️ Important: Once configured, run `npx -y @amazon-devices/amazon-devices-buildertools-mcp@latest init-context` to install the Vega-context document for your preferred AI agent in the project directory
|
|
115
166
|
|
|
116
167
|
## Usage
|
|
117
168
|
|
|
118
169
|
### Command Line Options
|
|
119
170
|
|
|
120
171
|
```bash
|
|
121
|
-
npx -y @amazon-devices/amazon-devices-buildertools-mcp@latest
|
|
172
|
+
npx -y @amazon-devices/amazon-devices-buildertools-mcp@latest init-context # Install Amazon Devices Builder Tools MCP and initialize Vega context for AI agents
|
|
173
|
+
npx -y @amazon-devices/amazon-devices-buildertools-mcp@latest check-status # Check setup status of AI agents
|
|
122
174
|
npx -y @amazon-devices/amazon-devices-buildertools-mcp@latest --version # Show version information
|
|
123
175
|
npx -y @amazon-devices/amazon-devices-buildertools-mcp@latest -v # Show version information (alias)
|
|
124
176
|
npx -y @amazon-devices/amazon-devices-buildertools-mcp@latest --help # Show help message
|
|
125
177
|
npx -y @amazon-devices/amazon-devices-buildertools-mcp@latest -h # Show help message (alias)
|
|
126
178
|
```
|
|
127
179
|
|
|
180
|
+
### Check Agent Setup Status
|
|
181
|
+
|
|
182
|
+
After installing the MCP server and context documents, you can verify your setup using the `check-status` command:
|
|
183
|
+
|
|
184
|
+
```bash
|
|
185
|
+
# Check all agents
|
|
186
|
+
npx -y @amazon-devices/amazon-devices-buildertools-mcp@latest check-status
|
|
187
|
+
|
|
188
|
+
# Check specific agent
|
|
189
|
+
npx -y @amazon-devices/amazon-devices-buildertools-mcp@latest check-status --agent kiro
|
|
190
|
+
npx -y @amazon-devices/amazon-devices-buildertools-mcp@latest check-status -a cursor
|
|
191
|
+
|
|
192
|
+
# Show help
|
|
193
|
+
npx -y @amazon-devices/amazon-devices-buildertools-mcp@latest check-status --help
|
|
194
|
+
```
|
|
195
|
+
|
|
196
|
+
**What it checks:**
|
|
197
|
+
- ✅ Context document installation status and version
|
|
198
|
+
- ✅ MCP configuration status
|
|
199
|
+
- ✅ Detection of legacy configurations
|
|
200
|
+
- ✅ Overall setup summary
|
|
201
|
+
|
|
202
|
+
**Example output:**
|
|
203
|
+
|
|
204
|
+
```
|
|
205
|
+
====================================================
|
|
206
|
+
🔍 Checking Agent Setup Status
|
|
207
|
+
====================================================
|
|
208
|
+
|
|
209
|
+
─────────────────────────────────────────────────────────────────────────────
|
|
210
|
+
Agent │ Context Document │ MCP Configuration
|
|
211
|
+
─────────────────────────────────────────────────────────────────────────────
|
|
212
|
+
Cursor │ ✅ v5.1 │ ✅ Configured
|
|
213
|
+
Kiro │ ✅ v5.1 │ ✅ Configured
|
|
214
|
+
─────────────────────────────────────────────────────────────────────────────
|
|
215
|
+
|
|
216
|
+
📊 Summary:
|
|
217
|
+
Total agents checked: 2
|
|
218
|
+
✅ Fully configured: 2
|
|
219
|
+
⚠️ Partially configured: 0
|
|
220
|
+
❌ Not configured: 0
|
|
221
|
+
```
|
|
222
|
+
|
|
128
223
|
### Verify Amazon Devices Builder Tools MCP is installed in your AI Agent
|
|
129
224
|
|
|
130
225
|
In your AI Agent's chat interface, run the following prompt
|
|
@@ -136,8 +231,10 @@ List the tools provided by Amazon Devices Builder Tools MCP
|
|
|
136
231
|
You should see a response that includes the following tools:
|
|
137
232
|
|
|
138
233
|
- analyze_perfetto_traces
|
|
234
|
+
- get_app_hot_functions
|
|
139
235
|
- read_document
|
|
140
236
|
- list_documents
|
|
237
|
+
- read_asset
|
|
141
238
|
|
|
142
239
|
## MCP Tools
|
|
143
240
|
|
|
@@ -148,9 +245,11 @@ The Amazon Devices Builder Tools MCP provides the following tools to assist with
|
|
|
148
245
|
Read documents related to App development for Amazon Vega OS. This tool provides access to comprehensive documentation about Vega app development and debugging topics.
|
|
149
246
|
|
|
150
247
|
**Parameters:**
|
|
248
|
+
|
|
151
249
|
- `document_name` (required): Name of the document to read (e.g., `react-native-for-vega-performance-best-practices.md`). Must be a markdown document with `.md` extension.
|
|
152
250
|
|
|
153
251
|
**Example usage:**
|
|
252
|
+
|
|
154
253
|
```
|
|
155
254
|
Read the document react-native-for-vega-performance-best-practices.md
|
|
156
255
|
```
|
|
@@ -160,13 +259,17 @@ Read the document react-native-for-vega-performance-best-practices.md
|
|
|
160
259
|
List all available Vega documents related to App development for Amazon Vega OS. Returns name and description of available documents that can be retrieved using the `read_document` tool.
|
|
161
260
|
|
|
162
261
|
**Parameters:**
|
|
262
|
+
|
|
163
263
|
- `documentType` (optional): Filter documents by type. Valid values: `KB` (Knowledge Base), `PROMPT`, `STEERING`, `WORKFLOW`
|
|
164
264
|
|
|
165
265
|
**Example usage:**
|
|
266
|
+
|
|
166
267
|
```
|
|
167
268
|
List all available Vega documents
|
|
168
269
|
```
|
|
270
|
+
|
|
169
271
|
or
|
|
272
|
+
|
|
170
273
|
```
|
|
171
274
|
List documents of type KB
|
|
172
275
|
```
|
|
@@ -176,6 +279,7 @@ List documents of type KB
|
|
|
176
279
|
Analyze Vega platform traces using Perfetto trace processor to extract KPI metrics and related performance data. This tool helps diagnose performance issues and analyze app launch times.
|
|
177
280
|
|
|
178
281
|
**Parameters:**
|
|
282
|
+
|
|
179
283
|
- `traceFilePath` (required): Path to the trace file to analyze. Usually found in Vega performance data output directories with names like `iter_*_vs_trace`
|
|
180
284
|
- `queryType` (optional): Type of query to execute. Default: `kpi_analysis`
|
|
181
285
|
- `kpiType` (optional): Specific KPI type to analyze. Options: `ttff` (Time to First Frame), `ttfd` (Time to First Display), `all`. Default: `all`
|
|
@@ -184,6 +288,7 @@ Analyze Vega platform traces using Perfetto trace processor to extract KPI metri
|
|
|
184
288
|
- `appProcessName` (optional): Main application process name to analyze (will be auto-detected if not provided)
|
|
185
289
|
|
|
186
290
|
**Example usage:**
|
|
291
|
+
|
|
187
292
|
```
|
|
188
293
|
Analyze the trace file at /path/to/iter_1_vs_trace
|
|
189
294
|
```
|
|
@@ -193,6 +298,7 @@ Analyze the trace file at /path/to/iter_1_vs_trace
|
|
|
193
298
|
Reads and analyzes CPU trace files to identify hot functions (CPU-intensive operations) contributing to performance bottlenecks. This tool helps pinpoint which functions in your application are consuming the most CPU time, enabling targeted performance optimization.
|
|
194
299
|
|
|
195
300
|
**Parameters:**
|
|
301
|
+
|
|
196
302
|
- `traceDataFilePath` (required): Path to the trace data file from the Activity Monitor. Usually found in Vega performance data output directories with names like `iter_<iteration>_trace<epoch>-converted.json` (e.g., `iter_2_trace1766067380670018106-converted.json`)
|
|
197
303
|
- `limit` (optional): Maximum number of hot functions to return (default: 10)
|
|
198
304
|
- `useSelfTime` (optional): Flag to indicate whether to use self CPU time or total CPU time for sorting (default: false)
|
|
@@ -201,15 +307,36 @@ Reads and analyzes CPU trace files to identify hot functions (CPU-intensive oper
|
|
|
201
307
|
- `endOffsetSeconds` (optional): End time offset in seconds from trace beginning (e.g., 15.8 for analysis ending 15.8 seconds after trace start)
|
|
202
308
|
|
|
203
309
|
**Example usage:**
|
|
310
|
+
|
|
204
311
|
```
|
|
205
312
|
Analyze hot functions in the trace file at /path/to/iter_2_trace1766067380670018106-converted.json
|
|
206
313
|
```
|
|
207
314
|
|
|
208
315
|
or with time window filtering:
|
|
316
|
+
|
|
209
317
|
```
|
|
210
318
|
Analyze hot functions in /path/to/trace.json from 5 to 15 seconds with a limit of 20 functions
|
|
211
319
|
```
|
|
212
320
|
|
|
321
|
+
### 5. `read_asset`
|
|
322
|
+
|
|
323
|
+
Read assets referenced in Vega documentation. Assets are saved to a temporary location and the path is returned. Images can be viewed with
|
|
324
|
+
`fs_read` and scripts executed with the appropriate interpreter (e.g., `python3`)
|
|
325
|
+
|
|
326
|
+
**Parameters**
|
|
327
|
+
- `asset_id` (required): Path of the asset to read (e.g., `assets/scripts/example.py` or `assets/images/diagram.png`)
|
|
328
|
+
|
|
329
|
+
**Example usage:**
|
|
330
|
+
```
|
|
331
|
+
Read the script assets/scripts/setup.sh and execute it
|
|
332
|
+
```
|
|
333
|
+
|
|
334
|
+
or
|
|
335
|
+
|
|
336
|
+
```
|
|
337
|
+
Read the image assets/images/architecture.png and describe what it shows
|
|
338
|
+
```
|
|
339
|
+
|
|
213
340
|
## MCP Prompts
|
|
214
341
|
|
|
215
342
|
> Check if your AI Agents supports MCP Prompts (`/prompts`) in https://modelcontextprotocol.io/clients
|
|
@@ -223,10 +350,12 @@ Amazon Devices Builder Tools MCP provides the following pre-defined prompt templ
|
|
|
223
350
|
**Description:** Diagnose Vega application's Time to First Frame (TTFF) KPI
|
|
224
351
|
|
|
225
352
|
**Parameters:**
|
|
353
|
+
|
|
226
354
|
- `kpi_report_file_path` (required, string): Absolute path to the KPI report file
|
|
227
355
|
- `kpi_to_diagnose` (required, string): Name of the KPI from KPI report to diagnose
|
|
228
356
|
|
|
229
357
|
**Example usage:**
|
|
358
|
+
|
|
230
359
|
```
|
|
231
360
|
> @diagnose_kpi_ttff /path/to/report.json ttff
|
|
232
361
|
```
|
|
@@ -236,10 +365,12 @@ Amazon Devices Builder Tools MCP provides the following pre-defined prompt templ
|
|
|
236
365
|
**Description:** Diagnose Vega application's Time to Fully Drawn (TTFD) KPI
|
|
237
366
|
|
|
238
367
|
**Parameters:**
|
|
368
|
+
|
|
239
369
|
- `kpi_report_file_path` (required, string): Absolute path to the KPI report file
|
|
240
370
|
- `kpi_to_diagnose` (required, string): Name of the KPI from KPI report to diagnose
|
|
241
371
|
|
|
242
372
|
**Example usage:**
|
|
373
|
+
|
|
243
374
|
```
|
|
244
375
|
> @diagnose_kpi_ttfd /path/to/report.json ttfd
|
|
245
376
|
```
|
|
@@ -249,9 +380,11 @@ Amazon Devices Builder Tools MCP provides the following pre-defined prompt templ
|
|
|
249
380
|
**Description:** Diagnose and optimize React Native application performance issues including component rendering, memory management, navigation, network optimization, and state management.
|
|
250
381
|
|
|
251
382
|
**Parameters:**
|
|
383
|
+
|
|
252
384
|
- `app_source_path` (required, string): Path to the React Native application source code directory for analysis
|
|
253
385
|
|
|
254
386
|
**Example usage:**
|
|
387
|
+
|
|
255
388
|
```
|
|
256
389
|
> @apply_performance_best_practices /path/to/my-vega-app/src
|
|
257
390
|
```
|
|
@@ -261,9 +394,11 @@ Amazon Devices Builder Tools MCP provides the following pre-defined prompt templ
|
|
|
261
394
|
**Description:** Diagnose and optimize Vega application UI fluidity performance issues caused by component re-rendering using React Native tools.
|
|
262
395
|
|
|
263
396
|
**Parameters:**
|
|
397
|
+
|
|
264
398
|
- `vega_app_package_path` (required, string): Absolute path to the Vega app package root directory
|
|
265
399
|
|
|
266
400
|
**Example usage:**
|
|
401
|
+
|
|
267
402
|
```
|
|
268
403
|
> @detect_component_re-renders /path/to/my-vega-app
|
|
269
404
|
```
|
|
@@ -273,11 +408,27 @@ Amazon Devices Builder Tools MCP provides the following pre-defined prompt templ
|
|
|
273
408
|
**Description:** Assists in migrating to newer versions of the Carousel component in the Vega SDK.
|
|
274
409
|
|
|
275
410
|
**Parameters:**
|
|
411
|
+
|
|
276
412
|
- `current_implementation_file_path` (required, string): Absolute path to the file containing the V1 implementation of Carousel
|
|
277
413
|
- `current_version` (required, string): The current version of Carousel, independent of package
|
|
278
414
|
- `target_version` (required, string): The target version of Carousel, independent of package
|
|
279
415
|
|
|
280
416
|
**Example usage:**
|
|
417
|
+
|
|
281
418
|
```
|
|
282
419
|
> @upgrade_carousel_component /path/to/HomeScreen.tsx 1.0.6 2.0.0
|
|
283
420
|
```
|
|
421
|
+
|
|
422
|
+
### 6. `diagnose_crash`
|
|
423
|
+
|
|
424
|
+
**Description:** Diagnose crashes in Vega applications including JavaScript, Native, LMK (Low Memory Killer), and ANR (Application Not Responding) crashes. Automatically discovers ACR files, symbolicates stack traces, and routes to the appropriate analysis workflow.
|
|
425
|
+
|
|
426
|
+
**Parameters:**
|
|
427
|
+
|
|
428
|
+
- `acr_file_path` (optional, string): Path to ACR file. If not provided, the tool will auto-discover ACR files from the device temp directory.
|
|
429
|
+
|
|
430
|
+
**Example usage:**
|
|
431
|
+
|
|
432
|
+
```
|
|
433
|
+
> @diagnose_crash /path/to/crash.acr
|
|
434
|
+
```
|
|
Binary file
|