documentation tab

app.py

@@ -30,13 +30,54 @@ example_end = "2019-06-17T02:54:00"
 
 with gr.Blocks() as demo:
     gr.Markdown("# TimescaleDB Time Series Analyzer API (Gradio)")
+    with gr.Tab("About"):
+        gr.Markdown("""
+# mcp-tscontext
+
+**mcp-tscontext** is a time series analysis tool designed for use with TimescaleDB.
+Its goal is to provide a textual context about time series.
+The idea is to provide a tool to an Agent to make it possible to better
+understand the context when a user asks a question.
+Built with Gradio, provides a mcp server.
+
+My main use Case:
+
+- provide an assistant to operators in charge of supervising industrial systems
+(like a power plant). Combine this tool with RAG on technical documentation.
+
+Other use case ideas:
+
+- Build a personal assistant that could be aware of health metrics provided by a
+smartwatch.
+
+## Features
+
+- **Database Connection**: Connect to a TimescaleDB instance or use a mock SQLite database for testing.
+- **List Metrics**: View all available sensor ids in the database.
+- **Query Time Series**: Retrieve time series for a specific sensor and time range.
+- **Anomaly Detection**: Identify anomalies in sensor data using statistical methods.
+- **Trend Analysis**: Analyze trends and changes in sensor data over time.
+- **Report Generation**: Generate a report with trends, anomalies, and statistics.
+- **User-Friendly UI**: Interact with all features through a modern Gradio web interface.
+
+
+## Usage
+
+By default, the app uses a mock SQLite database (`mock.db`).
+To connect to a real TimescaleDB instance, set the following environment variables:
+
+- USE_MOCK_DB (set to false)
+- `DB_HOST`
+- `DB_PORT`
+- `DB_NAME`
+- `DB_USER`
+- `DB_PASS`
+        """)
     with gr.Tab("Connect DB"):
         connect_btn = gr.Button("Connect to TimescaleDB")
         connect_out = gr.Textbox(label="Connection Result")
         connect_btn.click(
-            fn=connect_database,
-            inputs=[],
-            outputs=connect_out,
+            fn=connect_database, inputs=[], outputs=connect_out, show_api=False
         )
     with gr.Tab("List Metrics"):
         list_btn = gr.Button("List Available Metrics")