@zktx.io/sui-mcp 0.8.0 → 0.8.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 CHANGED
@@ -31,14 +31,16 @@ Users can ask ordinary questions:
31
31
 
32
32
  Install once with npm, then register the command in each AI app. You need [Node.js 22 or newer](https://nodejs.org/en/download), including npm. No Git checkout, build, custom installation folder, database server, Sui API key or endpoint setup is required for the normal path.
33
33
 
34
- This guide describes **0.8.0**. First confirm it is published, then install that exact version:
34
+ Already used an earlier release? Follow [Updating an Existing Sui MCP Installation](docs/MCP_SETUP.md#updating-an-existing-sui-mcp-installation) first. New installations can continue below.
35
+
36
+ This guide describes **0.8.1**. First confirm it is published, then install that exact version:
35
37
 
36
38
  ```sh
37
- npm view @zktx.io/sui-mcp@0.8.0 version
38
- npm install -g @zktx.io/sui-mcp@0.8.0
39
+ npm view @zktx.io/sui-mcp@0.8.1 version
40
+ npm install -g @zktx.io/sui-mcp@0.8.1
39
41
  ```
40
42
 
41
- The first command must return `0.8.0`. If it is unavailable, follow the [version availability guidance](docs/MCP_SETUP.md#npm-command-returns-404); do not drop the version and assume an older release matches this guide. Contributors can use the optional [developer checkout](docs/MCP_SETUP.md#developer-checkout-setup).
43
+ The first command must return `0.8.1`. If it is unavailable, follow the [version availability guidance](docs/MCP_SETUP.md#npm-command-returns-404); do not drop the version and assume an older release matches this guide. Contributors can use the optional [developer checkout](docs/MCP_SETUP.md#developer-checkout-setup).
42
44
 
43
45
  Register the installed command in your app. This is the complete default configuration for Claude Desktop; Cursor's example is in the setup guide:
44
46
 
@@ -66,7 +68,7 @@ Keep existing settings and other servers when adding these entries. Choose your
66
68
  - [Claude Code](docs/MCP_SETUP.md#claude-code)
67
69
  - [Cursor](docs/MCP_SETUP.md#cursor)
68
70
 
69
- After the app loads the registration, ask: **"Use Sui MCP to show its package name, server name, version and network."** Expect `@zktx.io/sui-mcp`, `sui-mcp`, `0.8.0` and `mainnet`. Then ask: **"Use Sui MCP to list the available DeepBook pools on Sui mainnet."** This first read needs no wallet or transaction. The [first-use tutorial](docs/MCP_SETUP.md#first-use-flow) explains expected results, optional cards and wallet connection. If the app cannot find `sui-mcp`, use [Command not found](docs/MCP_SETUP.md#command-not-found).
71
+ After the app loads the registration, ask: **"Use Sui MCP to show its package name, server name, version and network."** Expect `@zktx.io/sui-mcp`, `sui-mcp`, `0.8.1` and `mainnet`. Then ask: **"Use Sui MCP to list the available DeepBook pools on Sui mainnet."** This first read needs no wallet or transaction. The [first-use tutorial](docs/MCP_SETUP.md#first-use-flow) explains expected results, optional cards and wallet connection. If the app cannot find `sui-mcp`, use [Command not found](docs/MCP_SETUP.md#command-not-found).
70
72
 
71
73
  ### Using several apps at once
72
74
 
@@ -82,10 +84,14 @@ your client registration.
82
84
 
83
85
  Use the full scoped package name: the unscoped `sui-mcp` package is a different
84
86
  project. Use `sui-mcp` as the default MCP registration name. A client-defined registration
85
- alias is a local label, not server identity or authorization. Compatible
86
- updates preserve the current data directory. Incompatible databases and backups
87
- are rejected without conversion, and files are left in place. Data from a
88
- different package is not discovered or imported. See the
87
+ alias is a local label, not server identity or authorization. This is a
88
+ pre-release: local data formats can change, and migration is not provided.
89
+ Compatible updates preserve the current data directory. Incompatible databases
90
+ and backups are rejected without conversion or automatic deletion. If startup
91
+ reports a database format mismatch, follow the [recovery instructions](docs/MCP_SETUP.md#database-format-mismatch).
92
+ You can retain the old files and use a new empty data directory, or explicitly
93
+ choose to discard the old local data and settings and start fresh with defaults.
94
+ Data from a different package is not discovered or imported. See the
89
95
  [setup guide](docs/MCP_SETUP.md#switching-the-installed-package) for installation
90
96
  and shared-server restart instructions.
91
97
 
@@ -1,6 +1,6 @@
1
1
  import Database from "better-sqlite3";
2
2
  import { EXTERNAL_ACTIVITY_SCAN_MAX_LIMIT } from "./activityStore.js";
3
- import { ActivityStoreError } from "./sqliteActivityStoreTypes.js";
3
+ import { ActivityDatabaseFormatError } from "./sqliteActivityStoreTypes.js";
4
4
  import { SETTINGS_RESET_PREPARATION_SQL } from "../session/settingsPreparationSql.js";
5
5
  import { WALLET_CHAINS } from "../session/chainAccounts.js";
6
6
  import { LIVE_REVIEW_SESSION_INSERT_TRIGGER, LIVE_REVIEW_SESSION_UPDATE_TRIGGER, LIVE_REVIEW_SESSION_WRITE_CONTRACT_VERSION } from "../session/liveReviewSessionContract.js";
@@ -393,7 +393,7 @@ export function assertCurrentDatabaseFormat(db) {
393
393
  return "empty";
394
394
  if (signature === expectedSchemaSignature())
395
395
  return "current";
396
- throw new ActivityStoreError("Local database format does not match this runtime. Use a new empty SUI_MCP_DATA_DIR; existing data is not converted or deleted.");
396
+ throw new ActivityDatabaseFormatError();
397
397
  }
398
398
  export function initializeDatabase(db) {
399
399
  if (assertCurrentDatabaseFormat(db) === "current")
@@ -3,3 +3,12 @@ export class ActivityStoreError extends Error {
3
3
  super(message);
4
4
  }
5
5
  }
6
+ export class ActivityDatabaseFormatError extends ActivityStoreError {
7
+ static recoveryMessage = "Local database format does not match this runtime. Data migration is not supported. " +
8
+ "The existing database was not modified or deleted. Stop Sui MCP in every app, then follow " +
9
+ "docs/MCP_SETUP.md#database-format-mismatch. Keep the old data and use a new empty SUI_MCP_DATA_DIR, " +
10
+ "or explicitly choose to delete the old local data and settings before restarting.";
11
+ constructor() {
12
+ super(ActivityDatabaseFormatError.recoveryMessage);
13
+ }
14
+ }