Skip to content

Commit 8fd120d

Browse files
AUTO: Sync ScalarDB docs in English to docs site repo (#1617)
Co-authored-by: josh-wong <[email protected]>
1 parent fb0acd0 commit 8fd120d

File tree

1 file changed

+19
-19
lines changed

1 file changed

+19
-19
lines changed

docs/scalardb-mcp-server/getting-started-with-scalardb-mcp-server.mdx

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -25,23 +25,23 @@ At its core, ScalarDB MCP Server provides the following capabilities.
2525

2626
### ScalarDB connectivity
2727

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.
2929

3030
### Transactional operations
3131

3232
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.
3333

3434
### Operational mode
3535

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.
3737

3838
#### SQL mode
3939

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.
4141

4242
#### CRUD mode
4343

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.
4545

4646
### Deployment limitations
4747

@@ -99,7 +99,7 @@ The LLM automatically selects the appropriate tools based on your request—you
9999

100100
## Tutorial
101101

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.
103103

104104
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.
105105

@@ -185,7 +185,7 @@ scalar.db.cluster.node.licensing.license_key=
185185
scalar.db.cluster.node.licensing.license_check_cert_pem=
186186
```
187187

188-
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).
189189

190190
:::
191191

@@ -225,7 +225,7 @@ Docker flags:
225225

226226
:::note
227227

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).
229229

230230
:::
231231

@@ -234,7 +234,7 @@ The example above demonstrates a multi-storage configuration. For other ScalarDB
234234
Docker flags:
235235

236236
- `--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
238238

239239
:::
240240
</TabItem>
@@ -253,7 +253,7 @@ Docker flags:
253253
claude mcp add scalardb \
254254
-- java -jar /path/to/scalardb-mcp-server-0.9.0.jar \
255255
--scalar.mcp.db.server.tool.mode=SQL \
256-
--scalar.db.transaction_manager=indirect:localhost \
256+
--scalar.db.transaction_manager=cluster \
257257
--scalar.db.contact_points=indirect:localhost \
258258
--scalar.db.contact_port=60053
259259
```
@@ -290,7 +290,7 @@ scalar.db.cluster.node.licensing.license_key=
290290
scalar.db.cluster.node.licensing.license_check_cert_pem=
291291
```
292292

293-
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).
294294

295295
:::
296296
</TabItem>
@@ -320,7 +320,7 @@ For complete ScalarDB Cluster deployment and configuration instructions, see [Sc
320320

321321
:::note
322322

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).
324324

325325
:::
326326
</TabItem>
@@ -400,7 +400,7 @@ scalar.db.cluster.node.licensing.license_key=
400400
scalar.db.cluster.node.licensing.license_check_cert_pem=
401401
```
402402

403-
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).
404404

405405
:::
406406

@@ -409,7 +409,7 @@ For complete ScalarDB Cluster deployment and configuration instructions, see [Sc
409409
**Docker flags**
410410

411411
- `--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
413413

414414
:::
415415
</TabItem>
@@ -451,7 +451,7 @@ For complete ScalarDB Cluster deployment and configuration instructions, see [Sc
451451

452452
:::note
453453

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).
455455

456456
:::
457457

@@ -460,7 +460,7 @@ The example above demonstrates a multi-storage configuration. For other ScalarDB
460460
**Docker flags**
461461

462462
- `--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
464464

465465
:::
466466
</TabItem>
@@ -483,10 +483,10 @@ The example above demonstrates a multi-storage configuration. For other ScalarDB
483483
"args": [
484484
"-jar",
485485
"/path/to/scalardb-mcp-server-0.9.0.jar",
486-
"--scalar.mcp.db.server.tool.mode=SQL"
486+
"--scalar.mcp.db.server.tool.mode=SQL",
487487
"--scalar.db.transaction_manager=cluster",
488488
"--scalar.db.contact_points=indirect:localhost",
489-
"--scalar.db.contact_port=60053",
489+
"--scalar.db.contact_port=60053"
490490
],
491491
}
492492
}
@@ -525,7 +525,7 @@ scalar.db.cluster.node.licensing.license_key=
525525
scalar.db.cluster.node.licensing.license_check_cert_pem=
526526
```
527527

528-
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).
529529

530530
:::
531531
</TabItem>
@@ -564,7 +564,7 @@ For complete ScalarDB Cluster deployment and configuration instructions, see [Sc
564564

565565
:::note
566566

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).
568568

569569
:::
570570
</TabItem>

0 commit comments

Comments
 (0)