Skip to content

Commit b98b4c0

Browse files
Revise README for ScalarDB MCP Server details (#1)
* Revise README for ScalarDB MCP Server details Updated README to provide detailed information about ScalarDB MCP Server, its features, quickstart guide, and version compatibility. * Add missing image * Update README.md Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> * Remove duplicated link --------- Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
1 parent 7f66f9f commit b98b4c0

File tree

2 files changed

+54
-2
lines changed

2 files changed

+54
-2
lines changed

README.md

Lines changed: 54 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,55 @@
1-
# Standard repository template
1+
# ScalarDB MCP Server
22

3-
The purpose of this repository template is to streamline the creation of commonly used files when we create new repositories.
3+
ScalarDB MCP Server is a [Model Context Protocol (MCP)](https://modelcontextprotocol.io/) implementation that enables LLMs to access and manage your data through ScalarDB. By leveraging LLMs, you can use natural language to search and update across multiple, potentially siloed, databases.
4+
5+
## What is ScalarDB MCP Server?
6+
7+
ScalarDB MCP Server works seamlessly whether you're using a single database or multiple databases. Unlike traditional approaches that require separate MCP servers for each database, ScalarDB MCP Server leverages the [multi-storage capabilities of ScalarDB](https://scalardb.scalar-labs.com/docs/latest/multi-storage-transactions) to provide unified access to heterogeneous databases (PostgreSQL, MySQL, Cosmos DB, DynamoDB, etc.) through a single MCP server. By simply submitting queries in natural language, the server automatically executes the appropriate operations across your databases, improving and accelerating decision-making processes.
8+
9+
<img src="docs/images/architecture.png" alt="ScalarDB MCP Server Architecture" width="400">
10+
11+
### Key features
12+
13+
- **Works with single or multiple databases:** Whether you have one database or many databases managed by ScalarDB, ScalarDB MCP Server provides a unified natural language interface.
14+
- **AI-powered automation:** Use conversational queries—the LLM automatically generates and executes the appropriate database operations.
15+
- **ACID-compliant transactions:** Maintain data integrity with full transactional support across databases.
16+
- **Dual operational modes:** SQL mode for ScalarDB Cluster (leveraging the SQL interface) or CRUD mode for ScalarDB Community edition (by using ScalarDB Core).
17+
18+
## Docs
19+
20+
* **[Getting Started with ScalarDB MCP Server](https://scalardb.scalar-labs.com/docs/latest/scalardb-mcp-server/getting-started):** Installation and quickstart guide
21+
* **[ScalarDB MCP Server Tools Reference](https://scalardb.scalar-labs.com/docs/latest/scalardb-mcp-server/tools-reference):** Complete documentation of all available MCP tools
22+
23+
## Quickstart
24+
25+
Get started with ScalarDB MCP Server in three steps:
26+
27+
1. **Install:** Download the Docker image or JAR file.
28+
2. **Configure:** Connect to your ScalarDB deployment and MCP client.
29+
3. **Use:** Start querying your databases by using natural language.
30+
31+
For complete installation and setup instructions, see [Getting Started with ScalarDB MCP Server](https://scalardb.scalar-labs.com/docs/latest/scalardb-mcp-server/getting-started).
32+
33+
**Example queries once configured:**
34+
35+
- `Show me all users from the customer table`
36+
- `Create a new table called products with columns id, name, and price`
37+
- `Get user profile and order history for user ID 123`
38+
39+
## ScalarDB version compatibility
40+
41+
| ScalarDB MCP Server | ScalarDB Community | ScalarDB Cluster | Java Version |
42+
|---------------------|--------------------|------------------|--------------|
43+
| 0.9.x | 3.16+ | 3.16+ | 17+ |
44+
45+
**Note about operational mode:**
46+
- **ScalarDB Cluster:** Use SQL mode for efficient operations (recommended) or CRUD mode for granular control.
47+
- **ScalarDB Community edition:** Use CRUD mode only (SQL interface not available).
48+
49+
### Reporting issues
50+
51+
If you find a bug or have a feature request, please [open an issue](https://github.com/scalar-labs/scalardb-mcp-server/issues).
52+
53+
## Community
54+
55+
- **[ScalarDB Documentation](https://scalardb.scalar-labs.com/):** Learn more about ScalarDB.

docs/images/architecture.png

93.3 KB
Loading

0 commit comments

Comments
 (0)