lockage 0.9.2 → 0.9.3
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 +18 -7
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -54,11 +54,11 @@ No clone or build is required. You only add a definition to your MCP client's co
|
|
|
54
54
|
|
|
55
55
|
The first run may take a little time to fetch. The DB (ledger) is created at `~/.lockage/lockage.sqlite` by default, so no extra configuration is needed.
|
|
56
56
|
|
|
57
|
-
To get started you need just two things: **registering with an MCP client** and **distributing the coordination rules** (next section). Line these two up and multi-agent coordination starts working.
|
|
57
|
+
To get started you need just two things: **registering with an MCP client** and **distributing the coordination rules** (next section). Line these two up and multi-agent coordination starts working. For Claude Code and Antigravity, installing the plugin (next section) covers both.
|
|
58
58
|
|
|
59
59
|
### Registering with an MCP client
|
|
60
60
|
|
|
61
|
-
Add a server definition like the following to the MCP configuration of Kiro
|
|
61
|
+
Add a server definition like the following to the MCP configuration of Kiro, and so on; Claude Code and Antigravity need no registration here (see below). Follow each client's configuration file format.
|
|
62
62
|
|
|
63
63
|
To Kiro's `mcp.json`, add the following definition that launches the npm-published artifact with `npx` (no clone or `npm run build` is needed; the first run may take a little time to fetch).
|
|
64
64
|
|
|
@@ -74,14 +74,25 @@ To Kiro's `mcp.json`, add the following definition that launches the npm-publish
|
|
|
74
74
|
}
|
|
75
75
|
```
|
|
76
76
|
|
|
77
|
-
The DB (ledger) is stored at `~/.lockage/lockage.sqlite` by default (the parent directory is created automatically). The default is fine; only those who want to change the location add `"env": { "LOCKAGE_DB": "/absolute/path/to/your-workspace/.lockage/lockage.sqlite" }` to `lockage`.
|
|
77
|
+
The DB (ledger) is stored at `~/.lockage/lockage.sqlite` by default (the parent directory is created automatically). The default is fine; only those who want to change the location add `"env": { "LOCKAGE_DB": "/absolute/path/to/your-workspace/.lockage/lockage.sqlite" }` to `lockage`. With the Claude Code plugin, set `LOCKAGE_DB` in the `env` of a Claude Code settings file (usually `~/.claude/settings.json`) instead (see the Claude Code section of [`plugins/README.md`](plugins/README.md#claude-code)). In Antigravity, set `LOCKAGE_DB` in the shell environment from which Antigravity is launched.
|
|
78
78
|
|
|
79
79
|
When multiple agents coordinate, line everyone up so they **point at the same `LOCKAGE_DB`**. If you leave the default, everyone points at the same default ledger, so no extra configuration is needed. This becomes the shared coordination ledger.
|
|
80
80
|
|
|
81
|
-
For
|
|
81
|
+
For Claude Code and Antigravity, you do not need to register it here: the lockage plugin (next section) bundles this `npx -y lockage` definition, so installing the plugin registers the server too. If you registered it by hand before, remove that registration (with a different command, two lockage servers line up; with the same command, only the hand registration is kept and the bundled definition goes unused), after moving any `LOCKAGE_DB` in its `env` to the settings file (for Claude Code, usually `~/.claude/settings.json`) or environment variable (for Antigravity; see [`plugins/README.md`](plugins/README.md)).
|
|
82
82
|
|
|
83
83
|
Do not write `LOCKAGE_TOOLSETS` in an agent's configuration (only the default `core` is visible). Only when a human uses the maintenance/diagnostic tools, add `"LOCKAGE_TOOLSETS": "maintenance"` to the `env` of that MCP client.
|
|
84
84
|
|
|
85
|
+
With the Claude Code plugin, the bundled server has no `env`, so register a separate server for maintenance only where a human uses it, and remove it when done:
|
|
86
|
+
|
|
87
|
+
```bash
|
|
88
|
+
claude mcp add lockage-maint -s local -e LOCKAGE_TOOLSETS=maintenance -- npx -y lockage@latest
|
|
89
|
+
claude mcp remove lockage-maint -s local
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
Give it a command different from the bundled one (here `lockage@latest`, which can be newer than the version the bundled server runs). Claude Code merges servers with the same command even when their names and `env` differ, so registering it with `npx -y lockage` would replace the bundled server, leaving only the maintenance server in that session (confirmed with Claude Code 2.1.285).
|
|
93
|
+
|
|
94
|
+
This server exposes the core tools as well as the maintenance ones, as `mcp__lockage-maint__*` (31 tools with lockage 0.9.2, confirmed). While it is registered, lockage-worker sees a second lockage server and returns "failed", so do not launch workers until you remove it. It reads `LOCKAGE_DB` from the environment Claude Code passes to MCP servers, like the bundled server, so it points at the ledger set in the settings `env` (not tried for this server).
|
|
95
|
+
|
|
85
96
|
---
|
|
86
97
|
|
|
87
98
|
## Distributing the coordination rules
|
|
@@ -90,8 +101,8 @@ Once both registering with an MCP client and distributing these coordination rul
|
|
|
90
101
|
|
|
91
102
|
**The main path is installation via a plugin / Power.** You can load the coordination rules and hooks on the client side without placing anything in the target repository.
|
|
92
103
|
|
|
93
|
-
- **Claude Code**: register this repository as a marketplace and install the lockage plugin (`plugins/claude`).
|
|
94
|
-
- **Antigravity**: install with `agy plugin install <local path where you cloned lockage>/plugins/antigravity`.
|
|
104
|
+
- **Claude Code**: register this repository as a marketplace and install the lockage plugin (`plugins/claude`). The plugin also registers the MCP server.
|
|
105
|
+
- **Antigravity**: install with `agy plugin install <local path where you cloned lockage>/plugins/antigravity`. The plugin also registers the MCP server.
|
|
95
106
|
- **Kiro**: register `plugins/kiro` as a Power and place the hooks into the target's `.kiro/hooks/` (`npx -y lockage setup kiro`).
|
|
96
107
|
|
|
97
108
|
For the detailed procedure of each, see [`plugins/README.md`](plugins/README.md).
|
|
@@ -102,7 +113,7 @@ For the detailed procedure of each, see [`plugins/README.md`](plugins/README.md)
|
|
|
102
113
|
|
|
103
114
|
Merely registering this server in the MCP configuration does not tell an agent "when, which tool, in what order to call." Only once the instructions required for coordination (the coordination rules in `AGENTS.md` and the lockage-workflow skill) are delivered to each agent does coordination start running as the rules describe.
|
|
104
115
|
|
|
105
|
-
> 💡 There are only two prerequisites for coordinating multiple agents. **(a)** Everyone's
|
|
116
|
+
> 💡 There are only two prerequisites for coordinating multiple agents. **(a)** Everyone's lockage server points at **the same absolute `LOCKAGE_DB` path** (via the MCP configuration's `env`, or the environment the server inherits), and **(b)** each agent names **its own unique `agent_id`** (since a shared `AGENTS.md` cannot write them out in advance, each agent decides its own at startup and confirms uniqueness on the board). Line these two up and coordination runs as the rules describe.
|
|
106
117
|
|
|
107
118
|
### Mapping of the coordination flow to tools
|
|
108
119
|
|