@contextful-com/contextful-mcp-darwin-arm64 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 +37 -23
- package/bin/contextful-mcp +2 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -18,6 +18,9 @@ organization; otherwise, choose an organization by name. It asks before uploadin
|
|
|
18
18
|
committed repository history. Private prompt history and usage are opt-in.
|
|
19
19
|
It then asks whether to upload new commits on your default branch automatically
|
|
20
20
|
and, when your Hub offers it, whether to share the lessons your agent writes down.
|
|
21
|
+
In a folder that is not a Git repository yet, it offers to start one with a first
|
|
22
|
+
commit; without Git, it offers to install it. `contextful-mcp help codes` explains
|
|
23
|
+
every reason install can stop.
|
|
21
24
|
|
|
22
25
|
To choose an agent explicitly, add `--client codex` or `--client claude`.
|
|
23
26
|
|
|
@@ -26,36 +29,47 @@ To choose an agent explicitly, add `--client codex` or `--client claude`.
|
|
|
26
29
|
Copy this prompt and replace the Hub URL:
|
|
27
30
|
|
|
28
31
|
> Install Contextful for this project using https://YOUR-HUB and the official
|
|
29
|
-
> @contextful-com/contextful-mcp npm package.
|
|
30
|
-
>
|
|
31
|
-
>
|
|
32
|
-
>
|
|
32
|
+
> @contextful-com/contextful-mcp npm package. Run its `install --plan --json` first
|
|
33
|
+
> and show me what it found and every decision it lists. Ask me all of them at once,
|
|
34
|
+
> then install with my answers. Guide me through browser sign-in. Never answer a
|
|
35
|
+
> question for me and never run a sudo step for me.
|
|
33
36
|
|
|
34
37
|
Instructions for the installing agent:
|
|
35
38
|
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
-
|
|
53
|
-
|
|
54
|
-
|
|
39
|
+
1. From the project, run
|
|
40
|
+
`npx -y @contextful-com/contextful-mcp@latest install --hub <URL> --plan --json`.
|
|
41
|
+
It changes nothing and needs no network. Show the person its `plan` items: what
|
|
42
|
+
is ready (`ok`), what must change first (`blocked`, with a `code`), and each
|
|
43
|
+
`decision` with its `question` and the `flag` that answers it.
|
|
44
|
+
2. Ask every decision at once: which agent (`--client claude|codex|both`), starting a
|
|
45
|
+
Git repository when the folder has none (`--start-repository`), uploading
|
|
46
|
+
committed history (`--yes`), private prompt history (`--history` or
|
|
47
|
+
`--no-history`), automatic updates (`--auto-refresh`), and lesson sharing
|
|
48
|
+
(`--share-lessons` or `--no-share-lessons`). `npx -y` only accepts npm's package
|
|
49
|
+
download; the install command's `--yes` approves the upload and nothing else.
|
|
50
|
+
3. Run `install --hub <URL>` with the answers as flags, plus `--scope repo --project .
|
|
51
|
+
--json --no-open --no-wait`. Use a long timeout or run it in the background: show
|
|
52
|
+
`authorization_required`'s link and code at once and keep the process running
|
|
53
|
+
while the person signs in. Never request passwords or read stored tokens.
|
|
54
|
+
4. If an `error` event arrives, act on its `kind`:
|
|
55
|
+
- `needs_person`: put its `ask` to the person; run its `rerun` (prefixed with
|
|
56
|
+
this npm package) only with their answer. This covers upload consent, starting
|
|
57
|
+
a repository, installing Git (show `details.steps`; the person runs any sudo
|
|
58
|
+
step), choosing an organization, and an agent sandbox that blocks the network
|
|
59
|
+
or a write (ask to run outside the sandbox).
|
|
60
|
+
- `fix_and_rerun`: tell the person what the message names, then rerun.
|
|
61
|
+
- `retry`: rerun the same command; completed steps are kept.
|
|
62
|
+
- `unsupported`: explain it (`details.lines`) and stop. Retrying cannot help.
|
|
63
|
+
`contextful-mcp help <code>` explains any code.
|
|
64
|
+
5. After `complete`, report the installed agent and its activation actions. Hub
|
|
65
|
+
training may still be running: do not report pending training as ready, and do
|
|
66
|
+
not bypass the agent's hook trust.
|
|
55
67
|
|
|
56
68
|
## Requirements
|
|
57
69
|
|
|
58
70
|
- Node.js 24 or newer and npm to run the npm launcher.
|
|
71
|
+
- Git, in a Git repository with at least one commit. In a terminal, install offers
|
|
72
|
+
to install Git and to start a repository in a folder that has none.
|
|
59
73
|
- A supported Claude Code or Codex installation. The installer checks its version.
|
|
60
74
|
- macOS ARM64/x64, Linux ARM64/x64 with glibc, or Windows x64.
|
|
61
75
|
|
package/bin/contextful-mcp
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
[diffend] Oversized file quarantined before diffing.
|
|
2
2
|
name: package/bin/contextful-mcp
|
|
3
|
-
size:
|
|
4
|
-
sha256:
|
|
3
|
+
size: 66041202 bytes
|
|
4
|
+
sha256: 1f82d61fc3b18827d5ce4ad7e05d9cfc35108caa53b225fd19e848cbbb4ad573
|