@primeuicom/mcp 0.1.8 → 0.1.10

package/README.md

@@ -24,6 +24,32 @@ Core goals:
 - 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.
 
+## 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.
+```
+
+Next step:
+
+```text
+Export [missing pages | XXX page] with PrimeUI MCP 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             |
+
 ## Getting started
 
 The setup below works in any MCP client that supports `.mcp.json` with `stdio` command servers (for example: Codex CLI, Cursor, Cline, and other compatible clients).
@@ -152,37 +178,46 @@ Use the same JSON server configuration shown in Getting started:
 
 </details>
 
-## Tools
+## Runtime behavior
 
-Available tools:
+- PrimeUI MCP uses bearer authentication with `PRIMEUI_API_KEY`.
+- Downloaded archives are validated as ZIP payloads before extraction.
+- Temporary export files are written under `.primeui/temp/` in user project folder
 
-| 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             |
+## Local development and testing
 
-## Your first prompt
+Configure these environment variables for local development:
 
-Try this in your MCP-enabled agent:
+- `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).
 
-```text
-Use PrimeUI MCP to get my project info, list pages that are ready to export.
+Run MCP Inspector:
+
+```bash
+pnpm inspect
 ```
 
-Next step:
+This runs `@modelcontextprotocol/inspector` against `tsx src/service.ts`.
+After startup, open the local Inspector URL shown in the terminal (for example `http://127.0.0.1:<port>`) and interact with the PrimeUI MCP tools from the browser UI.
 
-```text
-Export [missing pages | XXX page] with PrimeUI MCP and add them to my project.
-```
+Main scripts:
 
-## Runtime behavior
+- `pnpm dev`: run the MCP server locally via `tsx src/service.ts`.
+- `pnpm test`: run unit tests with Vitest.
+- `pnpm typecheck`: run TypeScript type checks without emitting build artifacts.
+- `pnpm build`: clean `dist/`, bundle the MCP server with `tsup`, and mark `dist/service.js` executable.
+- `pnpm prepack`: run build before packaging/publishing.
 
-- PrimeUI MCP uses bearer authentication with `PRIMEUI_API_KEY`.
-- Downloaded archives are validated as ZIP payloads before extraction.
-- Temporary export files are written under `.primeui/temp/` in user project folder
+### Publish
+
+Publish flow includes:
+
+1. Update the package version (usually a patch bump).
+2. Publish with the `latest` tag:
+
+```bash
+npm publish --tag latest
+```
 
 ## Credits