@primeuicom/mcp 0.1.11 → 0.1.12

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.md CHANGED
@@ -23,7 +23,12 @@ Core goals:
23
23
  ## PrimeUI API KEY
24
24
 
25
25
  - PrimeUI provides this key together with the exported project.
26
- - In practice, it is preconfigured in the exported project's `.mcp.json` for the `primeui` server entry.
26
+ - In linked/exported projects, the key is stored in `.primeui/project.json` under `apiKey`.
27
+ - PrimeUI MCP loads `PRIMEUI_API_KEY` from env first, then falls back to `.primeui/project.json`.
28
+ - `.primeui/project.json` must include:
29
+ - `projectId`
30
+ - `apiKey`
31
+ - `targetProjectPath` (required, relative path such as `"./"` or `"./apps/web"`)
27
32
 
28
33
  ## Your first prompts
29
34
 
@@ -183,6 +188,11 @@ Use the same JSON server configuration shown in Getting started:
183
188
  ## Runtime behavior
184
189
 
185
190
  - PrimeUI MCP uses bearer authentication with `PRIMEUI_API_KEY`.
191
+ - If `PRIMEUI_API_KEY` env is missing, PrimeUI MCP reads `.primeui/project.json` (`apiKey`).
192
+ - Config lookup:
193
+ - if `PRIMEUI_PROJECT_ROOT` is set, MCP reads `${PRIMEUI_PROJECT_ROOT}/.primeui/project.json`;
194
+ - otherwise MCP searches `.primeui/project.json` upward from current working directory.
195
+ - Missing or invalid `targetProjectPath` is treated as a configuration error.
186
196
  - Downloaded archives are validated as ZIP payloads before extraction.
187
197
  - Temporary export files are written under `.primeui/temp/` in user project folder
188
198
 
@@ -191,7 +201,7 @@ Use the same JSON server configuration shown in Getting started:
191
201
  Configure these environment variables for local development:
192
202
 
193
203
  - `PRIMEUI_API_BASE_URL`: PrimeUI API base URL (for example `http://localhost:3020` when testing against local Studio API).
194
- - `PRIMEUI_PROJECT_ROOT`: local project root where PrimeUI temp files are created (defaults to the current working directory if not set).
204
+ - `PRIMEUI_PROJECT_ROOT`: explicit project root override for `.primeui/project.json` and `.primeui/temp/` location.
195
205
 
196
206
  Run MCP Inspector:
197
207