cimux-mcp 0.2.0 → 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 +57 -13
- package/dist/bin.js +10 -1
- package/dist/bin.js.map +1 -1
- package/dist/cli/cimux-cli.d.ts +2 -9
- package/dist/cli/cimux-cli.js +62 -201
- package/dist/cli/cimux-cli.js.map +1 -1
- package/dist/cli/commands/ack.d.ts +2 -0
- package/dist/cli/commands/ack.js +24 -0
- package/dist/cli/commands/ack.js.map +1 -0
- package/dist/cli/commands/brief.d.ts +2 -0
- package/dist/cli/commands/brief.js +33 -0
- package/dist/cli/commands/brief.js.map +1 -0
- package/dist/cli/commands/check.d.ts +2 -0
- package/dist/cli/commands/check.js +24 -0
- package/dist/cli/commands/check.js.map +1 -0
- package/dist/cli/commands/install.d.ts +2 -0
- package/dist/cli/commands/install.js +55 -0
- package/dist/cli/commands/install.js.map +1 -0
- package/dist/cli/commands/mailboxes.d.ts +2 -0
- package/dist/cli/commands/mailboxes.js +14 -0
- package/dist/cli/commands/mailboxes.js.map +1 -0
- package/dist/cli/commands/mcp.d.ts +2 -0
- package/dist/cli/commands/mcp.js +11 -0
- package/dist/cli/commands/mcp.js.map +1 -0
- package/dist/cli/commands/notify.d.ts +2 -0
- package/dist/cli/commands/notify.js +24 -0
- package/dist/cli/commands/notify.js.map +1 -0
- package/dist/cli/commands/read.d.ts +2 -0
- package/dist/cli/commands/read.js +21 -0
- package/dist/cli/commands/read.js.map +1 -0
- package/dist/cli/commands/register.d.ts +2 -0
- package/dist/cli/commands/register.js +27 -0
- package/dist/cli/commands/register.js.map +1 -0
- package/dist/cli/commands/send.d.ts +2 -0
- package/dist/cli/commands/send.js +37 -0
- package/dist/cli/commands/send.js.map +1 -0
- package/dist/cli/shared.d.ts +36 -0
- package/dist/cli/shared.js +71 -0
- package/dist/cli/shared.js.map +1 -0
- package/dist/index.d.ts +4 -3
- package/dist/index.js +2 -2
- package/dist/index.js.map +1 -1
- package/dist/install/cimux-install-plan.d.ts +5 -1
- package/dist/install/cimux-install-plan.js +37 -108
- package/dist/install/cimux-install-plan.js.map +1 -1
- package/dist/install/harnesses/claude.d.ts +2 -0
- package/dist/install/harnesses/claude.js +27 -0
- package/dist/install/harnesses/claude.js.map +1 -0
- package/dist/install/harnesses/codex.d.ts +2 -0
- package/dist/install/harnesses/codex.js +26 -0
- package/dist/install/harnesses/codex.js.map +1 -0
- package/dist/install/harnesses/cursor.d.ts +2 -0
- package/dist/install/harnesses/cursor.js +46 -0
- package/dist/install/harnesses/cursor.js.map +1 -0
- package/dist/install/harnesses/index.d.ts +5 -0
- package/dist/install/harnesses/index.js +16 -0
- package/dist/install/harnesses/index.js.map +1 -0
- package/dist/install/harnesses/shared.d.ts +26 -0
- package/dist/install/harnesses/shared.js +43 -0
- package/dist/install/harnesses/shared.js.map +1 -0
- package/dist/mcp/cimux-mcp-server.js +1 -1
- package/dist/mcp/cimux-mcp-server.js.map +1 -1
- package/dist/{registration/mailbox-registration.d.ts → naming/mailbox-naming.d.ts} +21 -0
- package/dist/naming/mailbox-naming.js +96 -0
- package/dist/naming/mailbox-naming.js.map +1 -0
- package/dist/service/cimux-mailbox-service.d.ts +1 -1
- package/dist/service/cimux-mailbox-service.js +5 -3
- package/dist/service/cimux-mailbox-service.js.map +1 -1
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/package.json +1 -2
- package/dist/registration/mailbox-registration.js +0 -48
- package/dist/registration/mailbox-registration.js.map +0 -1
- package/dist/runtime/mailbox-runtime.d.ts +0 -22
- package/dist/runtime/mailbox-runtime.js +0 -50
- package/dist/runtime/mailbox-runtime.js.map +0 -1
- package/docs/mvp-readiness.md +0 -85
|
@@ -1,50 +0,0 @@
|
|
|
1
|
-
import { execFileSync } from "node:child_process";
|
|
2
|
-
import path from "node:path";
|
|
3
|
-
import { z } from "zod";
|
|
4
|
-
import { inferMailboxName } from "../registration/mailbox-registration.js";
|
|
5
|
-
import { mailboxNameSchema } from "../model/context-package.js";
|
|
6
|
-
export const runtimeMailboxInputSchema = z.object({
|
|
7
|
-
harness: z.string().min(1).optional(),
|
|
8
|
-
explicitMailbox: mailboxNameSchema.optional(),
|
|
9
|
-
cwd: z.string().min(1).default(process.cwd())
|
|
10
|
-
});
|
|
11
|
-
export function resolveRuntimeMailbox(input = {}) {
|
|
12
|
-
const parsed = runtimeMailboxInputSchema.parse(input);
|
|
13
|
-
const folderName = path.basename(parsed.cwd);
|
|
14
|
-
if (parsed.explicitMailbox) {
|
|
15
|
-
return {
|
|
16
|
-
mailbox: parsed.explicitMailbox,
|
|
17
|
-
inferredFrom: "explicit",
|
|
18
|
-
branchName: null,
|
|
19
|
-
folderName
|
|
20
|
-
};
|
|
21
|
-
}
|
|
22
|
-
const branchName = readGitBranch(parsed.cwd);
|
|
23
|
-
const mailbox = inferMailboxName({
|
|
24
|
-
harness: parsed.harness ?? "codex",
|
|
25
|
-
branchName: branchName ?? undefined,
|
|
26
|
-
folderName
|
|
27
|
-
});
|
|
28
|
-
return {
|
|
29
|
-
mailbox,
|
|
30
|
-
inferredFrom: branchName ? "branch" : "folder",
|
|
31
|
-
branchName,
|
|
32
|
-
folderName
|
|
33
|
-
};
|
|
34
|
-
}
|
|
35
|
-
function readGitBranch(cwd) {
|
|
36
|
-
try {
|
|
37
|
-
// Hooks run from the active session cwd. Asking git directly keeps mailbox
|
|
38
|
-
// naming aligned with the real workstream without requiring user setup.
|
|
39
|
-
const output = execFileSync("git", ["branch", "--show-current"], {
|
|
40
|
-
cwd,
|
|
41
|
-
encoding: "utf8",
|
|
42
|
-
stdio: ["ignore", "pipe", "ignore"]
|
|
43
|
-
}).trim();
|
|
44
|
-
return output || null;
|
|
45
|
-
}
|
|
46
|
-
catch {
|
|
47
|
-
return null;
|
|
48
|
-
}
|
|
49
|
-
}
|
|
50
|
-
//# sourceMappingURL=mailbox-runtime.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"mailbox-runtime.js","sourceRoot":"","sources":["../../src/runtime/mailbox-runtime.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,gBAAgB,EAAE,MAAM,yCAAyC,CAAC;AAC3E,OAAO,EAAE,iBAAiB,EAAE,MAAM,6BAA6B,CAAC;AAEhE,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,CAAC,MAAM,CAAC;IAChD,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;IACrC,eAAe,EAAE,iBAAiB,CAAC,QAAQ,EAAE;IAC7C,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC;CAC9C,CAAC,CAAC;AAWH,MAAM,UAAU,qBAAqB,CAAC,QAA6B,EAAE;IACnE,MAAM,MAAM,GAAG,yBAAyB,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IACtD,MAAM,UAAU,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IAE7C,IAAI,MAAM,CAAC,eAAe,EAAE,CAAC;QAC3B,OAAO;YACL,OAAO,EAAE,MAAM,CAAC,eAAe;YAC/B,YAAY,EAAE,UAAU;YACxB,UAAU,EAAE,IAAI;YAChB,UAAU;SACX,CAAC;IACJ,CAAC;IAED,MAAM,UAAU,GAAG,aAAa,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IAC7C,MAAM,OAAO,GAAG,gBAAgB,CAAC;QAC/B,OAAO,EAAE,MAAM,CAAC,OAAO,IAAI,OAAO;QAClC,UAAU,EAAE,UAAU,IAAI,SAAS;QACnC,UAAU;KACX,CAAC,CAAC;IAEH,OAAO;QACL,OAAO;QACP,YAAY,EAAE,UAAU,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ;QAC9C,UAAU;QACV,UAAU;KACX,CAAC;AACJ,CAAC;AAED,SAAS,aAAa,CAAC,GAAW;IAChC,IAAI,CAAC;QACH,2EAA2E;QAC3E,wEAAwE;QACxE,MAAM,MAAM,GAAG,YAAY,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,gBAAgB,CAAC,EAAE;YAC/D,GAAG;YACH,QAAQ,EAAE,MAAM;YAChB,KAAK,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,CAAC;SACpC,CAAC,CAAC,IAAI,EAAE,CAAC;QAEV,OAAO,MAAM,IAAI,IAAI,CAAC;IACxB,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC"}
|
package/docs/mvp-readiness.md
DELETED
|
@@ -1,85 +0,0 @@
|
|
|
1
|
-
# MVP Readiness
|
|
2
|
-
|
|
3
|
-
This checklist defines the local Cimux MVP: agents can send intentional context to another local agent inbox; receivers can preview, read, and ack; empty inbox checks do not emit prompt context.
|
|
4
|
-
|
|
5
|
-
## Automated Checks
|
|
6
|
-
|
|
7
|
-
Run before every MVP release candidate:
|
|
8
|
-
|
|
9
|
-
```bash
|
|
10
|
-
npm test
|
|
11
|
-
npm run typecheck
|
|
12
|
-
npm run build
|
|
13
|
-
npm run demo:local
|
|
14
|
-
npm pack --dry-run
|
|
15
|
-
```
|
|
16
|
-
|
|
17
|
-
Expected result:
|
|
18
|
-
|
|
19
|
-
- all tests pass
|
|
20
|
-
- the demo sends, notifies, previews, reads, and acks one Context Package
|
|
21
|
-
- the npm tarball includes `dist`, `README.md`, `package.json`, and `scripts/demo-local-handoff.mjs`
|
|
22
|
-
|
|
23
|
-
## Manual Install Check
|
|
24
|
-
|
|
25
|
-
Run this from the repo on a local machine:
|
|
26
|
-
|
|
27
|
-
```bash
|
|
28
|
-
npm install
|
|
29
|
-
npm run build
|
|
30
|
-
npm link
|
|
31
|
-
cimux --help
|
|
32
|
-
cimux --version
|
|
33
|
-
cimux install --dry-run
|
|
34
|
-
cimux install
|
|
35
|
-
```
|
|
36
|
-
|
|
37
|
-
Expected result:
|
|
38
|
-
|
|
39
|
-
- `cimux --help` prints the command list
|
|
40
|
-
- `cimux --version` prints the package version
|
|
41
|
-
- `cimux install --dry-run` prints Codex and Claude config snippets
|
|
42
|
-
- `cimux install` writes config and creates `.cimux.bak` backups before updating existing files
|
|
43
|
-
- a new Codex or Claude session sees the Cimux MCP server after restart
|
|
44
|
-
|
|
45
|
-
## Harness Verification
|
|
46
|
-
|
|
47
|
-
After installing and restarting the target harness:
|
|
48
|
-
|
|
49
|
-
1. Confirm the Cimux MCP tools are visible:
|
|
50
|
-
- `register_session`
|
|
51
|
-
- `send_context`
|
|
52
|
-
- `check_inbox`
|
|
53
|
-
- `read_context`
|
|
54
|
-
- `ack_context`
|
|
55
|
-
2. Start or resume a session in a git repo.
|
|
56
|
-
3. Confirm the session can register as `harness/branch-name`.
|
|
57
|
-
4. Send a Context Package to that mailbox.
|
|
58
|
-
5. Submit a new user prompt to the receiving session.
|
|
59
|
-
6. Confirm the hook emits one short notification line.
|
|
60
|
-
7. Confirm `check_inbox` returns previews only.
|
|
61
|
-
8. Confirm `read_context` returns the full body.
|
|
62
|
-
9. Confirm `ack_context` marks the package acknowledged.
|
|
63
|
-
|
|
64
|
-
## Known Limits
|
|
65
|
-
|
|
66
|
-
- Local-only SQLite storage.
|
|
67
|
-
- No hosted auth, workspaces, or SaaS tenancy.
|
|
68
|
-
- No vector database or embeddings.
|
|
69
|
-
- No automatic routing.
|
|
70
|
-
- No remote mailbox sync.
|
|
71
|
-
- No read-only inspector UI yet.
|
|
72
|
-
- Hook notification depends on harness hook support and fires on the next user prompt, not as a real-time interrupt.
|
|
73
|
-
- The installer targets the first supported Codex and Claude config paths and may need more harness-specific hardening before a public release.
|
|
74
|
-
|
|
75
|
-
## MVP Complete Bar
|
|
76
|
-
|
|
77
|
-
Call the local MVP complete when:
|
|
78
|
-
|
|
79
|
-
- automated checks pass
|
|
80
|
-
- local demo passes
|
|
81
|
-
- manual install check passes on one machine
|
|
82
|
-
- at least one harness can see the MCP tools after install/restart
|
|
83
|
-
- hook notification is verified in that harness
|
|
84
|
-
- README and this checklist match the observed behavior
|
|
85
|
-
|