You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+14-4Lines changed: 14 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -56,7 +56,7 @@ Before installing and running the KDB-X MCP Server, ensure you have met the foll
56
56
-[Cloned this repo](#clone-the-repository)
57
57
- A `KDB-X/KDB+` Service listening on a host and port that will be accessible to the MCP Server
58
58
- See examples - [KDB-X Setup](#kdb-x-setup) / [KDB+ Setup](#kdb-setup)
59
-
- KDB-X can be installed by signing up to the [KDB-X public preview](https://kdb-x.kx.com/sign-in) - see [KDB-X documentation](https://docs.kx.com/public-preview/kdb-x/home.htm) for supporting information
59
+
- KDB-X can be installed by signing up to the [KDB-X public preview](https://developer.kx.com/products/kdb-x/install) - see [KDB-X documentation](https://docs.kx.com/public-preview/kdb-x/home.htm) for supporting information
60
60
- Windows users can run the KDB-X MCP Server on Windows and connect to a local KDB-X database via WSL or remote KDB-X database running on Linux
61
61
- Windows users can run a local KDB-X database by installing KDB-X on [WSL](https://learn.microsoft.com/en-us/windows/wsl/install), and use the default [streamable-http transport](#transport-options) when running the [KDB-X MCP Server](#run-the-server) - both share the same localhost network.
62
62
- For details on KDB-X usage restrictions see [documentation](https://docs.kx.com/product/licensing/usage-restrictions.htm#kdb-x-personal-trial-download)
@@ -67,7 +67,7 @@ Before installing and running the KDB-X MCP Server, ensure you have met the foll
67
67
-`npx` comes bundled with the [nodejs](https://nodejs.org/en) installer - available on Windows/Mac/Linux/WSL
68
68
- See [example configuration with streamable-http](#example-configuration-with-streamable-http)
69
69
70
-
> Note: ⚠️ KDB-X public preview has recently been extended. If you have installed KDB-X prior to Sept 30th 2025, you will receive an email notification about this update. Please update to the latest [KDB-X](https://kdb-x.kx.com/sign-in) to ensure uninterrupted access, valid through January 4, 2026
70
+
> Note: ⚠️ KDB-X public preview has recently been extended. If you have installed KDB-X prior to Sept 30th 2025, you will receive an email notification about this update. Please update to the latest [KDB-X](https://developer.kx.com/products/kdb-x/install) to ensure uninterrupted access, valid through 31st Dec 2025
71
71
72
72
## Quickstart
73
73
@@ -88,7 +88,7 @@ To demonstrate basic usage of the KDB-X MCP Server, using an empty KDB-X databas
88
88
2. Load the ai and sql interfaces.
89
89
90
90
```q
91
-
\l ai-libs/init.q
91
+
.ai:use`kx.ai
92
92
.s.init[]
93
93
```
94
94
@@ -519,9 +519,19 @@ The below tools can aid in the development, testing and debugging of new MCP too
519
519
520
520
## Troubleshooting
521
521
522
+
### Failed to import pykx
523
+
524
+
The KDB-X MCP Server requires a valid KDB-X license to operate.
525
+
526
+
If you see an error like "Failed to import pykx", verify the following:
527
+
528
+
- The `QLIC` environment variable is set and points to your license directory
529
+
- Your license directory contains a valid license file
530
+
- Your license has not expired
531
+
522
532
### KDB-X license expired
523
533
524
-
KDB-X public preview has recently been extended. If you have installed KDB-X prior to Sept 30th 2025, you will receive an email notification about this update. Please update to the latest [KDB-X](https://kdb-x.kx.com/sign-in) to ensure uninterrupted access, valid through January 4, 2026
534
+
KDB-X public preview has recently been extended. If you have installed KDB-X prior to Sept 30th 2025, you will receive an email notification about this update. Please update to the latest [KDB-X](https://developer.kx.com/products/kdb-x/install) to ensure uninterrupted access, valid through 31st Dec 2025
self.logger.info(f"KDB-X connectivity check with 'tls={self.db_config.tls}': SUCCESS - {self.db_config.host}:{self.db_config.port} is accessible. You are running {kdb_type} version: {kdb_version}")
79
99
80
100
# check if sql interface is loaded on KDB-X service
self.logger.warning("KDB-X AI Libs check: NOT AVAILABLE - AI-powered tools (similarity_search, hybrid_search) will be disabled.")
91
-
self.logger.warning("To enable AI tools, load the KDB-X AI libraries by running: \l ai-libs/init.q in your KDB-X Session and then restart the MCP server")
110
+
111
+
# check if KDB-X version supports loading AI libs as a module
self.logger.warning("KDB-X AI Libs check: NOT AVAILABLE - AI-powered tools (similarity_search, hybrid_search) will be disabled.")
114
+
self.logger.warning(f"To use AI tools, you need at least KDB-X version '0.1.2'. Your version is '{kdb_version}'. Please update to the latest KDB-X version.")
115
+
elifkdb_type=="KDB+":
116
+
self.logger.warning("KDB-X AI Libs check: NOT AVAILABLE - AI-powered tools (similarity_search, hybrid_search) are only available in KDB-X.")
117
+
else:
118
+
self.logger.warning("KDB-X AI Libs check: NOT LOADED - AI-powered tools (similarity_search, hybrid_search) will be disabled.")
119
+
self.logger.warning(r"To enable AI tools, load the KDB-X AI libraries by running: .ai:use`kx.ai in your KDB-X Session and then restart the MCP server")
92
120
else:
93
121
self.logger.info("KDB-X AI Libs check: SUCCESS - AI Libs are loaded, AI tools will be available")
0 commit comments