@primeuicom/mcp 0.1.11 → 0.1.13

package/README.md

@@ -23,7 +23,12 @@ Core goals:
 ## PrimeUI API KEY
 
 - PrimeUI provides this key together with the exported project.
-- In practice, it is preconfigured in the exported project's `.mcp.json` for the `primeui` server entry.
+- In linked/exported projects, the key is stored in `.primeui/project.json` under `apiKey`.
+- PrimeUI MCP loads `PRIMEUI_API_KEY` from env first, then falls back to `.primeui/project.json`.
+- `.primeui/project.json` must include:
+  - `projectId`
+  - `apiKey`
+  - `targetProjectPath` (required, relative path such as `"./"` or `"./apps/web"`)
 
 ## Your first prompts
 
@@ -39,6 +44,12 @@ Next step:
 Export [X page | XX pages] from PrimeUI and add them to my project.
 ```
 
+Targeted page inspection:
+
+```text
+Inspect PrimeUI page /pricing components and compare them with my local /pricing page.
+```
+
 ## Tools
 
 Available tools:
@@ -46,6 +57,7 @@ Available tools:
 | Tool                       | What it does                                                                                                                                                     | Input                               |
 | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------- |
 | `primeui_get_project_info` | Returns project metadata and page list, including export readiness and source paths.                                                                             | none                                |
+| `primeui_inspect_page`     | Returns details for one page by slug, raw active-variant components (or `null`), and a formatted component report table for local comparison.                    | `pageSlug`                          |
 | `primeui_list_exports`     | Lists existing exports with ID, status, and creation time.                                                                                                       | none                                |
 | `primeui_create_export`    | Starts a new export and returns created export info plus page snapshot.                                                                                          | none                                |
 | `primeui_download_export`  | Downloads and extracts a completed export into `.primeui/temp/exports/<exportId>/` and writes sidecar manifest `.primeui/temp/exports/<exportId>.manifest.json`. | `id` (export ID)                    |
@@ -80,14 +92,12 @@ If your CLI command syntax differs by client version, use the JSON config from G
 <details>
 <summary>Codex CLI</summary>
 
-Use the Codex MCP add command:
+Use the Codex MCP add command to install MCP globally:
 
 ```bash
 codex mcp add primeui -- npx -y @primeuicom/mcp@latest
 ```
 
-Then set `PRIMEUI_API_KEY` in the MCP server env for `primeui`.
-
 </details>
 
 <details>
@@ -169,10 +179,7 @@ Use the same JSON server configuration shown in Getting started:
     "primeui": {
       "type": "stdio",
       "command": "npx",
-      "args": ["-y", "@primeuicom/mcp@latest"],
-      "env": {
-        "PRIMEUI_API_KEY": "your-primeui-api-key"
-      }
+      "args": ["-y", "@primeuicom/mcp@latest"]
     }
   }
 }
@@ -183,6 +190,11 @@ Use the same JSON server configuration shown in Getting started:
 ## Runtime behavior
 
 - PrimeUI MCP uses bearer authentication with `PRIMEUI_API_KEY`.
+- If `PRIMEUI_API_KEY` env is missing, PrimeUI MCP reads `.primeui/project.json` (`apiKey`).
+- Config lookup:
+  - if `PRIMEUI_PROJECT_ROOT` is set, MCP reads `${PRIMEUI_PROJECT_ROOT}/.primeui/project.json`;
+  - otherwise MCP searches `.primeui/project.json` upward from current working directory.
+- Missing or invalid `targetProjectPath` is treated as a configuration error.
 - Downloaded archives are validated as ZIP payloads before extraction.
 - Temporary export files are written under `.primeui/temp/` in user project folder
 
@@ -191,7 +203,7 @@ Use the same JSON server configuration shown in Getting started:
 Configure these environment variables for local development:
 
 - `PRIMEUI_API_BASE_URL`: PrimeUI API base URL (for example `http://localhost:3020` when testing against local Studio API).
-- `PRIMEUI_PROJECT_ROOT`: local project root where PrimeUI temp files are created (defaults to the current working directory if not set).
+- `PRIMEUI_PROJECT_ROOT`: explicit project root override for `.primeui/project.json` and `.primeui/temp/` location.
 
 Run MCP Inspector: