notex-companion 0.2.1 → 0.3.1
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 +9 -5
- package/dist/cli.js +33997 -701
- package/dist/client.js +3 -1
- package/dist/graph.d.ts +3 -0
- package/dist/headShaCache.d.ts +2 -0
- package/dist/index.js +6 -2
- package/dist/mcp.d.ts +4 -1
- package/dist/mcpTools.d.ts +36 -0
- package/dist/notexClient.d.ts +43 -0
- package/dist/notexConfig.d.ts +17 -0
- package/dist/retrievalLog.d.ts +5 -0
- package/dist/types.d.ts +5 -0
- package/package.json +6 -2
package/README.md
CHANGED
|
@@ -2,8 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
A local retrieval companion for [Notex](https://github.com/bhirmbani/notex). It reads a checkout's
|
|
4
4
|
`graphify-out/graph.json` and serves deterministic search/query/path/node lookups over it — to the
|
|
5
|
-
Notex browser page over loopback HTTP, and
|
|
6
|
-
lands) to an MCP host over stdio.
|
|
5
|
+
Notex browser page over loopback HTTP, and to an MCP host over stdio.
|
|
7
6
|
|
|
8
7
|
## What it reads
|
|
9
8
|
|
|
@@ -42,10 +41,15 @@ of starting a broken server.
|
|
|
42
41
|
|
|
43
42
|
```bash
|
|
44
43
|
notex-companion [serve] [options] # start the loopback HTTP server — the default command
|
|
45
|
-
notex-companion mcp # start the stdio MCP server
|
|
46
|
-
#
|
|
44
|
+
notex-companion mcp # start the stdio MCP server — graph_status, graph_search,
|
|
45
|
+
# graph_query, graph_path, graph_node, plus notex_list_questions,
|
|
46
|
+
# notex_get_question, notex_get_answer, notex_save_answer
|
|
47
|
+
# (require .notex/notex.json — see docs/specs/notex-mcp-server.md)
|
|
47
48
|
```
|
|
48
49
|
|
|
50
|
+
Setup, how it picks which checkout to serve, and a manual verification walkthrough:
|
|
51
|
+
[`docs/testing/mcp-server-setup.md`](https://github.com/bhirmbani/notex/blob/main/docs/testing/mcp-server-setup.md).
|
|
52
|
+
|
|
49
53
|
### `serve` options
|
|
50
54
|
|
|
51
55
|
| Flag | Default | Meaning |
|
|
@@ -63,7 +67,7 @@ browser's `localStorage`, keyed by Repository, and it is never sent to the Notex
|
|
|
63
67
|
|
|
64
68
|
## `apiVersion`
|
|
65
69
|
|
|
66
|
-
`ping` and every op response report `apiVersion` (currently `0.1
|
|
70
|
+
`ping` and every op response report `apiVersion` (currently `0.2.1`). Compatibility rule — see
|
|
67
71
|
[`companion-api.md` §1.1](https://github.com/bhirmbani/notex/blob/main/docs/specs/companion-api.md#11-apiversion-compatibility-rule-decided-by-tbr-66)
|
|
68
72
|
for the full rationale:
|
|
69
73
|
|