@modootoday/pmcp 0.18.0 → 0.18.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/.agents/plugins/marketplace.json +1 -1
- package/.claude-plugin/marketplace.json +1 -1
- package/.claude-plugin/plugin.json +2 -2
- package/.mcp.json +1 -1
- package/CHANGELOG.md +112 -20
- package/CONTRIBUTING.md +71 -0
- package/README.md +98 -206
- package/SECURITY.md +17 -1
- package/dist/{apply-4IGTXOCQ.js → apply-JUTGS5WZ.js} +11 -11
- package/dist/{broadcast-3RY3OZGY.js → broadcast-CBMVOV3G.js} +4 -4
- package/dist/{chunk-SG5TPMKH.js → chunk-26WLNWDG.js} +2 -2
- package/dist/{chunk-ELAGZ635.js → chunk-2FIV63WC.js} +5 -5
- package/dist/{chunk-JUXNIXN4.js → chunk-3FCFAQDG.js} +2 -2
- package/dist/{chunk-EJBZGIDK.js → chunk-3IDXEV5E.js} +3 -3
- package/dist/chunk-65KAQSJP.js +7 -0
- package/dist/{chunk-665TA55Z.js → chunk-7HFIGCSL.js} +2 -2
- package/dist/{chunk-R4L6LJJ2.js → chunk-7UCZAN4J.js} +2 -2
- package/dist/{chunk-J6QLLQVL.js → chunk-A7VF7A35.js} +5 -5
- package/dist/{chunk-NZS5CD72.js → chunk-AJ4VXM2U.js} +20 -4
- package/dist/{chunk-25GHX674.js → chunk-D77IRGHO.js} +6 -6
- package/dist/{chunk-4VCC2NXE.js → chunk-DMZHQZ7P.js} +2 -2
- package/dist/{chunk-Q65R3XKX.js → chunk-EAWPJHJ7.js} +2 -2
- package/dist/{chunk-PLX3BOOS.js → chunk-F5QYZK7E.js} +2 -2
- package/dist/{chunk-YMHUM7AV.js → chunk-F5XMGOOX.js} +7 -1
- package/dist/{chunk-7BLPN3W6.js → chunk-FENOGX3U.js} +2 -2
- package/dist/{chunk-N5AQ3PP7.js → chunk-I2ZP2PSA.js} +5 -5
- package/dist/{chunk-UOCLRM7P.js → chunk-IG33DXLT.js} +16 -16
- package/dist/{chunk-RK4PYD7L.js → chunk-LBXO4VPG.js} +2 -2
- package/dist/{chunk-BVCTKPT3.js → chunk-LMUBBIE2.js} +2 -2
- package/dist/{chunk-Z4HRRXRF.js → chunk-LTZH5E3G.js} +6 -5
- package/dist/{chunk-MWFOUBFC.js → chunk-LW4TG7EL.js} +2 -2
- package/dist/{chunk-LAZQBMAU.js → chunk-NLEXKE7U.js} +3 -3
- package/dist/{chunk-ZH6R642Z.js → chunk-PKODFR5F.js} +2 -2
- package/dist/{chunk-IGYRMM62.js → chunk-QEF7EK3T.js} +2 -2
- package/dist/{chunk-MM2Y43LC.js → chunk-RPQOBHVU.js} +2 -2
- package/dist/{chunk-3NYG4SGU.js → chunk-TXQ7L33K.js} +3 -3
- package/dist/{chunk-PWSJJXLQ.js → chunk-VMHUEOT5.js} +8 -8
- package/dist/{chunk-65ZHM5RH.js → chunk-VRPMYPZU.js} +9 -9
- package/dist/{cli-VYCQJZ5X.js → cli-MI4ZCAZ3.js} +9 -9
- package/dist/{cli-ZTCBSDW4.js → cli-ZN7ZVDEZ.js} +3 -3
- package/dist/cli.js +4 -4
- package/dist/{completion-E7RRG3ZT.js → completion-ILSRB3LW.js} +3 -3
- package/dist/{diagnostics-XXH4FLUG.js → diagnostics-XKXVVQWH.js} +6 -6
- package/dist/{doctor-ZIOESU3N.js → doctor-O2E63YGO.js} +13 -13
- package/dist/{entry-ZNFCTDVE.js → entry-X6CSYQRQ.js} +10 -10
- package/dist/{exec-mcp-X6372BLE.js → exec-mcp-2PMWBPD7.js} +8 -8
- package/dist/{harness-F2XFDYXF.js → harness-L2KSI2ZB.js} +5 -5
- package/dist/harness-launch-gate.js +4 -4
- package/dist/harness-worker.js +6 -6
- package/dist/hook-body.js +7 -6
- package/dist/{hooks-FYE2L5RW.js → hooks-BHTA44X7.js} +3 -3
- package/dist/{host-GRY3VAHH.js → host-UIZAXXQH.js} +7 -7
- package/dist/{host-X6BR6X4O.js → host-UWK754BW.js} +20 -10
- package/dist/{host-run-GCA6H6SR.js → host-run-BI2OTZDZ.js} +5 -5
- package/dist/http.js +1 -1
- package/dist/{import-mcp-2TTBPVLY.js → import-mcp-GPKJI7DI.js} +6 -6
- package/dist/index.d.ts +1 -1
- package/dist/index.js +13 -13
- package/dist/{init-627KFXTG.js → init-3C2Y7BNJ.js} +2 -2
- package/dist/{invoke-LW22Z6ET.js → invoke-44CJRVMK.js} +8 -8
- package/dist/{list-NGMSQ5SH.js → list-WL6L4J5H.js} +8 -8
- package/dist/{logout-6CSHUWWE.js → logout-F5EJ5MOU.js} +7 -7
- package/dist/{logs-SPB6AANY.js → logs-TBUA4UWU.js} +4 -4
- package/dist/{mailbox-7BV54Q4R.js → mailbox-BMTZOSZ7.js} +4 -4
- package/dist/{mainline-JQTTYJMI.js → mainline-KAD2ERLP.js} +2 -2
- package/dist/{mcp-2DKVU3SW.js → mcp-235QZN2A.js} +2 -2
- package/dist/{mcp-V23HC3LB.js → mcp-FJ2UQ4RH.js} +2 -2
- package/dist/{pause-FFAYRBWI.js → pause-7LILUVGL.js} +4 -4
- package/dist/{project-FY62G55N.js → project-5YV5CUEG.js} +4 -4
- package/dist/{resume-UU4HZIUP.js → resume-26VFAAMH.js} +4 -4
- package/dist/{run-OGA3P7FC.js → run-3AXTZSR7.js} +7 -7
- package/dist/{run-HALGEJNJ.js → run-3SOVRQIA.js} +4 -4
- package/dist/{serve-NBKT5BKY.js → serve-DQMKTFIV.js} +3 -3
- package/dist/{start-login-UIQYQBMC.js → start-login-YTZV6KMF.js} +7 -7
- package/dist/{status-NOOHW5WA.js → status-MROQ7WR7.js} +7 -7
- package/dist/{status-VHODZPXB.js → status-RO55QPKV.js} +4 -4
- package/dist/{status-XQANBVXW.js → status-UME2L33L.js} +11 -11
- package/dist/stdio.js +2 -2
- package/dist/{sweep-64JDCGK6.js → sweep-35LGQTTO.js} +4 -4
- package/dist/{test-MKAXFJOL.js → test-AGZOJLRZ.js} +7 -7
- package/dist/{tui-MWKAXE4K.js → tui-G5LLWCSV.js} +5 -5
- package/dist/{unbroadcast-KPUEFLZD.js → unbroadcast-5QNGAJR2.js} +4 -4
- package/dist/{validate-5GZ5YWNA.js → validate-IU52H2IC.js} +2 -2
- package/dist/{worker-RQ575EJL.js → worker-QZ5T6LJD.js} +8 -8
- package/docs/authoring.md +82 -0
- package/docs/browser-and-desktop.md +46 -0
- package/docs/commands.md +325 -0
- package/docs/compare.md +35 -0
- package/docs/compatibility.md +55 -0
- package/docs/embeddings.md +1 -1
- package/docs/getting-started.md +105 -0
- package/docs/git-workflow.md +60 -0
- package/docs/glossary.md +31 -0
- package/docs/hooks.md +264 -0
- package/docs/install.md +72 -0
- package/docs/library-skills.md +132 -0
- package/docs/mailbox.md +16 -5
- package/docs/project-configuration.md +51 -386
- package/docs/sessions.md +64 -0
- package/docs/skills.md +4 -45
- package/docs/terminal-harness.md +26 -21
- package/docs/terminal-workspace.md +4 -13
- package/gemini-extension.json +2 -2
- package/mcp.json +1 -1
- package/package.json +8 -6
- package/plugin.json +2 -2
- package/plugins/pmcp/.claude-plugin/plugin.json +2 -2
- package/plugins/pmcp/.mcp.json +1 -1
- package/plugins/pmcp/gemini-extension.json +2 -2
- package/plugins/pmcp/mcp.json +1 -1
- package/plugins/pmcp/mod/sessions/types.ts +1 -1
- package/plugins/pmcp/plugin.json +2 -2
- package/plugins/pmcp/skills/headless-agents-ci-scaffold/SKILL.md +12 -11
- package/plugins/pmcp/skills/package-skill-catalog/SKILL.md +0 -4
- package/plugins/pmcp/skills/pmcp-browser/SKILL.md +27 -0
- package/plugins/pmcp/skills/pmcp-desktop/SKILL.md +25 -0
- package/plugins/pmcp/skills/pmcp-project-init/SKILL.md +19 -11
- package/plugins/pmcp/skills/pmcp-sessions-and-git/SKILL.md +20 -28
- package/plugins/pmcp/skills/skill-package-scaffold/SKILL.md +4 -3
- package/schema/catalog-v1.json +36 -7
- package/schema/library.json +40 -8
- package/schema/marketplace-manifest.json +19 -5
- package/schema/plugin-manifest.json +6 -2
- package/schema/skill-frontmatter.json +33 -7
- package/schema/skill-metadata-core.json +26 -5
- package/skills/headless-agents-ci-scaffold/SKILL.md +12 -11
- package/skills/package-skill-catalog/SKILL.md +0 -4
- package/skills/pmcp-browser/SKILL.md +27 -0
- package/skills/pmcp-desktop/SKILL.md +25 -0
- package/skills/pmcp-project-init/SKILL.md +19 -11
- package/skills/pmcp-sessions-and-git/SKILL.md +20 -28
- package/skills/skill-package-scaffold/SKILL.md +4 -3
- package/dist/chunk-E7OOHLQR.js +0 -7
- package/docs/manual-library-skills.md +0 -74
|
@@ -612,7 +612,7 @@
|
|
|
612
612
|
},
|
|
613
613
|
{
|
|
614
614
|
"name": "pmcp",
|
|
615
|
-
"version": "0.18.
|
|
615
|
+
"version": "0.18.2",
|
|
616
616
|
"description": "Find package skills and use native runtime project configuration.",
|
|
617
617
|
"source": { "source": "local", "path": "./plugins/pmcp" },
|
|
618
618
|
"policy": { "installation": "AVAILABLE", "authentication": "ON_USE" },
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "pmcp",
|
|
3
|
-
"version": "0.18.
|
|
3
|
+
"version": "0.18.2",
|
|
4
4
|
"description": "Find package skills and use native runtime project configuration.",
|
|
5
5
|
"author": { "name": "modootoday" },
|
|
6
6
|
"license": "Elastic-2.0",
|
|
7
7
|
"repository": "https://github.com/modootoday/pmcp",
|
|
8
|
-
"homepage": "https://pmcp.build/
|
|
8
|
+
"homepage": "https://pmcp.build/"
|
|
9
9
|
}
|
package/.mcp.json
CHANGED
package/CHANGELOG.md
CHANGED
|
@@ -1,60 +1,152 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 0.18.2 - 2026-10-21
|
|
4
|
+
|
|
5
|
+
The first release after 0.18.0. v0.18.1 was tagged but never published to npm: its
|
|
6
|
+
publish step failed on a path npm read as a GitHub shorthand, before any package was
|
|
7
|
+
uploaded. Everything below ships in 0.18.2.
|
|
8
|
+
|
|
9
|
+
### New
|
|
10
|
+
|
|
11
|
+
- `pmcp sessions send --to worktree:<path>` addresses the session in a linked
|
|
12
|
+
worktree; `desk:<path>` keeps working. Hook messages say "linked worktree"
|
|
13
|
+
and "being delivered". (152e489)
|
|
14
|
+
- The pmcp plugin ships the pmcp-browser and pmcp-desktop skills, so agents
|
|
15
|
+
learn the two MCP servers where they are installed. (cde23e7)
|
|
16
|
+
- The skill tools say when to call them and what to call next. (6b71a00)
|
|
17
|
+
- New pages: Getting started, Run several agents, Command reference,
|
|
18
|
+
Compatibility and Glossary, as Markdown in the npm package and on
|
|
19
|
+
pmcp.build. (446fb90, 4f80203)
|
|
20
|
+
|
|
21
|
+
- The configuration guide is split into task pages: Hooks, Git workflow,
|
|
22
|
+
Browser and desktop, and Library skills (which says how library skills are
|
|
23
|
+
matched and the evidence each carries); the pmcp.toml reference keeps
|
|
24
|
+
every table. Installation, Authoring and How it compares are Markdown too.
|
|
25
|
+
(d29f4de, 5280cfc)
|
|
26
|
+
- The JSON schemas in `schema/` carry a title and a description. (1f83e4c)
|
|
27
|
+
|
|
28
|
+
### Fixes
|
|
29
|
+
|
|
30
|
+
- The release workflow hands npm explicit `./` paths; 0.18.1's publish failed
|
|
31
|
+
because npm read `packed/<name>.tgz` as a GitHub `owner/repo` shorthand.
|
|
32
|
+
(33d9383)
|
|
33
|
+
- Every release mode runs the same publish script: dry-run and bootstrap
|
|
34
|
+
rehearse it with `npm publish --dry-run`, a failed publish reports which
|
|
35
|
+
packages reached npm with the recovery steps, and a rerun skips what is
|
|
36
|
+
already published. (e963375)
|
|
37
|
+
- pmcp-browser's `close` leaves no browser process behind even when Chromium
|
|
38
|
+
starts a helper while shutting down. (164cfb5)
|
|
39
|
+
- smol-toml 1.9.0 fixes a quadratic-time `parse()` on documents with many key
|
|
40
|
+
lines (GHSA-r4xh-jqrq-34v2, moderate), which `npm audit` reported for 0.18.0.
|
|
41
|
+
(dea8fc1)
|
|
42
|
+
- The release and cross-OS workflows build the Intel macOS binaries on
|
|
43
|
+
`macos-15-intel`; GitHub retired the macOS 13 image, so the job never started.
|
|
44
|
+
- The arm64 macOS binaries and tests run on `macos-15`; GitHub marks the macOS
|
|
45
|
+
14 image deprecated.
|
|
46
|
+
- Links to a section of a guide page on pmcp.build open at that section;
|
|
47
|
+
guide headings had no anchors. (446fb90)
|
|
48
|
+
|
|
49
|
+
- The pmcp plugin for Claude Code and Codex and the Gemini extension start
|
|
50
|
+
the pmcp release they ship in; in 0.18.0 they still started 0.13.1.
|
|
51
|
+
(0840cdc)
|
|
52
|
+
- `pmcp harness host up` and `host unit` stop with `platform_unsupported` on
|
|
53
|
+
macOS instead of failing inside `systemd-run`. (b2d1e8d)
|
|
54
|
+
- The pmcp-project-init and skill-package-scaffold skills describe
|
|
55
|
+
`pmcp init` and `[catalog.validation]` correctly. (44cd959)
|
|
56
|
+
- The pmcp.build pages no longer say the harness needs tmux, and the commands
|
|
57
|
+
page lists `pmcp harness host` and `pmcp harness mcp`. (7315b23)
|
|
58
|
+
|
|
59
|
+
## 0.18.1 - 2026-10-21
|
|
60
|
+
|
|
61
|
+
Tagged, never published to npm; its changes ship in 0.18.2.
|
|
62
|
+
|
|
3
63
|
## 0.18.0
|
|
4
64
|
|
|
5
65
|
This release replaces tmux with pmcp's own terminal host and adds project
|
|
6
66
|
hooks, sessions and two MCP servers for browser and desktop use. As a 0.x minor
|
|
7
|
-
release it contains breaking changes.
|
|
67
|
+
release it contains breaking changes. (29bad53)
|
|
68
|
+
|
|
69
|
+
### Upgrading from 0.17
|
|
70
|
+
|
|
71
|
+
Stop what 0.17 started before you upgrade; 0.18 does not read tmux groups or
|
|
72
|
+
views. With the 0.17 release that created them:
|
|
73
|
+
|
|
74
|
+
```sh
|
|
75
|
+
npx @modootoday/pmcp@0.17.4 tui recovery # a workspace from bare pmcp: prints groupFile and generation
|
|
76
|
+
npx @modootoday/pmcp@0.17.4 tui close --view "$VIEW_FILE"
|
|
77
|
+
npx @modootoday/pmcp@0.17.4 harness group inspect --group-file "$GROUP_FILE" # any other group: prints the generation
|
|
78
|
+
npx @modootoday/pmcp@0.17.4 harness group stop --group-file "$GROUP_FILE" --generation "$GENERATION"
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
Then upgrade and start a new workspace with `pmcp tui --new` (plain `pmcp`
|
|
82
|
+
once no 0.17 checkpoint is left). Scripts that called the removed
|
|
83
|
+
`pmcp tui` view operations now get a usage error (exit 2).
|
|
84
|
+
|
|
85
|
+
### Known issues
|
|
86
|
+
|
|
87
|
+
- macOS binaries are unsigned. They run when installed through npm.
|
|
88
|
+
(`scripts/platform-packages.mjs`)
|
|
89
|
+
- Windows is not supported: the harness, `pmcp tui` and pmcp-pty stop with
|
|
90
|
+
`platform_unsupported`. (`src/harness/platform.ts`)
|
|
91
|
+
- `pmcp harness host up` and `host unit` need Linux with a user systemd
|
|
92
|
+
manager. In 0.18.0 they fail inside `systemd-run` on macOS; see Unreleased.
|
|
93
|
+
(`src/harness/host/daemon.ts`)
|
|
94
|
+
- pmcp-browser and pmcp-desktop ship for Linux only.
|
|
95
|
+
(`scripts/platform-packages.mjs`)
|
|
96
|
+
- The plugin for Claude Code and Codex and the Gemini extension start pmcp
|
|
97
|
+
0.13.1 for skill search; install the CLI for 0.18 features. Fixed in
|
|
98
|
+
Unreleased. (`scripts/marketplace/manifests.mjs`)
|
|
99
|
+
- `[sessions.roles]` applies to Claude Code only; Codex sends no agent type.
|
|
100
|
+
(`docs/project-configuration.md`)
|
|
8
101
|
|
|
9
102
|
### Breaking
|
|
10
103
|
|
|
11
104
|
- tmux is no longer used or required. Native sessions run in pmcp-pty, a PTY
|
|
12
105
|
host with one daemon per harness group, and `pmcp tui` draws the workspace
|
|
13
106
|
with pmcp-tui. Groups and workspaces created by 0.17 and earlier are not
|
|
14
|
-
migrated:
|
|
15
|
-
one.
|
|
107
|
+
migrated: stop them as in Upgrading from 0.17, then start a new one. (29bad53: `src/harness/adapters/terminal/`)
|
|
16
108
|
- The `pmcp tui` view operations (`create`, `open`, `close`, `stop` and the
|
|
17
109
|
others taking `--view`) and their options are removed. `pmcp tui`,
|
|
18
|
-
`plan`, `recovery`, `doctor` and `start-worker` remain.
|
|
110
|
+
`plan`, `recovery`, `doctor` and `start-worker` remain. (29bad53: `src/commands/tui/invocation.ts`)
|
|
19
111
|
- Harness session records hold the pmcp-pty session, host instance and
|
|
20
|
-
process id instead of tmux pane identities.
|
|
112
|
+
process id instead of tmux pane identities. (29bad53: `src/harness/contracts.ts`)
|
|
21
113
|
- The terminal workspace and harness need Linux (glibc 2.35 or later) or
|
|
22
114
|
macOS. On Linux a user systemd manager caps each session's memory; macOS
|
|
23
|
-
runs sessions uncapped. Windows is not supported yet.
|
|
115
|
+
runs sessions uncapped. Windows is not supported yet. (29bad53: `src/harness/platform.ts`)
|
|
24
116
|
|
|
25
117
|
### Terminal host and workspace
|
|
26
118
|
|
|
27
119
|
- pmcp-pty hosts native runtimes with guarded writes, per-runtime screen
|
|
28
120
|
profiles, turn detection from hook events, and a lease that refuses any
|
|
29
|
-
other writer while someone holds control.
|
|
121
|
+
other writer while someone holds control. (29bad53: `crates/pmcp-pty/`)
|
|
30
122
|
- pmcp-tui shows main, a worker dock and a coordination panel, with explicit
|
|
31
|
-
control, history and mailbox views, read only until you take control.
|
|
123
|
+
control, history and mailbox views, read only until you take control. (29bad53: `crates/pmcp-tui/`)
|
|
32
124
|
- npm installs pmcp-pty and pmcp-tui through a platform package
|
|
33
125
|
(`@modootoday/pmcp-<os>-<cpu>`) for Linux and macOS on x64 and arm64.
|
|
34
126
|
`PMCP_PTY_BIN` and `PMCP_TUI_BIN` override it. The macOS binaries are
|
|
35
|
-
unsigned.
|
|
36
|
-
- `[host]` in pmcp.toml declares which tool dialogs
|
|
37
|
-
|
|
38
|
-
- `pmcp harness host up`, `down` and `unit` manage a host for the project.
|
|
127
|
+
unsigned. (29bad53: `scripts/platform-packages.mjs`)
|
|
128
|
+
- `[host]` in pmcp.toml declares which tool dialogs a host you approved may
|
|
129
|
+
answer; login, authentication and trust prompts are never answered. (29bad53: `src/project/host-spec.ts`)
|
|
130
|
+
- `pmcp harness host up`, `down` and `unit` manage a host for the project. (29bad53: `src/commands/harness/host.ts`)
|
|
39
131
|
|
|
40
132
|
### Browser and desktop
|
|
41
133
|
|
|
42
134
|
- pmcp-browser runs an isolated, headless Chromium over MCP that reaches
|
|
43
135
|
public sites only. pmcp-desktop drives an Xvfb desktop through screenshots
|
|
44
136
|
and input. Both ship in the Linux platform package; name them bare in
|
|
45
|
-
`[mcp.<alias>] command` and `pmcp project` resolves the installed binary.
|
|
137
|
+
`[mcp.<alias>] command` and `pmcp project` resolves the installed binary. (29bad53: `crates/pmcp-plugin-browser-use/`, `crates/pmcp-plugin-computer-use/`)
|
|
46
138
|
|
|
47
139
|
### Hooks, sessions and project configuration
|
|
48
140
|
|
|
49
141
|
- `[hooks]` compiles to one hook bundle projected for Claude Code, Codex,
|
|
50
142
|
Gemini CLI, Grok, Antigravity and opencode, with guards for secrets,
|
|
51
|
-
staging, pushes and worktrees.
|
|
52
|
-
- Sessions:
|
|
53
|
-
|
|
143
|
+
staging, pushes and worktrees. (29bad53: `src/hooks/`)
|
|
144
|
+
- Sessions: see who else works in the repository (`pmcp sessions status`),
|
|
145
|
+
pause them, send addressed messages and wake idle sessions. (29bad53: `src/sessions/`)
|
|
54
146
|
- `pmcp logs` reads the project's JSONL logs, with rotation and retention set
|
|
55
|
-
by `[logging]`.
|
|
56
|
-
- `pmcp git` creates and syncs worktrees and delivers commits to the mainline.
|
|
57
|
-
- `pmcp mcp` shares remote MCP authentication across runtimes.
|
|
147
|
+
by `[logging]`. (29bad53: `src/logging/`)
|
|
148
|
+
- `pmcp git` creates and syncs worktrees and delivers commits to the mainline. (29bad53: `src/git/`)
|
|
149
|
+
- `pmcp mcp` shares remote MCP authentication across runtimes. (29bad53: `src/mcp-auth/`)
|
|
58
150
|
- `pmcp status`, `pmcp init`, `pmcp hooks` and `pmcp completion` are new;
|
|
59
151
|
`[permissions.claude]`, `[catalog.validation]` and declared marketplaces
|
|
60
|
-
are projected from pmcp.toml.
|
|
152
|
+
are projected from pmcp.toml. (29bad53: `src/commands/specs/inspection.ts`, `src/project/permissions.ts`)
|
package/CONTRIBUTING.md
ADDED
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
# Contributing to pmcp
|
|
2
|
+
|
|
3
|
+
pmcp is a TypeScript package (the CLI, MCP server and library, built with tsup) with five Rust
|
|
4
|
+
crates under `crates/` for the native binaries. Rules that agents and people both follow when
|
|
5
|
+
editing are in `AGENTS.md` in the repository; this page is the procedure.
|
|
6
|
+
|
|
7
|
+
## Set up
|
|
8
|
+
|
|
9
|
+
Node.js 22 or later and Bun 1.3 or later. Rust stable for the crates.
|
|
10
|
+
|
|
11
|
+
```sh
|
|
12
|
+
bun install --frozen-lockfile
|
|
13
|
+
npm run build
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
## Check a change
|
|
17
|
+
|
|
18
|
+
TypeScript, from the repository root:
|
|
19
|
+
|
|
20
|
+
```sh
|
|
21
|
+
npm run typecheck
|
|
22
|
+
npm test
|
|
23
|
+
npm run format:check
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
Use the package's typecheck and test scripts for code changes. Documentation changes need
|
|
27
|
+
link, packaging and formatting checks; avoid rebuilding unrelated runtime artifacts.
|
|
28
|
+
|
|
29
|
+
Rust, in each crate you touched (each crate builds on its own):
|
|
30
|
+
|
|
31
|
+
```sh
|
|
32
|
+
cargo fmt --check
|
|
33
|
+
cargo clippy --all-targets -j 2
|
|
34
|
+
cargo test -j 2
|
|
35
|
+
cargo check --all-targets --target aarch64-apple-darwin # code behind cfg for macOS
|
|
36
|
+
cargo check --all-targets --target x86_64-pc-windows-gnu # and for Windows
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
pmcp-pty's tests need `bash` and `python3` on PATH. The browser and desktop plugins' tests start
|
|
40
|
+
a real Chromium and Xvfb; their `doctor` command says what is missing. No test starts a real
|
|
41
|
+
agent runtime.
|
|
42
|
+
|
|
43
|
+
## Documentation
|
|
44
|
+
|
|
45
|
+
- Keep README.md focused on installation, supported features and user workflows.
|
|
46
|
+
- Keep detailed public configuration and integration examples in docs/.
|
|
47
|
+
- Keep agent instructions in AGENTS.md files next to the code they govern.
|
|
48
|
+
|
|
49
|
+
`docs/*.md` are the sources of the guide pages on pmcp.build and ship in the npm package.
|
|
50
|
+
Format them with prettier, then rebuild and check the site:
|
|
51
|
+
|
|
52
|
+
```sh
|
|
53
|
+
npx prettier --write docs/<page>.md
|
|
54
|
+
bun run site:build
|
|
55
|
+
npm run docs:check
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
## Generated files
|
|
59
|
+
|
|
60
|
+
Edit the source, then regenerate; the checks fail on a generated file edited by hand.
|
|
61
|
+
|
|
62
|
+
| Generated | Source | Command |
|
|
63
|
+
| --------------------------------------------------------------------------- | ------------------------------------------- | --------------------------- |
|
|
64
|
+
| `plugins/pmcp/`, the root plugin and extension manifests, `.claude-plugin/` | `skills/`, `src/ui/claude/`, `package.json` | `bun run marketplace:build` |
|
|
65
|
+
| `docs/<page>/index.html`, `docs/assets/` | `docs/*.md`, `scripts/site/` | `bun run site:build` |
|
|
66
|
+
| `dist/` | `src/` | `npm run build` |
|
|
67
|
+
|
|
68
|
+
## Commits and releases
|
|
69
|
+
|
|
70
|
+
Commit messages describe the change for a reader of the public history. Releases follow
|
|
71
|
+
[RELEASING.md](https://github.com/modootoday/pmcp/blob/main/.github/RELEASING.md).
|