@primeuicom/mcp 0.1.10 → 0.1.12

package/README.md

@@ -18,37 +18,44 @@ Core goals:
 - An MCP client that supports `stdio` servers.
 - A working Node.js runtime (the server is launched via `npx`).
 - A valid PrimeUI API key (`PRIMEUI_API_KEY`).
+- API key format: `pui_<22-char-base64url>`.
 
 ## 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
 
 Try this in your MCP-enabled agent:
 
 ```text
-Use PrimeUI MCP to get my project info, list pages that are ready to export.
+Use PrimeUI MCP to get my project info, list pages that are ready to export. Compare them with my current pages
 ```
 
 Next step:
 
 ```text
-Export [missing pages | XXX page] with PrimeUI MCP and add them to my project.
+Export [X page | XX pages] from PrimeUI and add them to my project.
 ```
 
 ## Tools
 
 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_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>/`.  | `id` (export ID) |
-| `primeui_clear_temp`       | Clears `.primeui/temp/` and recreates baseline temp layout.                          | none             |
+| Tool                       | What it does                                                                                                                                                     | Input                               |
+| -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------- |
+| `primeui_get_project_info` | Returns project metadata and page list, including export readiness and source paths.                                                                             | none                                |
+| `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)                    |
+| `primeui_copy_page`        | Safely copies one page from downloaded export into user project (new files only, conflicts as diff, add-only missing deps).                                      | `originPageSlug`, `actualPageSlug?` |
+| `primeui_clear_temp`       | Clears `.primeui/temp/` and recreates baseline temp layout.                                                                                                      | none                                |
 
 ## Getting started
 
@@ -181,6 +188,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
 
@@ -189,7 +201,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: