@productmaker/mcp 3.1.0 → 3.1.1

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.
Files changed (5) hide show
  1. package/README.md +45 -21
  2. package/dist/http.js +2959 -1527
  3. package/dist/stdio.js +225 -58
  4. package/dist/ui/meta-upload-app.html +10 -2
  5. package/package.json +4 -2
package/README.md CHANGED
@@ -10,7 +10,9 @@
10
10
 
11
11
  ## Quick install
12
12
 
13
- ### Claude Desktop
13
+ ### Claude Desktop (local-only stdio/direct API; `PM_API_KEY`)
14
+
15
+ This snippet is for local stdio/direct API use only. It is not the hosted OAuth connection.
14
16
 
15
17
  Add this to `~/Library/Application Support/Claude/claude_desktop_config.json` (macOS) or `%APPDATA%\Claude\claude_desktop_config.json` (Windows):
16
18
 
@@ -28,7 +30,9 @@ Add this to `~/Library/Application Support/Claude/claude_desktop_config.json` (m
28
30
 
29
31
  Then restart Claude Desktop. Requires Node.js 18+.
30
32
 
31
- ### Claude Code (CLI)
33
+ ### Claude Code (local-only stdio/direct API; `PM_API_KEY`)
34
+
35
+ This command is for local stdio/direct API use only. It is not the hosted OAuth connection.
32
36
 
33
37
  ```bash
34
38
  claude mcp add productmaker -e PM_API_KEY=pm_live_... -- npx -y @productmaker/mcp@latest
@@ -36,30 +40,43 @@ claude mcp add productmaker -e PM_API_KEY=pm_live_... -- npx -y @productmaker/mc
36
40
 
37
41
  Verify with `claude mcp list`. Use `--scope user` for a global install.
38
42
 
39
- ### ChatGPT, Gemini, claude.ai web (HTTP / SSE)
43
+ ### ChatGPT, Gemini, claude.ai web, Claude Desktop custom connector (hosted OAuth + legacy compatibility)
40
44
 
41
45
  No install needed — connect to the hosted endpoint:
42
46
 
43
47
  - **Server URL:** `https://mcp.productmaker.app/mcp`
44
- - **Header:** `Authorization: Bearer pm_live_...` _(or use the URL-only form below)_
48
+
49
+ Then click **Authenticate**, sign in to Product Maker, and approve access.
50
+
51
+ Existing hosted connections created with a ProductMaker API key remain supported
52
+ during the compatibility period, so users do not lose access or need to rebuild
53
+ their connector immediately. New connections should always use OAuth; once the
54
+ client supports it, replace the saved connection with the clean URL above.
45
55
 
46
56
  In claude.ai: _Settings → Integrations → Add MCP server_.
47
57
  In ChatGPT: _Settings → Connectors → Add custom connector_.
58
+ In Claude Desktop: _Settings → Connectors → Add custom connector_.
48
59
 
49
- ### Claude Desktop (Add custom connector — URL only)
50
-
51
- Claude Desktop's _Settings → Connectors → Add custom connector_ modal only
52
- accepts a URL. Paste your key as a query parameter:
60
+ If your saved connection still uses an API key, it continues to use the latest
61
+ MCP tools through the legacy compatibility path. When convenient, replace it
62
+ with `https://mcp.productmaker.app/mcp` and click **Authenticate**. API keys
63
+ remain supported for local stdio and direct API use.
53
64
 
54
- - **Name:** Product Maker
55
- - **Remote MCP server URL:** `https://mcp.productmaker.app/mcp?apikey=pm_live_...`
65
+ ### Local advanced setup (`PM_API_KEY`)
56
66
 
57
- That's it — no JSON file, no Node install. If you prefer to keep the key out
58
- of the URL, use Claude Code (CLI) or the stdio install above instead.
67
+ `PM_API_KEY` is only for the local stdio server, local/advanced setup, or direct API calls. It is not a credential for the hosted OAuth connector and must not be pasted into the hosted MCP URL. Sign up at [productmaker.app](https://productmaker.app) and create a key (prefix `pm_live_`) at [productmaker.app/account/api-keys](https://productmaker.app/account/api-keys). Full setup walkthrough: [productmaker.app/install](https://productmaker.app/install).
59
68
 
60
- ### Get your API key
69
+ Hosted OAuth runtime reference: [MCP OAuth (Auth0) SOP](../../.agent/SOP/mcp-oauth-auth0.md). End users only provide the hosted URL above; the following variables are operator-managed by the Cloud Run deployment. `loadMcpOAuthConfig` requires every variable in this table explicitly; it does not supply runtime defaults for the hosted OAuth configuration:
61
70
 
62
- Sign up at [productmaker.app](https://productmaker.app) and create a key (prefix `pm_live_`) at [productmaker.app/account/api-keys](https://productmaker.app/account/api-keys). Full setup walkthrough: [productmaker.app/install](https://productmaker.app/install).
71
+ | Variable | Hosted requirement/source |
72
+ | ------------------------- | ---------------------------------------------------------------------- |
73
+ | `MCP_REMOTE_AUTH_MODE` | Required; must be explicitly set to `oauth` |
74
+ | `MCP_AUTH0_ISSUER` | Required HTTPS Auth0 tenant issuer from deployment config |
75
+ | `MCP_AUTH0_AUDIENCE` | Required; must be explicitly set to `https://mcp.productmaker.app/mcp` |
76
+ | `MCP_AUTH0_CLIENT_ID` | Required; Secret Manager (`MCP_AUTH0_CLIENT_ID`) |
77
+ | `MCP_AUTH0_CLIENT_SECRET` | Required; Secret Manager (`MCP_AUTH0_CLIENT_SECRET`) |
78
+ | `AUTH0_AUDIENCE` | Required HTTPS ProductMaker API audience from deployment config |
79
+ | `PM_API_AUDIENCE` | Required HTTPS ProductMaker API audience from deployment config |
63
80
 
64
81
  ## What you can do from your AI assistant
65
82
 
@@ -206,13 +223,20 @@ The `base64` field was removed. MCP JSON-RPC transports truncate large tool argu
206
223
 
207
224
  ## Environment variables
208
225
 
209
- | Var | Default | Required for |
210
- | -------------------- | ------------------------------ | ------------------------------------------ |
211
- | `PM_API_KEY` | — | stdio (required) |
212
- | `PM_API_URL` | `https://api.productmaker.app` | both |
213
- | `PORT` | `8080` | http only |
214
- | `MCP_PROXY_BASE_URL` | `https://mcp.productmaker.app` | http only |
215
- | `PM_PROXY_SECRET` | — | http only (32+ chars; enables asset proxy) |
226
+ | Var | Runtime default | Configuration requirement |
227
+ | ------------------------- | ------------------------------ | --------------------------------------------------- |
228
+ | `PM_API_KEY` | — | required for stdio/local/direct API only |
229
+ | `PM_API_URL` | `https://api.productmaker.app` | optional for both |
230
+ | `PORT` | `8080` | optional for HTTP |
231
+ | `MCP_PROXY_BASE_URL` | `https://mcp.productmaker.app` | optional for HTTP |
232
+ | `PM_PROXY_SECRET` | — | optional for HTTP; 32+ chars enables asset proxy |
233
+ | `MCP_REMOTE_AUTH_MODE` | — | required for hosted HTTP; must be `oauth` |
234
+ | `MCP_AUTH0_ISSUER` | — | required for hosted HTTP OAuth |
235
+ | `MCP_AUTH0_AUDIENCE` | — | required; set to `https://mcp.productmaker.app/mcp` |
236
+ | `MCP_AUTH0_CLIENT_ID` | — | required for hosted HTTP OAuth |
237
+ | `MCP_AUTH0_CLIENT_SECRET` | — | required for hosted HTTP OAuth |
238
+ | `AUTH0_AUDIENCE` | — | required for hosted HTTP OAuth |
239
+ | `PM_API_AUDIENCE` | — | required for hosted HTTP OAuth |
216
240
 
217
241
  ## Keywords
218
242