ed-mcp 0.3.0 → 0.4.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/README.md +67 -17
- package/dist/index.js +1933 -463
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -16,7 +16,7 @@ With ed-mcp, Claude can:
|
|
|
16
16
|
|
|
17
17
|
Inara, EDSM, Spansh, EDSY and the community wikis already have this data, and you can do all of this on their sites. ed-mcp does not replace them. It lets Claude use them together, with your game journal, in one conversation. Some commanders find it easier to ask a question in their own words than to use several sites.
|
|
18
18
|
|
|
19
|
-
ed-mcp runs on your computer. It keeps your plans and settings on your computer. It reads from Inara, EDSM, Frontier and Spansh, and it downloads game data from GitHub.
|
|
19
|
+
ed-mcp runs on your computer. It keeps your plans and settings on your computer, or in a sync folder that you choose. It reads from Inara, EDSM, Frontier and Spansh, and it downloads game data from GitHub.
|
|
20
20
|
|
|
21
21
|
ed-mcp is not affiliated with Frontier Developments, Inara, EDSM or Spansh.
|
|
22
22
|
|
|
@@ -77,20 +77,31 @@ Every account is optional. Without one, the tools for that service tell Claude w
|
|
|
77
77
|
| EDSM | Last known location, materials and cargo | Your API key (edsm.net, Settings, API Key) and commander name |
|
|
78
78
|
| Frontier | Current ship with engineering, location and fleet | A Frontier login in your browser. No key is necessary. |
|
|
79
79
|
|
|
80
|
-
To log in to Frontier, ask Claude "Log me in to Frontier". Claude gives you a link. Open the link and sign in. Then tell Claude that you are done. The login lasts 25 days. If you log in to ed-mcp on another computer, the old login ends.
|
|
80
|
+
To log in to Frontier, ask Claude "Log me in to Frontier". Claude gives you a link. Open the link and sign in. Then tell Claude that you are done. The login lasts 25 days. If you log in to ed-mcp on another computer, the old login ends. With a sync folder and password, one login serves every computer.
|
|
81
|
+
|
|
82
|
+
### Change your keys without a restart
|
|
83
|
+
|
|
84
|
+
Ask Claude "Open ed-mcp settings". ed-mcp opens a page in your browser. Enter your Inara and EDSM keys and commander names there, then press Save. The page explains where to find each key. The new keys apply at once.
|
|
85
|
+
|
|
86
|
+
Do not type a key into the chat. Use the page.
|
|
87
|
+
|
|
88
|
+
Keys that you set in Claude Desktop's settings form, or with `-e` in Claude Code, need a restart to change. They also win over keys that you saved on the page. To use the page for a service, leave that service's fields empty in the form.
|
|
89
|
+
|
|
90
|
+
To see where each key comes from, ask Claude "What are my ed-mcp settings?".
|
|
81
91
|
|
|
82
92
|
The game journal is the best source for most questions. It is on your computer and it is current while you play. Inara and EDSM show data from your last sync to them.
|
|
83
93
|
|
|
84
94
|
### All settings
|
|
85
95
|
|
|
86
|
-
| Setting
|
|
87
|
-
|
|
|
88
|
-
| `INARA_API_KEY`
|
|
89
|
-
| `INARA_CMDR`
|
|
90
|
-
| `EDSM_API_KEY`
|
|
91
|
-
| `EDSM_CMDR`
|
|
92
|
-
| `ED_JOURNAL_DIR`
|
|
93
|
-
| `
|
|
96
|
+
| Setting | Meaning |
|
|
97
|
+
| ---------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
98
|
+
| `INARA_API_KEY` | Your Inara API key |
|
|
99
|
+
| `INARA_CMDR` | Your in-game commander name |
|
|
100
|
+
| `EDSM_API_KEY` | Your EDSM API key |
|
|
101
|
+
| `EDSM_CMDR` | Your commander name on EDSM |
|
|
102
|
+
| `ED_JOURNAL_DIR` | The game journal folder. On Windows, the default is the game's folder. Use a full path or one that starts with `~`. |
|
|
103
|
+
| `ED_MCP_SYNC_DIR` | Optional. A folder that your sync service keeps in step between computers (see [Use ed-mcp on more than one computer](#use-ed-mcp-on-more-than-one-computer)). |
|
|
104
|
+
| `ED_MCP_SYNC_PASSWORD` | Optional. At least 12 characters. Encrypts your API keys and Frontier login. Use the same password on every computer. |
|
|
94
105
|
|
|
95
106
|
Inara needs both of its settings. EDSM needs both of its settings.
|
|
96
107
|
|
|
@@ -117,7 +128,41 @@ The journal tools warn you when the newest entry is more than 30 minutes old. Th
|
|
|
117
128
|
|
|
118
129
|
## Plans
|
|
119
130
|
|
|
120
|
-
Claude can save plans for you, for example a ship build with its modules, engineering and materials. Ask Claude to add items, mark them done, or export the plan as a Markdown file. To keep a plan in a project folder, export it as JSON and import it again later with `plan_import`. The plans stay
|
|
131
|
+
Claude can save plans for you, for example a ship build with its modules, engineering and materials. Ask Claude to add items, mark them done, or export the plan as a Markdown file. To keep a plan in a project folder, export it as JSON and import it again later with `plan_import`. The plans stay in `plans.json`, in the sync folder if you set one and in the settings folder if not (see [Your data](#your-data)).
|
|
132
|
+
|
|
133
|
+
## Use ed-mcp on more than one computer
|
|
134
|
+
|
|
135
|
+
Set a sync folder, and your plans and preferences follow you. Pick a folder that Google Drive, iCloud Drive, OneDrive or Syncthing keeps in step. In Claude Desktop, use the Sync folder field. In Claude Code, set `ED_MCP_SYNC_DIR`. Use the same folder on every computer.
|
|
136
|
+
|
|
137
|
+
What syncs:
|
|
138
|
+
|
|
139
|
+
- Plans and preferences always sync, in the sync folder.
|
|
140
|
+
- Your API keys and Frontier login sync only when you also set a sync password. ed-mcp encrypts them with it. Without a password, they stay on each computer.
|
|
141
|
+
- The cache and the journal do not sync. Each computer keeps its own.
|
|
142
|
+
|
|
143
|
+
The password must be at least 12 characters. Use the same password on every computer. A computer with a different password cannot read the keys.
|
|
144
|
+
|
|
145
|
+
If two computers change the same file before the sync service catches up, the service keeps both. It saves one as a "conflict copy". ed-mcp tells Claude when it sees one. Ask Claude "What is my ed-mcp settings status?", then keep the copy that you want and delete the other.
|
|
146
|
+
|
|
147
|
+
If the sync folder is not available (for example, your sync app is stopped), the plan and preference tools fail with a clear message. They do not fall back to a local copy. Searches that use your stored preferences also need the folder. Pass `use_preferences: false` to search without them.
|
|
148
|
+
|
|
149
|
+
ed-mcp also writes each plan as a Markdown file in the `plans` folder inside the sync folder. Claude on your phone cannot run ed-mcp, but it can read these files through the Google Drive connector.
|
|
150
|
+
|
|
151
|
+
**Claude Desktop and Claude Code on the same computer** share ed-mcp's data only when both have the same sync settings. Give Claude Code the same values as Claude Desktop:
|
|
152
|
+
|
|
153
|
+
```bash
|
|
154
|
+
claude mcp add ed-mcp -s user \
|
|
155
|
+
-e ED_MCP_SYNC_DIR=<folder> -e ED_MCP_SYNC_PASSWORD=<password> \
|
|
156
|
+
-- npx -y ed-mcp
|
|
157
|
+
```
|
|
158
|
+
|
|
159
|
+
Keys that you save on the settings page are then shared by both apps, with no restart. If the apps do not agree, the settings status tells Claude.
|
|
160
|
+
|
|
161
|
+
### Upgrading from 0.3
|
|
162
|
+
|
|
163
|
+
Newer versions keep your Frontier login with your other secrets. They do not move a login or keys from version 0.3. Run `capi_login` again, and enter your keys again, either on the settings page or in the environment as before. Then delete the old `capi-token.json` from the settings folder.
|
|
164
|
+
|
|
165
|
+
The `ED_MCP_PLANS` setting is no longer used. Plans are now in `plans.json` in the settings folder, or in the sync folder when one is set. Move your old plans file there, or use `plan_import`, then remove `ED_MCP_PLANS`.
|
|
121
166
|
|
|
122
167
|
## Preferences
|
|
123
168
|
|
|
@@ -150,12 +195,14 @@ The travel times come from about 1,300 timed trips in a commander's journals, fl
|
|
|
150
195
|
|
|
151
196
|
ed-mcp keeps these files on your computer:
|
|
152
197
|
|
|
153
|
-
| Data | File
|
|
154
|
-
| ---------------------------- |
|
|
155
|
-
| Plans | `plans.json`,
|
|
156
|
-
| Preferences | `preferences.json`
|
|
157
|
-
| Frontier login
|
|
158
|
-
| Game data and cached results | The cache folder
|
|
198
|
+
| Data | File |
|
|
199
|
+
| ---------------------------- | --------------------------------------------------------------------------- |
|
|
200
|
+
| Plans | `plans.json`, and a Markdown copy of each plan in `plans` |
|
|
201
|
+
| Preferences | `preferences.json` |
|
|
202
|
+
| API keys and Frontier login | `secrets.enc` with a sync password, `secrets.json` without. Readable only by you |
|
|
203
|
+
| Game data and cached results | The cache folder |
|
|
204
|
+
|
|
205
|
+
Plans, preferences and `secrets.enc` are in the sync folder when you set one. Otherwise they are in the settings folder. `secrets.json` is always in the settings folder. The cache folder is always on the computer.
|
|
159
206
|
|
|
160
207
|
The files are in these folders:
|
|
161
208
|
|
|
@@ -167,9 +214,12 @@ The files are in these folders:
|
|
|
167
214
|
|
|
168
215
|
ed-mcp sends your API keys only to the service that they belong to. On first use, it downloads game data from the coriolis-data and FDevIDs projects on GitHub: modules, blueprints and materials, and the ship and module data for build statistics. Then it looks for new versions once a week. To get new data at once, ask Claude to refresh the game data.
|
|
169
216
|
|
|
217
|
+
ed-mcp checks GitHub once a day for a newer release and tells Claude when one is available.
|
|
218
|
+
|
|
170
219
|
## More information
|
|
171
220
|
|
|
172
221
|
- [Tool reference](docs/tools.md): what each tool does, its inputs and its results.
|
|
222
|
+
- [Privacy](PRIVACY.md): what ed-mcp reads, what it sends, and to whom.
|
|
173
223
|
- [Contributing](CONTRIBUTING.md): development, releases and service registrations.
|
|
174
224
|
|
|
175
225
|
## Acknowledgements
|