@tempoxyz/mercator 0.0.188 → 0.0.190
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 +20 -194
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,225 +1,51 @@
|
|
|
1
1
|
# `@tempoxyz/mercator`
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
|
|
3
|
+
Set up the [Mercator](https://mercator.tempo.xyz) remote MCP server and its optional payment wallet
|
|
4
|
+
for supported agent clients.
|
|
5
|
+
|
|
6
|
+
## Install
|
|
5
7
|
|
|
6
8
|
```sh
|
|
7
9
|
curl -fsSL https://mercator.tempo.xyz/install.sh | sh
|
|
8
|
-
mercator doctor
|
|
9
10
|
```
|
|
10
11
|
|
|
11
|
-
|
|
12
|
-
the same interactive setup flow. Pass CLI arguments after `sh -s --`, for example:
|
|
12
|
+
Or install the npm package with Node.js 24 or later:
|
|
13
13
|
|
|
14
14
|
```sh
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
## Setup flow
|
|
19
|
-
|
|
20
|
-
```mermaid
|
|
21
|
-
flowchart LR
|
|
22
|
-
START["Start setup"] --> DETECT["Detect supported clients"]
|
|
23
|
-
DETECT --> PLUGIN["Bootstrap local desktop plugin"]
|
|
24
|
-
PLUGIN -->|Agent CLI found| CONFIGURE["Install Mercator MCP entry"]
|
|
25
|
-
PLUGIN -->|No agent CLI| GUIDANCE
|
|
26
|
-
CONFIGURE --> GUIDANCE["Update managed guidance"]
|
|
27
|
-
GUIDANCE --> WALLET{"Ready payment runtime?"}
|
|
28
|
-
WALLET -->|Yes| VERIFY["Run readiness checks"]
|
|
29
|
-
WALLET -->|No| CHOICE{"Enable paid jobs now?"}
|
|
30
|
-
CHOICE -->|Yes| ONBOARD["Create local wallet or connect Tempo Wallet"]
|
|
31
|
-
CHOICE -->|Not yet| VERIFY
|
|
32
|
-
ONBOARD --> VERIFY
|
|
15
|
+
npm install --global @tempoxyz/mercator
|
|
16
|
+
mercator setup
|
|
33
17
|
```
|
|
34
18
|
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
- Codex
|
|
38
|
-
- Claude Code
|
|
39
|
-
- Gemini CLI
|
|
40
|
-
- Cursor
|
|
41
|
-
- VS Code
|
|
42
|
-
- Windsurf
|
|
43
|
-
- Cline
|
|
44
|
-
- Continue
|
|
45
|
-
- OpenClaw
|
|
46
|
-
- Hermes
|
|
47
|
-
|
|
48
|
-
Normal setup always bootstraps the bundled [Mercator plugin](../../plugins/mercator) into Codex's
|
|
49
|
-
user-local plugin index. Nothing is published, and users do not need to create or manage a
|
|
50
|
-
marketplace. The plugin connects Codex or ChatGPT desktop directly to the production Mercator MCP
|
|
51
|
-
server without requiring the Codex CLI. Restart ChatGPT desktop after installation. Use
|
|
52
|
-
`--no-plugin` for a CLI-only installation, such as CI or a headless server.
|
|
53
|
-
|
|
54
|
-
Selection options:
|
|
55
|
-
|
|
56
|
-
| Option | Behavior |
|
|
57
|
-
| --- | --- |
|
|
58
|
-
| No subcommand | Bootstrap the local plugin and run interactive `setup` |
|
|
59
|
-
| No client option | Configure every detected client |
|
|
60
|
-
| `--client <name>` | Configure one named client; repeatable |
|
|
61
|
-
| `--dry-run` | Preview configuration changes |
|
|
62
|
-
| `--force` | Recreate Mercator registrations and refresh managed guidance |
|
|
63
|
-
| `--yes` | Apply setup without the interactive confirmation |
|
|
64
|
-
| `--no-plugin` | Skip local desktop plugin installation |
|
|
65
|
-
| `--no-agents` | Skip Codex `AGENTS.md` guidance |
|
|
66
|
-
| `--remove-agents` | Remove installed Codex guidance |
|
|
67
|
-
|
|
68
|
-
Setup guarantees:
|
|
69
|
-
|
|
70
|
-
- Reuses matching existing configuration safely.
|
|
71
|
-
- Serializes plugin index updates and preserves unrelated local plugins.
|
|
72
|
-
- Shows a rotating [adamsky/globe](https://github.com/adamsky/globe) with live setup progress.
|
|
73
|
-
- Keeps the globe active while the interactive client picker is open.
|
|
74
|
-
- Confirms the complete setup plan before its first mutation.
|
|
75
|
-
- Treats payment setup as optional: discovery, descriptions, quotes, polling, and feedback remain
|
|
76
|
-
available when wallet onboarding is deferred.
|
|
77
|
-
- `--force` never removes or recreates wallets, keys, accounts, balances, sessions, or shared MPP
|
|
78
|
-
plugins.
|
|
79
|
-
- Wallet and native payment checks remain read-only during forced setup.
|
|
80
|
-
|
|
81
|
-
Example:
|
|
19
|
+
Setup detects supported clients, installs the Mercator MCP integration, and verifies free service
|
|
20
|
+
discovery. Target one client with `--client` or list available clients with `mercator clients`.
|
|
82
21
|
|
|
83
22
|
```sh
|
|
84
|
-
mercator setup --client codex
|
|
23
|
+
mercator setup --client codex
|
|
24
|
+
mercator doctor
|
|
85
25
|
```
|
|
86
26
|
|
|
87
|
-
##
|
|
88
|
-
|
|
89
|
-
Codex setup maintains a bounded block in the active global `AGENTS.md`:
|
|
90
|
-
|
|
91
|
-
- Explains when to use Mercator.
|
|
92
|
-
- Requires quote and budget approval before paid execution.
|
|
93
|
-
- Excludes local files and repository work.
|
|
94
|
-
- Preserves content outside `mercator:begin` and `mercator:end` HTML comments.
|
|
95
|
-
- Leaves an existing `AGENTS.override.md` untouched and reports when it shadows the guidance.
|
|
96
|
-
- Applies new guidance to the next Codex session.
|
|
97
|
-
|
|
98
|
-
Mercator always manages persistent `AGENTS.md`; use `--no-agents` to skip installation or
|
|
99
|
-
`--remove-agents` to remove the managed block.
|
|
27
|
+
## Payment wallet
|
|
100
28
|
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
Mercator uses one active payment wallet. `mercator wallet connect` and `mercator wallet create`
|
|
104
|
-
record that selection. Existing installations without an active selection continue using their
|
|
105
|
-
Tempo Wallet credentials when present, otherwise their local disk wallet.
|
|
106
|
-
|
|
107
|
-
| Runtime | Paid-request path | Session behavior |
|
|
108
|
-
| --- | --- | --- |
|
|
109
|
-
| Local disk wallet | `mercator submit` | Uses Mercator-owned Accounts SDK storage |
|
|
110
|
-
| Tempo Wallet | `mercator submit` | Uses a scoped access key authorized through Accounts |
|
|
111
|
-
| OpenClaw | Native `mpp_fetch` | Uses official `openclaw-mpp` integration |
|
|
112
|
-
| Hermes | Native `mpp_fetch` | Uses official `hermes-mpp` integration |
|
|
113
|
-
|
|
114
|
-
Mercator requires neither the Tempo Wallet CLI nor the MPPX CLI. Connecting or creating an unfunded
|
|
115
|
-
wallet opens Mercator's MACH funding page with its address selected. The page offers fixed amounts
|
|
116
|
-
and redirects to Stripe-hosted Checkout with card and Apple Pay support. Run `mercator wallet fund`
|
|
117
|
-
to open it again later.
|
|
118
|
-
|
|
119
|
-
OpenClaw and Hermes setup:
|
|
120
|
-
|
|
121
|
-
- Installs or verifies the official
|
|
122
|
-
[openclaw-mpp](https://github.com/tempoxyz/openclaw-mpp) or
|
|
123
|
-
[hermes-mpp](https://github.com/tempoxyz/hermes-mpp) integration.
|
|
124
|
-
- Preserves existing Hermes allowed origins before adding Mercator.
|
|
125
|
-
|
|
126
|
-
## Wallet onboarding
|
|
127
|
-
|
|
128
|
-
Run wallet setup separately:
|
|
29
|
+
Payment setup is optional. Discovery, service descriptions, quotes, result polling, and feedback do
|
|
30
|
+
not require a wallet.
|
|
129
31
|
|
|
130
32
|
```sh
|
|
131
|
-
mercator wallet
|
|
132
|
-
mercator wallet
|
|
133
|
-
mercator wallet create
|
|
134
|
-
mercator wallet status
|
|
33
|
+
mercator wallet # Connect or create a wallet
|
|
34
|
+
mercator wallet status # Check readiness
|
|
135
35
|
mercator wallet balance
|
|
136
36
|
mercator wallet fund
|
|
137
37
|
```
|
|
138
38
|
|
|
139
|
-
|
|
140
|
-
machine, or defer payment setup. The standalone `mercator wallet` command requires a wallet choice.
|
|
141
|
-
`wallet connect` opens the Accounts SDK device flow and stores only its Mercator access key locally.
|
|
142
|
-
Local-wallet private material, connected-wallet access keys, and the active selection share the
|
|
143
|
-
Accounts SDK filesystem store at `~/.mercator/wallet.json`, secured with user-only file permissions.
|
|
144
|
-
|
|
145
|
-
`mercator wallet status` inspects readiness without onboarding. `mercator wallet`,
|
|
146
|
-
`mercator wallet balance`, and `mercator wallet fund` report the active wallet's balances. Creating
|
|
147
|
-
or connecting an unfunded wallet opens Mercator's card onramp; inspecting an existing wallet does
|
|
148
|
-
not.
|
|
149
|
-
|
|
150
|
-
## Paid job submission
|
|
151
|
-
|
|
152
|
-
```mermaid
|
|
153
|
-
flowchart LR
|
|
154
|
-
MCP["MCP: discover + quote"] --> REST["POST /v1/jobs"]
|
|
155
|
-
REST --> PAYMENT["Mercator wallet"]
|
|
156
|
-
PAYMENT --> POLL["MCP or REST: poll result"]
|
|
157
|
-
```
|
|
158
|
-
|
|
159
|
-
Recommended path:
|
|
160
|
-
|
|
161
|
-
- Use MCP for discovery, quoting, and result polling.
|
|
162
|
-
- Use the bounded `mercator submit` handoff returned by `create_job`.
|
|
163
|
-
- The REST endpoint offers both `tempo/session` and `tempo/charge`.
|
|
164
|
-
- Some MCP harnesses cannot answer the payment-required protocol error from `create_job`.
|
|
165
|
-
- Use `mpp_fetch` in OpenClaw or Hermes.
|
|
166
|
-
- Other clients use the same Mercator wallet created during setup.
|
|
167
|
-
|
|
168
|
-
## Diagnostics
|
|
169
|
-
|
|
170
|
-
`doctor` performs read-only checks:
|
|
171
|
-
|
|
172
|
-
- MCP transport.
|
|
173
|
-
- Six-tool contract.
|
|
174
|
-
- Free service discovery.
|
|
175
|
-
- Unsigned Mercator session challenge.
|
|
176
|
-
- Local wallet session capability.
|
|
177
|
-
- Local plugin path, installed and expected versions, registration state, and desktop restart
|
|
178
|
-
requirement.
|
|
179
|
-
|
|
180
|
-
Plugin state is advisory so `--no-plugin` installations remain healthy. Funding is reported
|
|
181
|
-
separately from session capability. Paid execution remains `not_verified`. Setup succeeds when the
|
|
182
|
-
free MCP transport and discovery checks pass; `doctor` remains the strict check for transport,
|
|
183
|
-
discovery, and payment-wallet readiness.
|
|
184
|
-
|
|
185
|
-
Interactive setup uses stable status symbols:
|
|
186
|
-
|
|
187
|
-
| Symbol | Meaning |
|
|
188
|
-
| --- | --- |
|
|
189
|
-
| `✓` | Ready or completed |
|
|
190
|
-
| `→` | In progress or planned |
|
|
191
|
-
| `!` | Action required |
|
|
192
|
-
| `○` | Skipped or not checked |
|
|
193
|
-
| `✗` | Failed |
|
|
39
|
+
For paid jobs, use the bounded `mercator submit` command returned by Mercator's `create_job` tool.
|
|
194
40
|
|
|
195
41
|
## Uninstall
|
|
196
42
|
|
|
197
43
|
```sh
|
|
198
|
-
mercator uninstall --client codex
|
|
199
|
-
mercator uninstall --client openclaw --client hermes
|
|
200
|
-
mercator uninstall --dry-run
|
|
201
44
|
mercator uninstall
|
|
202
45
|
```
|
|
203
46
|
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
- Removes only the `mercator` MCP entry, CLI-managed local plugin bundle and registration, and
|
|
207
|
-
installer-managed Codex guidance.
|
|
208
|
-
- Preserves other MCP servers, local plugin entries, and user instructions.
|
|
209
|
-
- Preserves wallets, keys, balances, sessions, and shared MPP plugins.
|
|
210
|
-
- `--dry-run` previews removal.
|
|
211
|
-
- A scoped uninstall removes the plugin only for `--client codex`; an unscoped uninstall removes it
|
|
212
|
-
with all other Mercator integrations.
|
|
213
|
-
- VS Code removal covers the default user profile; use **MCP: Open User Configuration** for other
|
|
214
|
-
profiles.
|
|
47
|
+
Wallets, keys, balances, and sessions are preserved.
|
|
215
48
|
|
|
216
|
-
##
|
|
217
|
-
|
|
218
|
-
```sh
|
|
219
|
-
mercator clients
|
|
220
|
-
mercator --help
|
|
221
|
-
mercator --llms
|
|
222
|
-
```
|
|
49
|
+
## Documentation
|
|
223
50
|
|
|
224
|
-
|
|
225
|
-
errors, shell completions, and agent integrations.
|
|
51
|
+
See the [Mercator documentation](https://mercator.tempo.xyz/docs) or run `mercator --help`.
|