@mrciphersmith/keryx 0.2.88 → 0.2.94

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.
Files changed (4) hide show
  1. package/README.md +31 -0
  2. package/dist/cli.js +3365 -440
  3. package/dist/core.js +24 -1
  4. package/package.json +2 -2
package/README.md CHANGED
@@ -431,6 +431,37 @@ keryx integrate cursor # opt-in read-only MCP server
431
431
  Each of those commands has its own `--runtime` vocabulary — run
432
432
  `keryx <command> --help` for the values it accepts.
433
433
 
434
+ ### Using other people's MCP servers
435
+
436
+ The commands above install keryx *into* an editor as an MCP server. The
437
+ reverse also works: `keryx shell` connects out to MCP servers you configure,
438
+ and the model can use their tools.
439
+
440
+ ```bash
441
+ keryx mcp add fs -- npx -y @modelcontextprotocol/server-filesystem ~/notes
442
+ keryx mcp doctor fs # does it connect, how many tools, what got skipped
443
+ keryx mcp list # every server, its source, and whether it is disabled
444
+ ```
445
+
446
+ The model gets two tools — `search_tool` and `use_tool` — however many
447
+ servers you connect, rather than one registered tool per MCP tool: the
448
+ advertised surface stays a fixed cost instead of growing with your server
449
+ list. Every call goes through the same approval prompt as `shell_exec`, a
450
+ server is spawned without keryx's own credentials in its environment, and
451
+ `--scope project` writes a `.keryx/mcp-servers.json` you can commit while
452
+ `keryx mcp disable` stays personal to you.
453
+
454
+ Remote servers work the same way — `keryx mcp add linear --transport http
455
+ <url> --header 'Authorization: Bearer ${LINEAR_TOKEN}'` — and if that
456
+ variable is unset keryx refuses to dial rather than sending an empty bearer
457
+ and letting the server answer 401. It also refuses to follow a redirect
458
+ (your credential header would follow it) and refuses a credential written
459
+ into the URL itself. `keryx mcp doctor` names which of those it is, rather
460
+ than reporting one "failed".
461
+
462
+ OAuth and importing what you already configured in Cursor or Claude are
463
+ next.
464
+
434
465
  ## Requirements and compatibility
435
466
 
436
467
  | Requirement | Status |