Skip to content

Commit 911fe75

Browse files
authored
README: Add information about the CrateDB SQLAlchemy dialect (#12)
* README: Fix typo, and improve layout * README: Add information about the CrateDB SQLAlchemy dialect
1 parent 682fd2a commit 911fe75

File tree

1 file changed

+21
-3
lines changed

1 file changed

+21
-3
lines changed

README.md

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
**Status: Works great and is in daily use without any known bugs.**
44

5-
**Status2: I just added the package to PYPI and updated the usage instructions. Please report any issues :)**
5+
**Status2: I just added the package to PyPI and updated the usage instructions. Please report any issues :)**
66

77
Let Claude be your database expert! MCP Alchemy connects Claude Desktop directly to your databases, allowing it to:
88

@@ -12,7 +12,8 @@ Let Claude be your database expert! MCP Alchemy connects Claude Desktop directly
1212
- Analyze large datasets and create reports
1313
- Claude Desktop Can analyse and create artifacts for very large datasets using [claude-local-files](https://github.com/runekaagaard/claude-local-files).
1414

15-
Works with PostgreSQL, MySQL, MariaDB, SQLite, Oracle, MS SQL Server and a host of other [SQLAlchemy-compatible](https://docs.sqlalchemy.org/en/20/dialects/) databases.
15+
Works with PostgreSQL, MySQL, MariaDB, SQLite, Oracle, MS SQL Server, CrateDB,
16+
and a host of other [SQLAlchemy-compatible](https://docs.sqlalchemy.org/en/20/dialects/) databases.
1617

1718
![MCP Alchemy in action](https://raw.githubusercontent.com/runekaagaard/mcp-alchemy/refs/heads/main/screenshot.png)
1819

@@ -103,7 +104,24 @@ Add to your `claude_desktop_config.json`. You need to add the appropriate databa
103104
}
104105
```
105106

106-
Environment Variables:
107+
### CrateDB
108+
```json
109+
{
110+
"mcpServers": {
111+
"my_cratedb": {
112+
"command": "uvx",
113+
"args": ["--from", "mcp-alchemy~=2025.04", "--with", "sqlalchemy-cratedb>=0.42.0.dev1", "mcp-alchemy"],
114+
"env": {
115+
"DB_URL": "crate://user:password@localhost:4200/?schema=testdrive"
116+
}
117+
}
118+
}
119+
}
120+
```
121+
For connecting to CrateDB Cloud, use a URL like
122+
`crate://user:[email protected]:4200?ssl=true`.
123+
124+
## Environment Variables
107125

108126
- `DB_URL`: SQLAlchemy [database URL](https://docs.sqlalchemy.org/en/20/core/engines.html#database-urls) (required)
109127
- `CLAUDE_LOCAL_FILES_PATH`: Directory for full result sets (optional)

0 commit comments

Comments
 (0)