@appsoftwareltd/etherpk-mcp 0.1.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/LICENSE +95 -0
- package/README.md +46 -0
- package/bin/etherpk-mcp.js +2 -0
- package/dist/main.js +8544 -0
- package/dist/main.js.map +1 -0
- package/package.json +62 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
Elastic License 2.0
|
|
2
|
+
|
|
3
|
+
URL: https://www.elastic.co/licensing/elastic-license
|
|
4
|
+
|
|
5
|
+
## Acceptance
|
|
6
|
+
|
|
7
|
+
By using the software, you agree to all of the terms and conditions below.
|
|
8
|
+
|
|
9
|
+
## Copyright License
|
|
10
|
+
|
|
11
|
+
The licensor grants you a non-exclusive, royalty-free, worldwide,
|
|
12
|
+
non-sublicensable, non-transferable license to use, copy, distribute, make
|
|
13
|
+
available, and prepare derivative works of the software, in each case subject
|
|
14
|
+
to the limitations and conditions below.
|
|
15
|
+
|
|
16
|
+
## Limitations
|
|
17
|
+
|
|
18
|
+
You may not provide the software to third parties as a hosted or managed
|
|
19
|
+
service, where the service provides users with access to any substantial set of
|
|
20
|
+
the features or functionality of the software.
|
|
21
|
+
|
|
22
|
+
You may not move, change, disable, or circumvent the license key functionality
|
|
23
|
+
in the software, and you may not remove or obscure any functionality in the
|
|
24
|
+
software that is protected by the license key.
|
|
25
|
+
|
|
26
|
+
You may not alter, remove, or obscure any licensing, copyright, or other
|
|
27
|
+
notices of the licensor in the software. Any use of the licensor's trademarks
|
|
28
|
+
is subject to applicable law.
|
|
29
|
+
|
|
30
|
+
## Patents
|
|
31
|
+
|
|
32
|
+
The licensor grants you a license, under any patent claims the licensor can
|
|
33
|
+
license, or chooses to license, to make, have made, use, sell, offer for sale,
|
|
34
|
+
import and have imported the software, in each case subject to the limitations
|
|
35
|
+
and conditions in this license. This license does not cover any patent claims
|
|
36
|
+
that you cause to be infringed by modifications or additions to the software.
|
|
37
|
+
If you or your company make any written claim that the software infringes or
|
|
38
|
+
contributes to infringement of any patent, your patent license for the software
|
|
39
|
+
granted under these terms ends immediately. If your company makes such a claim,
|
|
40
|
+
your patent license ends immediately for work on behalf of your company.
|
|
41
|
+
|
|
42
|
+
## Notices
|
|
43
|
+
|
|
44
|
+
You must ensure that anyone who gets a copy of any part of the software from
|
|
45
|
+
you also gets a copy of these terms.
|
|
46
|
+
|
|
47
|
+
If you modify the software, you must include in any modified copies of the
|
|
48
|
+
software prominent notices stating that you have modified the software.
|
|
49
|
+
|
|
50
|
+
## No Other Rights
|
|
51
|
+
|
|
52
|
+
These terms do not imply any licenses other than those expressly granted in
|
|
53
|
+
these terms.
|
|
54
|
+
|
|
55
|
+
## Termination
|
|
56
|
+
|
|
57
|
+
If you use the software in violation of these terms, such use is not licensed,
|
|
58
|
+
and your licenses will automatically terminate. If the licensor provides you
|
|
59
|
+
with a notice of your violation, and you cease all violation of this license no
|
|
60
|
+
later than 30 days after you receive that notice, your licenses will
|
|
61
|
+
automatically be reinstated unless the licensor notifies you otherwise. If you
|
|
62
|
+
violate these terms after reinstatement, your licenses will automatically and
|
|
63
|
+
permanently terminate.
|
|
64
|
+
|
|
65
|
+
## No Liability
|
|
66
|
+
|
|
67
|
+
As far as the law allows, the software comes as is, without any warranty or
|
|
68
|
+
condition, and the licensor will not be liable to you for any damages arising
|
|
69
|
+
out of these terms or the use or nature of the software, under any kind of
|
|
70
|
+
legal claim.
|
|
71
|
+
|
|
72
|
+
## Definitions
|
|
73
|
+
|
|
74
|
+
The *licensor* is the entity offering these terms, and the *software* is the
|
|
75
|
+
software the licensor makes available under these terms, including any portion
|
|
76
|
+
of it.
|
|
77
|
+
|
|
78
|
+
*you* refers to the individual or entity agreeing to these terms.
|
|
79
|
+
|
|
80
|
+
*your company* is any legal entity, sole proprietorship, or other kind of
|
|
81
|
+
organization that you work for, plus all organizations that have control over,
|
|
82
|
+
are under the control of, or are under common control with that organization.
|
|
83
|
+
*control* means ownership of substantially all the assets of an entity, or the
|
|
84
|
+
power to direct its management and legal policies by vote, contract, or
|
|
85
|
+
otherwise. Control can be direct or indirect.
|
|
86
|
+
|
|
87
|
+
*your licenses* are all the licenses granted to you for the software under
|
|
88
|
+
these terms.
|
|
89
|
+
|
|
90
|
+
*use* includes copying, distributing, making available, modifying and, in each
|
|
91
|
+
case, also for the purposes of your internal business operations.
|
|
92
|
+
|
|
93
|
+
---
|
|
94
|
+
|
|
95
|
+
Copyright (c) 2026 App Software Ltd (https://www.appsoftware.com)
|
package/README.md
ADDED
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
# @appsoftwareltd/etherpk-mcp
|
|
2
|
+
|
|
3
|
+
The EtherPK **Headless Client**: an [MCP](https://modelcontextprotocol.io) server over one of
|
|
4
|
+
your synced [EtherPK](https://etherpk.com) knowledge graphs, run on the same computer as your AI
|
|
5
|
+
agent (Claude Code, Codex, Cursor and the like).
|
|
6
|
+
|
|
7
|
+
EtherPK's Sync Server never sees your notes in the clear, so nothing hosted can serve them to an
|
|
8
|
+
agent. This program signs in as one of your devices, holds your keys, keeps one graph in sync and
|
|
9
|
+
speaks MCP to the agent beside it. Protected documents are listed by name and never served.
|
|
10
|
+
|
|
11
|
+
Needs Node.js 22 or later.
|
|
12
|
+
|
|
13
|
+
## Set up
|
|
14
|
+
|
|
15
|
+
Open the graph in EtherPK, pick **Settings → Agents**, and copy the two commands it shows with your
|
|
16
|
+
server and graph filled in. They are:
|
|
17
|
+
|
|
18
|
+
```sh
|
|
19
|
+
# Once per computer. Prompts for an account-wide Personal Access Token (from your Sync
|
|
20
|
+
# Server's portal, Account → Tokens), then shows a short code to confirm in any unlocked
|
|
21
|
+
# EtherPK tab - the same step as adding a phone.
|
|
22
|
+
npx @appsoftwareltd/etherpk-mcp login --server https://sync.example.com
|
|
23
|
+
|
|
24
|
+
# Tell the agent about the graph (Claude Code shown; the Agents tab has the others).
|
|
25
|
+
claude mcp add etherpk -- npx @appsoftwareltd/etherpk-mcp serve --graph <graph id>
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
`npx @appsoftwareltd/etherpk-mcp graphs` lists the graphs the token can reach, by name and id.
|
|
29
|
+
On a computer with no EtherPK tab to hand, `login --recovery-code` takes your Recovery Code
|
|
30
|
+
instead (or `ETHERPK_RECOVERY_CODE` for a scripted setup; `ETHERPK_PAT` likewise).
|
|
31
|
+
|
|
32
|
+
## What the agent gets
|
|
33
|
+
|
|
34
|
+
`list_documents`, `read_document`, `search`, `backlinks`, `tasks`, `edit_document` (an exact,
|
|
35
|
+
unique old→new replacement that merges with anyone typing elsewhere on the page),
|
|
36
|
+
`append_document` (a page, or a day's journal entry, created if needed) and `create_page`.
|
|
37
|
+
One running instance serves one graph.
|
|
38
|
+
|
|
39
|
+
## Stopping it
|
|
40
|
+
|
|
41
|
+
Revoke the token at the portal to cut the agent off, and `npx @appsoftwareltd/etherpk-mcp logout`
|
|
42
|
+
to forget the token, keys and cached graphs on that computer. The keys live in
|
|
43
|
+
`~/.config/etherpk/mcp.json` and the cached graphs under `~/.cache/etherpk/mcp/`, both readable
|
|
44
|
+
only by your user - the same trust as a browser you have signed in on.
|
|
45
|
+
|
|
46
|
+
Full guide: <https://docs.etherpk.com/using-ai-agents-with-your-notes>.
|