@postman/postman-plugin 0.2.1 → 0.2.2

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
@@ -169,40 +169,41 @@ external systems need access, the same mock can become a durable hosted URL
169
169
  without rebuilding it in another tool.
170
170
 
171
171
 
172
- ## Telemetry
172
+ ## How Postman builds context
173
173
 
174
- Some Postman CLI commands report usage analytics by default. Where supported,
175
- you can disable reporting for an individual command with
176
- `--no-report-events`. `postman application test` uses
177
- `--report-events=false` instead.
174
+ Work done in a Postman folder produces artifacts: collection runs, lint
175
+ results, request history, mock deployments. When that folder is connected to a
176
+ Postman workspace, after `postman init`, those artifacts are
177
+ published to it as they are produced. The workspace is
178
+ where a teammate, a reviewer, or another agent can see what the agent actually
179
+ did.
178
180
 
179
- What is sent by default:
181
+ What each command contributes to the connected workspace:
180
182
 
181
- | Command | Data sent |
183
+ | Command | What it publishes |
182
184
  | --- | --- |
183
- | `postman collection run` | Run analytics and run history |
184
- | `postman application test` | Run results and analytics |
185
- | `postman spec lint` | Lint analytics, including violation counts and pass/fail |
186
- | `postman workspace push` | Push analytics |
187
- | `postman runner start` | Runner analytics |
188
- | `postman flows run` | Flow-run analytics |
189
- | `postman request` | Request analytics |
190
-
191
- Important limits:
192
-
193
- - `postman collection run --no-report-events` disables analytics but does not
194
- disable run-history uploads.
195
- - `postman init` makes richer reporting opt-in with `--report-events`; it does
196
- not accept `--report-events=false`.
197
- - The CLI also sends a minimal, unauthenticated event indicating that certain
198
- commands ran. Reporting flags do not disable these client events. They are
199
- emitted by `collection run`, `spec lint`, `workspace push`, `init`, the
200
- `mock` commands, and `performance run` in the US region; other regions,
201
- including the EU, do not emit them.
202
- - The plugin registers Postman's hosted MCP server as a fallback when the CLI
203
- cannot run. MCP tool calls reach Postman and are not controlled by CLI
204
- reporting flags; avoiding that traffic requires not installing the MCP
205
- server.
185
+ | `postman collection run` | Run results and run history |
186
+ | `postman application test` | Test run results |
187
+ | `postman spec lint` | Lint results, including violation counts and pass/fail |
188
+ | `postman workspace push` | The local workspace contents |
189
+ | `postman runner start` | Runner processing and health activity |
190
+ | `postman flows run` | Flow run results |
191
+ | `postman request` | Agent's API interaction activity |
192
+
193
+
194
+ Publishing happens by default. To change this workflow, you can set
195
+ `--report-events=false` per invocation.
196
+
197
+ ### Anonymous usage counts
198
+
199
+ The CLI records command usage surface — a minimal,
200
+ unauthenticated count with no workspace, user, or payload attached.
201
+
202
+ ### The MCP fallback
203
+
204
+ The plugin registers Postman's hosted MCP server as a fallback for when the CLI
205
+ cannot run. MCP tool calls reach Postman by design and are not governed by the
206
+ CLI flags above; skip installing the MCP server if you do not want that path.
206
207
 
207
208
  ## License
208
209
 
package/mcp.pi.json CHANGED
@@ -6,8 +6,8 @@
6
6
  "description": "Postman workspaces, collections, specs, environments, mocks and monitors",
7
7
  "headers": {
8
8
  "X-Source": "postman-pi-plugin",
9
- "X-Plugin-Version": "0.2.1",
10
- "User-Agent": "postman-pi-plugin/0.2.1"
9
+ "X-Plugin-Version": "0.2.2",
10
+ "User-Agent": "postman-pi-plugin/0.2.2"
11
11
  }
12
12
  }
13
13
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@postman/postman-plugin",
3
- "version": "0.2.1",
3
+ "version": "0.2.2",
4
4
  "description": "Postman's API engineering skills for coding agents: a Pi package, and an npx installer that sets up Claude Code, Codex, Cursor, Kimi Code, Factory Droid, OpenCode and Pi.",
5
5
  "type": "module",
6
6
  "license": "Apache-2.0",
@@ -99,8 +99,9 @@ Postman's cloud. Extra
99
99
  flags cover the runner's own networking: `--region eu` for EU residency,
100
100
  `--proxy`/`--egress-proxy`/`--egress-proxy-authz-url` for outbound routing,
101
101
  `--ssl-extra-ca-certs` for a private CA, and `--metrics`/`--metrics-port`
102
- for a health-check endpoint. Analytics are sent by default; `--no-report-events`
103
- opts out. `runner list` shows the team's registered self-hosted runners —
102
+ for a health-check endpoint. Runner activity is published to the connected
103
+ workspace by default; `--no-report-events` keeps it local. `runner list`
104
+ shows the team's registered self-hosted runners —
104
105
  feed an id from here into `monitor create/update --runner` or `monitor list
105
106
  --runner`. `runner regions` lists the Postman-region and private-runner
106
107
  values valid for `--runner` on `monitor create`/`update`, including a
@@ -73,9 +73,10 @@ answering "did my app's actual calls conform to the contract," not "does
73
73
  this endpoint respond correctly." `--capture-only` skips the matching step
74
74
  entirely and just exports what was captured as a new v3 collection,
75
75
  organized by host — a way to bootstrap a collection from real traffic
76
- rather than authoring one from scratch. Results upload to Postman
77
- automatically after each run; `--report-events=false` skips that for a run
78
- that shouldn't be recorded.
76
+ rather than authoring one from scratch. Results are published to the connected
77
+ workspace after each run, so the evidence of the run outlives the terminal
78
+ session; `--report-events=false` keeps a run local when it shouldn't be
79
+ recorded.
79
80
 
80
81
  ## Critical Rules
81
82
 
@@ -80,7 +80,7 @@ execution and reporting. Takes the path positionally; a bad path fails with
80
80
  | `-x, --suppress-exit-code` | Overrides the run's exit code. Defeats CI gating. |
81
81
  | `--verbose` | Per-request detail: method, URL, assertions. |
82
82
  | `--no-truncate` | Full output, no truncated long values. |
83
- | `--no-report-events` | Don't send analytics. `--report-events` exists for compatibility; analytics are on by default. |
83
+ | `--no-report-events` | Keep the run local instead of publishing results to the connected workspace. |
84
84
 
85
85
  ### BETA: dataset iteration
86
86