@contextful-com/contextful-mcp-darwin-arm64 0.22.0 → 0.24.0
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 +56 -36
- package/bin/contextful-mcp +2 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -6,20 +6,26 @@ Your Hub runs separately in the cloud or on your own infrastructure.
|
|
|
6
6
|
|
|
7
7
|
## Install
|
|
8
8
|
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
(Claude Code) or `$contextful:hub` (Codex) previews and confirms the exact scope.
|
|
14
|
-
Switching does not erase conversation context; start a fresh session across
|
|
15
|
-
confidential organizations.
|
|
16
|
-
|
|
17
|
-
Run this from your project, using the Hub URL provided by your dashboard:
|
|
9
|
+
Run this from your project. Nothing here needs Node.js: your Hub serves a small install
|
|
10
|
+
script that downloads this package's executable for your computer from npm (about 60 MB the
|
|
11
|
+
first time), checks it as Contextful's own updates do, and runs it. On macOS, Linux, or Git
|
|
12
|
+
Bash on Windows, for a hosted Hub (`YOUR-ORG` is the name in its address):
|
|
18
13
|
|
|
19
14
|
```sh
|
|
20
|
-
|
|
15
|
+
curl -fsSL https://app.contextful.com/-/install.sh | sh -s -- install --hub https://app.contextful.com/YOUR-ORG
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
In PowerShell on Windows:
|
|
19
|
+
|
|
20
|
+
```powershell
|
|
21
|
+
& ([scriptblock]::Create((irm https://app.contextful.com/-/install.ps1))) install --hub https://app.contextful.com/YOUR-ORG
|
|
21
22
|
```
|
|
22
23
|
|
|
24
|
+
For a self-hosted Hub, use its own address in both places: `https://hub.example/-/install.sh`
|
|
25
|
+
and `--hub https://hub.example`. The script is always at the address without a path. With
|
|
26
|
+
Node.js 24 or later, the npm package does the same:
|
|
27
|
+
`npx @contextful-com/contextful-mcp@latest install --hub https://YOUR-HUB`.
|
|
28
|
+
|
|
23
29
|
Follow the browser sign-in and choose your agent when prompted. The installer
|
|
24
30
|
discovers the Hub endpoints and your organizations. It reuses a saved or sole
|
|
25
31
|
organization; otherwise, choose an organization by name. It asks before uploading
|
|
@@ -37,28 +43,34 @@ every reason install can stop.
|
|
|
37
43
|
|
|
38
44
|
To choose an agent explicitly, add `--client codex` or `--client claude`.
|
|
39
45
|
|
|
46
|
+
Already connected to several Hubs? Use `~/.contextful/bin/contextful-mcp hubs`
|
|
47
|
+
to list them, then `~/.contextful/bin/contextful-mcp use <Hub-address>` to
|
|
48
|
+
change the default for unbound folders. Bound repositories stay on their own Hubs;
|
|
49
|
+
do not reinstall or upload again just to switch. In your agent, `/contextful:hub`
|
|
50
|
+
(Claude Code) or `$contextful:hub` (Codex) previews and confirms the exact scope.
|
|
51
|
+
Switching does not erase conversation context; start a fresh session across
|
|
52
|
+
confidential organizations.
|
|
53
|
+
|
|
40
54
|
## Ask your agent to install
|
|
41
55
|
|
|
42
56
|
Copy this prompt and replace the Hub URL:
|
|
43
57
|
|
|
44
|
-
>
|
|
45
|
-
>
|
|
46
|
-
> Otherwise, install Contextful for this project using https://YOUR-HUB and the official
|
|
47
|
-
> @contextful-com/contextful-mcp npm package. Run its `install --plan --json` first
|
|
58
|
+
> Install Contextful for this project using https://YOUR-HUB and its install script,
|
|
59
|
+
> which needs no Node.js. Run its `install --plan --json` first
|
|
48
60
|
> and show me what it found and every decision it lists. Ask me all of them at once,
|
|
49
61
|
> then install with my answers. Guide me through browser sign-in. Never answer a
|
|
50
62
|
> question for me and never run a sudo step for me.
|
|
51
63
|
|
|
52
64
|
Instructions for the installing agent:
|
|
53
65
|
|
|
54
|
-
1.
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
It
|
|
66
|
+
1. Every command below starts with the install script's prefix, where `<ORIGIN>` is the
|
|
67
|
+
Hub URL without any path: `curl -fsSL <ORIGIN>/-/install.sh | sh -s --` in a POSIX
|
|
68
|
+
shell (macOS, Linux, Git Bash), or `& ([scriptblock]::Create((irm <ORIGIN>/-/install.ps1)))`
|
|
69
|
+
in PowerShell. Without curl, use `wget -qO-` in its place. The first run downloads
|
|
70
|
+
about 60 MB (allow it up to 10 minutes); later runs reuse it. A sandbox that blocks
|
|
71
|
+
the network needs the person's approval for this command.
|
|
72
|
+
2. From the project, run `<prefix> install --hub <URL> --plan --json`.
|
|
73
|
+
It only downloads Contextful; it sets nothing up. Show the person its `plan` items: what
|
|
62
74
|
is ready (`ok`), what must change first (`blocked`, with a `code`), each
|
|
63
75
|
`decision` with its `question` and the `flag` that answers it, and `info` items
|
|
64
76
|
such as an agent that is installed but does not start (`client_unusable`, with
|
|
@@ -69,16 +81,16 @@ Instructions for the installing agent:
|
|
|
69
81
|
`--no-history`), automatic updates (`--auto-refresh`), lesson sharing
|
|
70
82
|
(`--share-lessons` or `--no-share-lessons`), and, when Claude's desktop app still
|
|
71
83
|
starts an older Contextful, removing that entry
|
|
72
|
-
(`--clean-desktop-config`).
|
|
73
|
-
|
|
84
|
+
(`--clean-desktop-config`). The install command's `--yes` approves the upload and
|
|
85
|
+
nothing else.
|
|
74
86
|
4. Run `install --hub <URL>` with the answers as flags, plus `--scope repo` (valid
|
|
75
87
|
with every `--client`, `none` included) and `--project . --json --no-wait`. Use a long timeout or run it in the background: show
|
|
76
88
|
`authorization_required`'s link and code at once (`browserOpened: true` means it also opened in the person's
|
|
77
89
|
browser; say so) and keep the process running
|
|
78
90
|
while the person signs in. Never request passwords or read stored tokens.
|
|
79
91
|
5. If an `error` event arrives, act on its `kind`:
|
|
80
|
-
- `needs_person`: put its `ask` to the person; run its `rerun` (
|
|
81
|
-
|
|
92
|
+
- `needs_person`: put its `ask` to the person; run its `rerun` as written (it names
|
|
93
|
+
the downloaded executable by its path) only with their answer. This covers upload consent, starting
|
|
82
94
|
a repository, installing Git (show `details.steps`; the person runs any sudo
|
|
83
95
|
step), choosing an organization, whether this folder is the same project as a
|
|
84
96
|
repository on the Hub or a fork or copy of it (`--join` or `--fork`), and an
|
|
@@ -102,7 +114,9 @@ Instructions for the installing agent:
|
|
|
102
114
|
|
|
103
115
|
## Requirements
|
|
104
116
|
|
|
105
|
-
- Node.js
|
|
117
|
+
- No Node.js. The install script needs curl (or wget) and tar on macOS and Linux, and
|
|
118
|
+
PowerShell with tar.exe on Windows (Windows 10 version 1803 or later). Node.js 24 or
|
|
119
|
+
newer and npm only for the npm launcher.
|
|
106
120
|
- Git, in a Git repository with at least one commit. In a terminal, install offers
|
|
107
121
|
to install Git and to start a repository in a folder that has none.
|
|
108
122
|
- Claude Code 2.1.281 or later, or Codex 0.157.0 or later. The installer checks the
|
|
@@ -110,9 +124,10 @@ Instructions for the installing agent:
|
|
|
110
124
|
- macOS on Apple silicon (Intel Macs are not supported), Linux ARM64/x64 with glibc,
|
|
111
125
|
or Windows x64.
|
|
112
126
|
|
|
113
|
-
npm
|
|
114
|
-
needed. Installed plugins keep their own executable, so they continue
|
|
115
|
-
independently of
|
|
127
|
+
The script and npm install the same prebuilt binary. No compiler, Node or Bun
|
|
128
|
+
installation is needed. Installed plugins keep their own executable, so they continue
|
|
129
|
+
working independently of where it was downloaded and without Node or Bun on their
|
|
130
|
+
runtime path.
|
|
116
131
|
|
|
117
132
|
## Upgrade or uninstall
|
|
118
133
|
|
|
@@ -120,21 +135,26 @@ Contextful keeps itself up to date. Within about a day of a new release, an
|
|
|
120
135
|
active session downloads it from npm, checks it, and updates every agent you
|
|
121
136
|
installed it for; running sessions keep their version and new sessions use the new
|
|
122
137
|
one. To turn this off, set `"selfUpdate": false` in `~/.contextful/config.json`;
|
|
123
|
-
Contextful then says once a day when a release is out, and this updates by hand
|
|
138
|
+
Contextful then says once a day when a release is out, and this updates by hand,
|
|
139
|
+
fetching the newest release itself:
|
|
124
140
|
|
|
125
141
|
```sh
|
|
126
|
-
|
|
142
|
+
~/.contextful/bin/contextful-mcp upgrade
|
|
127
143
|
```
|
|
128
144
|
|
|
129
145
|
`contextful-mcp status` shows the last update. To go back to an earlier release,
|
|
130
|
-
run
|
|
131
|
-
|
|
132
|
-
`
|
|
146
|
+
run the install script with `--release=<version>` before `install --downgrade`
|
|
147
|
+
(with npm: `npx @contextful-com/contextful-mcp@<version> install --downgrade`). Setting
|
|
148
|
+
`"releaseCheck": false` turns off the check, the updates and `upgrade`'s fetch; so does
|
|
149
|
+
`CONTEXTFUL_RELEASE_CHECK=off`, and `NO_UPDATE_NOTIFIER` and `CI` turn off the check and
|
|
150
|
+
the automatic updates.
|
|
133
151
|
|
|
134
152
|
```sh
|
|
135
|
-
|
|
153
|
+
~/.contextful/bin/contextful-mcp uninstall
|
|
136
154
|
```
|
|
137
155
|
|
|
156
|
+
On Windows the command is `%USERPROFILE%\.contextful\bin\contextful-mcp.cmd`.
|
|
157
|
+
|
|
138
158
|
For a persistent command on your PATH:
|
|
139
159
|
|
|
140
160
|
```sh
|
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: 97828706 bytes
|
|
4
|
+
sha256: 0c56307ea7b6cfcc205c953cadaef22643eac2cf45f213a0213870c72c86fe12
|