Skip to content

Commit e40820d

Browse files
committed
README adapted
1 parent 448461d commit e40820d

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919
Provides an LLM access to the Exasol database via MCP tools. Includes tools
2020
for reading the database metadata and executing data reading queries, and a
2121
tool for transforming natural language into SQL statements.
22+
2223

2324
## Disclaimer
2425

@@ -35,6 +36,7 @@ damage to any possible kind by using this software. Moreover, the Safe Harbour S
3536
end of this README shall remain valid.
3637

3738
__Do NOT use the MCP-Server with the Text-to-SQL option if you do not agree to these conditions!__
39+
3840

3941
## Introduction
4042

@@ -60,12 +62,14 @@ open source AI Desktops like Jan.ai.
6062
- If a result set is returned, the question, the SQL statement, and some metadata is stored in a VectorDB
6163
- If required, rewrites the question
6264
- Generates a result
65+
6366

6467
### Workflow of Text-to-SQL Agent
6568

6669
This is the workflow of the Text-to-SQL agent, coded with the langgraph library.
6770

6871
<img src="./langgraph_workflow.png" width="640" />
72+
6973

7074
## Prerequisites
7175

@@ -79,6 +83,7 @@ This is the workflow of the Text-to-SQL agent, coded with the langgraph library.
7983

8084
Preferable with GPU support. For accessing the servers the OpenAI API is used. You can use
8185
any other LLM server application which supports the OpenAI API.
86+
8287

8388
## Installation
8489

@@ -88,13 +93,15 @@ uv --version
8893
```
8994
To install `uv`, please follow [the instructions](https://docs.astral.sh/uv/getting-started/installation/)
9095
in the `uv` official documentation.
96+
9197

9298
### Remark
9399

94100
Do not configure the Exasol supported MCP server and this MCP server at the same time within the
95101
AI Desktop tool of your choice. This MCP server will use the same version numbers as the officially
96102
supported Exasol MCP-Server. Equal version numbers indicate the same functionality, plus the
97103
Text-to-SQL option.
104+
98105

99106
## Using the server with the Claude Desktop (and probably others).
100107

@@ -134,6 +141,10 @@ information about configuring the MCP server.
134141

135142
## Configuration settings
136143

144+
The configuration is split in two parts, one for the Exasol supported MCP-Server, and one
145+
for the text-to-sql option.
146+
147+
137148
### Original Settings for the Exasol MCP Server
138149

139150
Most importantly, the server configuration specifies if reading the data using SQL

0 commit comments

Comments
 (0)