@masstensor/diagnose 0.8.0 → 0.8.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.
- package/README.md +7 -7
- package/USER_GUIDE.md +32 -717
- package/dist/discover.js +1 -1
- package/dist/mcp.js +16 -3
- package/dist/peer.d.ts +1 -0
- package/dist/peer.js +11 -1
- package/dist/skill-session.js +18 -3
- package/docs/guide/automation.md +184 -0
- package/docs/guide/diagnose.md +93 -0
- package/docs/guide/on-site.md +139 -0
- package/docs/guide/procedures.md +183 -0
- package/docs/guide/reconnect.md +58 -0
- package/docs/guide/troubleshooting.md +77 -0
- package/npm-shrinkwrap.json +2 -2
- package/package.json +2 -1
- package/skills/connect/SKILL.md +8 -2
- package/skills/connect/scripts/run.mjs +1 -1
- package/src/discover.ts +1 -1
- package/src/mcp.ts +16 -4
- package/src/peer.ts +10 -1
- package/src/skill-session.ts +15 -3
- package/test/skill-session.test.ts +20 -6
package/README.md
CHANGED
|
@@ -20,7 +20,7 @@ In v0.8+, press Enter to review tasks and results, choose `a` to approve tasks a
|
|
|
20
20
|
|
|
21
21
|
### Use Diagnose in your existing agent
|
|
22
22
|
|
|
23
|
-
Install once from this GitHub repository. The native Skill uses Diagnose 0.8.
|
|
23
|
+
Install once from this GitHub repository. The native Skill uses Diagnose 0.8.1 and starts the local runtime on demand through Node.js and npm.
|
|
24
24
|
|
|
25
25
|
| Agent | Install | Use |
|
|
26
26
|
| --- | --- | --- |
|
|
@@ -54,7 +54,7 @@ diagnose agent codex
|
|
|
54
54
|
|
|
55
55
|
Short invitations require **0.7.0+ on both endpoints** and the updated relay. They last 30 minutes, tolerate case/spaces/hyphens, and still require local approval. Existing remembered pairings remain valid. See the [protocol design](PAIRING_PROTOCOL.md).
|
|
56
56
|
|
|
57
|
-
For a custom automation client, run `diagnose mcp` as a stdio subprocess. See the [native setup](
|
|
57
|
+
For a custom automation client, run `diagnose mcp` as a stdio subprocess. See the [native setup](docs/guide/diagnose.md#use-diagnose-as-a-native-agent-skill) and [automation setup](docs/guide/automation.md#direct-cli-and-other-mcp-clients) for the two entry points.
|
|
58
58
|
|
|
59
59
|
## Pair once, return later
|
|
60
60
|
|
|
@@ -67,7 +67,7 @@ diagnose agent codex --device alice-pc --skill ./devices/owon.md
|
|
|
67
67
|
# Same options for claude or gemini; --skill is optional.
|
|
68
68
|
```
|
|
69
69
|
|
|
70
|
-
Restart the agent whenever needed without a new code. Pairing persists across probe restarts, but access requires the foreground probe. Task approval remains the default. The user may grant automatic execution and transmission for one hour, or explicitly until revoked. Local `pause`, `permissions ask`, and `unpair` control access. Interrupted modifications are never automatically replayed. See the [pairing guide](
|
|
70
|
+
Restart the agent whenever needed without a new code. Pairing persists across probe restarts, but access requires the foreground probe. Task approval remains the default. The user may grant automatic execution and transmission for one hour, or explicitly until revoked. Local `pause`, `permissions ask`, and `unpair` control access. Interrupted modifications are never automatically replayed. See the [pairing guide](docs/guide/reconnect.md#keep-a-device-paired-for-future-diagnosis).
|
|
71
71
|
|
|
72
72
|
## Start with a device skill or Markdown task
|
|
73
73
|
|
|
@@ -81,13 +81,13 @@ diagnose agent gemini --skill ./devices/owon.md
|
|
|
81
81
|
|
|
82
82
|
A directory is also accepted: `--skill ./skills/my-device` reads its `SKILL.md`. Relative references remain based on that file's original directory. Diagnose snapshots the entry and supplies a startup task that tells the agent to read it and begin, instead of waiting for you to repeat the task. It asks for a pairing code or other missing target details when needed.
|
|
83
83
|
|
|
84
|
-
This is a session task, not a global native-skill installation or an additional permission grant. User approvals and the agent's own tool permissions still apply. Instructions can be sent to your AI provider. See the [guide](
|
|
84
|
+
This is a session task, not a global native-skill installation or an additional permission grant. User approvals and the agent's own tool permissions still apply. Instructions can be sent to your AI provider. See the [guide](docs/guide/procedures.md#start-with-a-device-skill-or-markdown-task) and [examples](https://github.com/zkwasm/diagnose/tree/main/examples/skills).
|
|
85
85
|
|
|
86
86
|
## Keep and improve device knowledge
|
|
87
87
|
|
|
88
88
|
Version 0.6 adds device diagnosis cases, evidence-linked conclusions, reviewed skill drafts, a local versioned library and optional encrypted cross-computer synchronization. Tell your agent to create a case and propose a reusable procedure when useful. Review drafts locally; the agent cannot accept them through MCP. Complete skill bundles can be shared through the relay using a separate private recovery credential. Raw case logs are not synced automatically.
|
|
89
89
|
|
|
90
|
-
See the [case and knowledge guide](
|
|
90
|
+
See the [case and knowledge guide](docs/guide/procedures.md#record-a-device-diagnosis-and-improve-your-procedures) and [security/operations design](KNOWLEDGE_SECURITY.md).
|
|
91
91
|
|
|
92
92
|
## From problem to verified result
|
|
93
93
|
|
|
@@ -97,7 +97,7 @@ See the [case and knowledge guide](USER_GUIDE.md#record-a-device-diagnosis-and-i
|
|
|
97
97
|
4. **Act with permission:** use approved commands, scripts, or file changes to carry out the fix.
|
|
98
98
|
5. **Verify and hand off:** repeat the original check, summarize changes, and identify any remaining issues.
|
|
99
99
|
|
|
100
|
-
This is an agent-guided workflow using the existing tools and permission model. Diagnose does not automatically prove a repair succeeded or roll back arbitrary changes. See the [troubleshooting workflow](
|
|
100
|
+
This is an agent-guided workflow using the existing tools and permission model. Diagnose does not automatically prove a repair succeeded or roll back arbitrary changes. See the [troubleshooting workflow](docs/guide/diagnose.md#from-a-reported-problem-to-a-verified-result).
|
|
101
101
|
|
|
102
102
|
## Remote tools
|
|
103
103
|
|
|
@@ -125,7 +125,7 @@ No device-specific integration is required in the probe. An approved script can
|
|
|
125
125
|
- Local audit logs record decisions, targets, hashes, byte counts, and outcomes. Encrypted history keeps exact task requests, finite collected results, approvals, and send events: use `diagnose history`, `diagnose show ID`, and `diagnose cleanup --days 0`. History and resource journals each have a 256 MiB / 2,000-record budget and seven-day inactive retention. They do not reconstruct every side effect of an arbitrary program. Changes are not automatically rolled back.
|
|
126
126
|
- `permissions ask`, `cancel`, and `Ctrl+C` are local controls. Data already transmitted cannot be recalled.
|
|
127
127
|
|
|
128
|
-
Read the [user guide](
|
|
128
|
+
Read the [user guide](docs/guide/troubleshooting.md#security-and-local-data) before operating a session. The protocol has not received an independent security audit.
|
|
129
129
|
|
|
130
130
|
## Development
|
|
131
131
|
|