2121
2222## About
2323
24- The CrateDB MCP Server for natural language Text-to-SQL and documentation
24+ The CrateDB MCP Server for natural- language Text-to-SQL and documentation
2525retrieval specializes in CrateDB database clusters.
2626
2727The Model Context Protocol ([ MCP] ) is a protocol that standardizes providing
@@ -48,11 +48,11 @@ Context Protocol (MCP), either using standard input/output (stdio),
4848server-sent events (SSE), or HTTP Streams (streamable-http).
4949
5050To use the MCP server, you need a [ client that supports] [ MCP clients ] the
51- protocol. The most notable ones are ChatGPT, Claude, Cline, Cursor, GitHub
52- Copilot, Mistral AI, OpenAI Agents SDK, Windsurf, and others.
51+ protocol. The most notable ones are ChatGPT, Claude, Cline Bot , Cursor,
52+ GitHub Copilot, Mistral AI, OpenAI Agents SDK, Windsurf, and others.
5353
5454The ` uvx ` launcher command is provided by the [ uv] package manager.
55- The [ installation docs] ( #install ) section includes guidelines how to
55+ The [ installation docs] ( #install ) section includes guidelines on how to
5656install it on your machine.
5757
5858#### Claude, Cursor, Windsurf
@@ -148,7 +148,7 @@ Notes:
148148 ``` shell
149149 {apt,brew,pipx,zypper} install uv
150150 ```
151- - We recommend to use ` uv tool install ` to install the program "user"-wide
151+ - We recommend using ` uv tool install ` to install the program "user"-wide
152152 into your environment so you can invoke it from anywhere across your terminal
153153 sessions or MCP client programs / AI assistants.
154154- If you are unable to use ` uv tool install ` , you can use ` uvx cratedb-mcp `
@@ -200,10 +200,10 @@ We collected a few example questions that have been tested and validated by
200200the team, so you may also want to try them to get started. Please remember
201201that LLMs can still hallucinate and give incorrect answers.
202202
203- * Optimize this query: "SELECT * FROM movies WHERE release_date > '2012-12-1' AND revenue"
204- * Tell me about the health of the cluster
205- * What is the storage consumption of my tables, give it in a graph.
206- * How can I format a timestamp column to '2019 Jan 21'.
203+ - Optimize this query: "SELECT * FROM movies WHERE release_date > '2012-12-1' AND revenue"
204+ - Tell me about the health of the cluster
205+ - What is the storage consumption of my tables, give it in a graph.
206+ - How can I format a timestamp column to '2019 Jan 21'?
207207
208208Please also explore the [ example questions] from another shared collection.
209209
@@ -214,13 +214,13 @@ Kudos to the authors of all the many software components and technologies
214214this project is building upon.
215215
216216### Contributing
217- The ` cratedb-mcp ` package is an open source project, and is [ managed on
217+ The ` cratedb-mcp ` package is an open- source project, and is [ managed on
218218GitHub] . Contributions of any kind are welcome and appreciated.
219219To learn how to set up a development sandbox, please refer to the
220220[ development documentation] .
221221
222222### Status
223- The software is in the alpha stage, please expect breaking changes.
223+ The software is in the alpha stage, so breaking changes may happen .
224224Version pinning is strongly recommended, especially if you use it as a library.
225225
226226
0 commit comments