diff --git a/README.md b/README.md index 0ffed4b..fc39bac 100644 --- a/README.md +++ b/README.md @@ -33,11 +33,6 @@ It serves as a bridge between AI tools and your analytics database, allowing you to analyze data, the cluster state, troubleshoot issues, and perform operations using conversational prompts. -## Documentation - -The project documentation is available at https://cratedb-mcp.readthedocs.io/. -It includes information on how to install and operate the package. - [development documentation]: https://cratedb-mcp.readthedocs.io/sandbox.html [managed on GitHub]: https://github.com/crate/cratedb-mcp @@ -77,6 +72,11 @@ It includes information on how to install and operate the package. +## Documentation + +The project documentation is available at https://cratedb-mcp.readthedocs.io/. +It includes information on how to install and operate the package. + ## Project information ### Acknowledgements diff --git a/docs/index.md b/docs/index.md index cd03832..4036062 100644 --- a/docs/index.md +++ b/docs/index.md @@ -7,13 +7,7 @@ :::{include} readme.md :start-line: 1 -:end-line: 79 -::: - -:::{note} -**Experimental:** Please note that the CrateDB MCP Server is an experimental -feature provided as-is without warranty or support guarantees. Enterprise -customers should use this feature at their own discretion. +:end-line: 74 ::: ## Quickstart Guide @@ -72,7 +66,7 @@ The CrateDB MCP Server provides two families of tools. talk to a CrateDB database cluster to inquire database and table metadata, and table content. -:Documentation server: +:Documentation inquiry: The tools `get_cratedb_documentation_index` and `fetch_cratedb_docs` look up guidelines specific to CrateDB topics, @@ -80,12 +74,18 @@ The CrateDB MCP Server provides two families of tools. Relevant information is pulled from , curated per [cratedb-outline.yaml] through the [cratedb-about] package. -:Health inquiry: +:Health status: The tool `get_cluster_health` returns cluster health information derived from CrateDB's system tables. ::: +:::{note} +**Experimental:** Please note that the CrateDB MCP Server is an experimental +feature provided as-is without warranty or support guarantees. Enterprise +customers should use this feature at their own discretion. +::: + :::{toctree} :caption: Handbook