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: docs/scalardb-mcp-server/getting-started-with-scalardb-mcp-server.mdx
+19-19Lines changed: 19 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -25,23 +25,23 @@ At its core, ScalarDB MCP Server provides the following capabilities.
25
25
26
26
### ScalarDB connectivity
27
27
28
-
The MCP server connects to your ScalarDB deployment (either ScalarDB Cluster or ScalarDB direct-to-database mode) and handles all technical complexity while providing AI assistants with simple, standardized tools.
28
+
The MCP server internally uses the ScalarDB Core library or connects to your ScalarDB Cluster through the client library, depending on settings. This means users don't need to know how to use the libraries to interact with ScalarDB.
29
29
30
30
### Transactional operations
31
31
32
32
ScalarDB MCP Server supports ACID-compliant transactions, allowing an LLM to execute multiple operations safely. When the LLM determines that operations should be grouped together, the MCP server ensures the operations either all succeed or all fail together, maintaining data integrity across your databases.
33
33
34
34
### Operational mode
35
35
36
-
ScalarDB MCP Server supports two operational modes that match your ScalarDB deployment type: SQL mode and CRUD mode.
36
+
ScalarDB MCP Server supports two operational modes that match your ScalarDB component: SQL mode and CRUD mode.
37
37
38
38
#### SQL mode
39
39
40
-
SQL mode with ScalarDB Cluster provides a SQL interface for database operations. When you make natural language requests, the LLM automatically generates and executes SQL commands through the supported SQL operations in ScalarDB and handles transactions by using standard SQL syntax (`BEGIN`, `COMMIT`, `ROLLBACK`). This mode could be more efficient because the LLM only needs to use one tool to perform all operations.
40
+
SQL mode with ScalarDB Cluster provides a SQL interface for database operations. When you make natural language requests, the LLM automatically generates and executes SQL commands through the supported SQL operations in ScalarDB and handles transactions by using standard SQL syntax (`BEGIN`, `COMMIT`, `ROLLBACK`). This mode could be more efficient because the LLM only needs to use one tool to perform all operations. SQL mode is available only with ScalarDB Cluster.
41
41
42
42
#### CRUD mode
43
43
44
-
CRUD mode with ScalarDB Core is for when you prefer programmatic control over your operations. Since ScalarDB Core doesn't include the SQL interface, this mode uses the native SDK operations in ScalarDB instead. The LLM converts your natural language requests into appropriate SDK calls by using individual tools for schema management, CRUD operations, and explicit transaction control. This mode could be less efficient because the LLM has to work with multiple tools to complete operations.
44
+
CRUD mode is used when you want programmatic control over your operations. Since ScalarDB Core doesn't include the SQL interface, this mode uses the native SDK operations in ScalarDB instead. The LLM converts your natural language requests into appropriate SDK calls by using individual tools for schema management, CRUD operations, and explicit transaction control. This mode could be less efficient because the LLM has to work with multiple tools to complete operations.
45
45
46
46
### Deployment limitations
47
47
@@ -99,7 +99,7 @@ The LLM automatically selects the appropriate tools based on your request—you
99
99
100
100
## Tutorial
101
101
102
-
The following configuration samples use the same Cassandra and MySQL multi-storage configuration as our[Multi-Storage Transaction Sample](../scalardb-samples/multi-storage-transaction-sample/). You can follow that hands-on tutorial to set up your databases, then use the same setup to test the MCP server with this tutorial.
102
+
The following configuration samples use the same Cassandra and MySQL multi-storage configuration as the[Multi-Storage Transaction Sample](../scalardb-samples/multi-storage-transaction-sample/README.mdx). You can follow that hands-on tutorial to set up your databases, then use the same setup to test the MCP server with this tutorial.
103
103
104
104
Configurations may vary depending on your specific MCP client and database environment. Refer to your MCP client's documentation for detailed setup instructions on how to add a connection to an MCP server.
For complete ScalarDB Cluster deployment and configuration instructions, see [ScalarDB Cluster Configurations](../scalardb-cluster/scalardb-cluster-configurations/). For a hands-on setup guide with multi-storage, see the [Multi-Storage Transaction Sample](../scalardb-samples/multi-storage-transaction-sample/).
188
+
For complete ScalarDB Cluster deployment and configuration instructions, see [ScalarDB Cluster Configurations](../scalardb-cluster/scalardb-cluster-configurations.mdx). For a hands-on setup guide with multi-storage, see the [Multi-Storage Transaction Sample](../scalardb-samples/multi-storage-transaction-sample/README.mdx).
189
189
190
190
:::
191
191
@@ -225,7 +225,7 @@ Docker flags:
225
225
226
226
:::note
227
227
228
-
The example above demonstrates a multi-storage configuration. For other ScalarDB Core configuration options, see [ScalarDB Configurations](../configurations/).
228
+
The example above demonstrates a multi-storage configuration. For other ScalarDB Core configuration options, see [ScalarDB Configurations](../configurations.mdx).
229
229
230
230
:::
231
231
@@ -234,7 +234,7 @@ The example above demonstrates a multi-storage configuration. For other ScalarDB
234
234
Docker flags:
235
235
236
236
-`--rm`: Required to automatically remove the container after the MCP client disconnects
237
-
-`--name`: Required to prevent ghost container instances from accumulating
237
+
-`--name`: Required to prevent dangling container instances from accumulating
For complete ScalarDB Cluster deployment and configuration instructions, see [ScalarDB Cluster Configurations](../scalardb-cluster/scalardb-cluster-configurations/). For a hands-on setup guide with multi-storage, see the [Multi-Storage Transaction Sample](../scalardb-samples/multi-storage-transaction-sample/).
293
+
For complete ScalarDB Cluster deployment and configuration instructions, see [ScalarDB Cluster Configurations](../scalardb-cluster/scalardb-cluster-configurations.mdx). For a hands-on setup guide with multi-storage, see the [Multi-Storage Transaction Sample](../scalardb-samples/multi-storage-transaction-sample/README.mdx).
294
294
295
295
:::
296
296
</TabItem>
@@ -320,7 +320,7 @@ For complete ScalarDB Cluster deployment and configuration instructions, see [Sc
320
320
321
321
:::note
322
322
323
-
The example above demonstrates a multi-storage configuration. For other ScalarDB Core configuration options, see [ScalarDB Configurations](../configurations/).
323
+
The example above demonstrates a multi-storage configuration. For other ScalarDB Core configuration options, see [ScalarDB Configurations](../configurations.mdx).
For complete ScalarDB Cluster deployment and configuration instructions, see [ScalarDB Cluster Configurations](../scalardb-cluster/scalardb-cluster-configurations/). For a hands-on setup guide with multi-storage, see the [Multi-Storage Transaction Sample](../scalardb-samples/multi-storage-transaction-sample/).
403
+
For complete ScalarDB Cluster deployment and configuration instructions, see [ScalarDB Cluster Configurations](../scalardb-cluster/scalardb-cluster-configurations.mdx). For a hands-on setup guide with multi-storage, see the [Multi-Storage Transaction Sample](../scalardb-samples/multi-storage-transaction-sample/README.mdx).
404
404
405
405
:::
406
406
@@ -409,7 +409,7 @@ For complete ScalarDB Cluster deployment and configuration instructions, see [Sc
409
409
**Docker flags**
410
410
411
411
-`--rm`: Required to automatically remove the container after the MCP client disconnects
412
-
-`--name`: Required to prevent ghost container instances from accumulating
412
+
-`--name`: Required to prevent dangling container instances from accumulating
413
413
414
414
:::
415
415
</TabItem>
@@ -451,7 +451,7 @@ For complete ScalarDB Cluster deployment and configuration instructions, see [Sc
451
451
452
452
:::note
453
453
454
-
The example above demonstrates a multi-storage configuration. For other ScalarDB Core configuration options, see [ScalarDB Configurations](../configurations/).
454
+
The example above demonstrates a multi-storage configuration. For other ScalarDB Core configuration options, see [ScalarDB Configurations](../configurations.mdx).
455
455
456
456
:::
457
457
@@ -460,7 +460,7 @@ The example above demonstrates a multi-storage configuration. For other ScalarDB
460
460
**Docker flags**
461
461
462
462
-`--rm`: Required to automatically remove the container after the MCP client disconnects
463
-
-`--name`: Required to prevent ghost container instances from accumulating
463
+
-`--name`: Required to prevent dangling container instances from accumulating
464
464
465
465
:::
466
466
</TabItem>
@@ -483,10 +483,10 @@ The example above demonstrates a multi-storage configuration. For other ScalarDB
For complete ScalarDB Cluster deployment and configuration instructions, see [ScalarDB Cluster Configurations](../scalardb-cluster/scalardb-cluster-configurations/). For a hands-on setup guide with multi-storage, see the [Multi-Storage Transaction Sample](../scalardb-samples/multi-storage-transaction-sample/).
528
+
For complete ScalarDB Cluster deployment and configuration instructions, see [ScalarDB Cluster Configurations](../scalardb-cluster/scalardb-cluster-configurations.mdx). For a hands-on setup guide with multi-storage, see the [Multi-Storage Transaction Sample](../scalardb-samples/multi-storage-transaction-sample/README.mdx).
529
529
530
530
:::
531
531
</TabItem>
@@ -564,7 +564,7 @@ For complete ScalarDB Cluster deployment and configuration instructions, see [Sc
564
564
565
565
:::note
566
566
567
-
The example above demonstrates a multi-storage configuration. For other ScalarDB Core configuration options, see [ScalarDB Configurations](../configurations/).
567
+
The example above demonstrates a multi-storage configuration. For other ScalarDB Core configuration options, see [ScalarDB Configurations](../configurations.mdx).
0 commit comments