Skip to content

Commit e59b991

Browse files
committed
README: More copy-editing, also following suggestions by CodeRabbit
1 parent d36cf59 commit e59b991

File tree

3 files changed

+16
-15
lines changed

3 files changed

+16
-15
lines changed

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
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
2525
retrieval specializes in CrateDB database clusters.
2626

2727
The Model Context Protocol ([MCP]) is a protocol that standardizes providing
@@ -48,11 +48,11 @@ Context Protocol (MCP), either using standard input/output (stdio),
4848
server-sent events (SSE), or HTTP Streams (streamable-http).
4949

5050
To 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

5454
The `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
5656
install 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
200200
the team, so you may also want to try them to get started. Please remember
201201
that 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

208208
Please 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
214214
this 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
218218
GitHub]. Contributions of any kind are welcome and appreciated.
219219
To 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.
224224
Version pinning is strongly recommended, especially if you use it as a library.
225225

226226

docs/backlog.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,15 @@
33
## Iteration +1
44
- README: Provide guidelines on how to create a CrateDB read-only user
55
- CLI: Honor `--read-only` option flag
6-
https://fluxcd.control-plane.io/mcp/config/
6+
- https://fluxcd.control-plane.io/mcp/config/
77
- Release v0.0.1
88

99
## Iteration +2
1010
- Migrate to FastAPI 2.0
1111
- https://gofastmcp.com/getting-started/welcome#fastmcp-2-0-and-the-official-mcp-sdk
1212
- https://gofastmcp.com/patterns/testing
1313
- Install: Others also just use `docker` right away?
14-
https://github.com/ppl-ai/modelcontextprotocol/?tab=readme-ov-file#step-3-configure-claude-desktop
14+
- https://github.com/ppl-ai/modelcontextprotocol/?tab=readme-ov-file#step-3-configure-claude-desktop
1515
- Ecosystem: Link to 3rd-party installation instructions?
1616
- https://code.visualstudio.com/docs/copilot/chat/mcp-servers#_add-an-mcp-server-to-your-workspace
1717
- https://docs.cline.bot/mcp/configuring-mcp-servers
@@ -26,7 +26,8 @@
2626
> For the best experience with the CrateDB MCP Server, it’s crucial to provide your
2727
> AI assistant with proper instructions on how to interact. [...] The CrateDB MCP Server
2828
> comes with a set of predefined instructions that you can copy from the `instructions.md` file.
29-
- Blueprint:
29+
30+
Blueprint:
3031
- https://fluxcd.io/blog/2025/05/ai-assisted-gitops/
3132
- https://fluxcd.control-plane.io/mcp/prompt-engineering/
3233
- https://raw.githubusercontent.com/controlplaneio-fluxcd/distribution/refs/heads/main/docs/mcp/instructions.md

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ requires = [
77

88
[project]
99
name = "cratedb-mcp"
10-
description = "CrateDB MCP Server for natural language Text-to-SQL and documentation retrieval."
10+
description = "CrateDB MCP Server for natural-language Text-to-SQL and documentation retrieval."
1111
readme = "README.md"
1212
keywords = [
1313
"cratedb",

0 commit comments

Comments
 (0)