@akms/mcp 0.2.0 → 0.2.1

package/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 All notable changes to `@akms/mcp`.
 
+## 0.2.1 — 2026-10-19
+
+### Documentation
+
+- Document the launcher's minimum setup and the required connection values and prerequisites for each MCP server.
+
 ## 0.2.0 — 2026-10-19
 
 ### Changed

package/README.md

@@ -41,6 +41,26 @@ akms-mcp s3 --target codex
 
 Use `--help` for the command reference and `--version` for the launcher's version.
 
+## Minimum working configuration
+
+The launcher needs **no environment variables or MCP server entry**. With Node.js 22+, npm and access to your configured npm registry, run:
+
+```sh
+npx -y --prefer-online @akms/mcp@latest
+```
+
+Choose a server and enter its connection values. The launcher opens the selected package's `config` menu; that package saves the MCP server entry for your AI client. Replace example names and credentials with your own. Each server package's README includes a **Minimum working configuration** section with a complete entry and its prerequisites.
+
+| Server | Minimum connection values | Prerequisites and defaults |
+|---|---|---|
+| Database | `DB_DRIVER=postgres`, `DB_HOST`, `DB_NAME`, `DB_USER`; `DB_PASSWORD` when password authentication is required | Reachable PostgreSQL database; port `5432`, TLS `require`. Set `DB_SSL=off` only for a database without TLS. Alternatively use `DB_DRIVER=postgres` with `DB_URL`. |
+| SSH | `SSH_HOST`, `SSH_USER`, plus `SSH_KEY` or `SSH_PASSWORD` | Reachable SSH server; port `22`. Omit both authentication fields only when the MCP process can use an SSH agent with an authorized key. |
+| WSL | `WSL_DISTRO` | Run the MCP client on Windows; the named distro must already be installed with `bash`. Uses the distro's default user. |
+| AWS S3 | `S3_BUCKET`, `S3_REGION`, `S3_AUTH=static`, `S3_ACCESS_KEY_ID`, `S3_SECRET_ACCESS_KEY` | Existing bucket and credentials permitted to access it; temporary credentials also need `S3_SESSION_TOKEN`. With an available AWS credential provider, omit the three static-auth fields. |
+| S3-compatible | `S3_BACKEND=compatible`, `S3_BUCKET`, `S3_ENDPOINT`, `S3_REGION`, `S3_AUTH=static`, `S3_ACCESS_KEY_ID`, `S3_SECRET_ACCESS_KEY` | Existing bucket, service endpoint, signing region and credentials. |
+
+For either S3 backend, `S3_LOCAL_ROOT` is needed only for local file upload/download; it must name an existing directory. Object listing, text reads/writes and deletion do not need it.
+
 ## Latest on every launch
 
 Each time you choose a server, the launcher queries npm for that package's `latest` tag, then runs the exact version returned. This applies even when you select the same server twice in one session. If the lookup fails, setup does not start with a cached older version. An internet connection to your configured npm registry is required.

package/lib/cli.js

@@ -745,7 +745,7 @@ async function main() {
   if (argumentsList.showVersion == true) {
     let version = "development";
     if (true) {
-      version = "0.2.0";
+      version = "0.2.1";
     }
     process.stdout.write(`${version}
 `);

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@akms/mcp",
-    "version": "0.2.0",
+    "version": "0.2.1",
     "description": "Interactive launcher for configuring the latest AKMS database, SSH, WSL and S3 MCP servers.",
     "keywords": ["mcp", "model-context-protocol", "cli", "setup", "akms"],
     "license": "MIT",