Merge pull request #1 from BohuTANG/rr1

improve the readme

Author: BohuTANG

.github/workflows/python-publish.yml

@@ -67,4 +67,4 @@ jobs:
       - name: Publish release distributions to PyPI
         uses: pypa/gh-action-pypi-publish@release/v1
         with:
-          packages-dir: dist/
+          packages-dir: dist/

.gitignore

@@ -173,3 +173,9 @@ cython_debug/
 
 # PyPI configuration file
 .pypirc
+
+# Virtual environments
+.venv/
+myenv/
+venv/
+env/

README.md

@@ -1,27 +1,75 @@
-# mcp-server-databend
-MCP server of databend
+# MCP Server for Databend
 
-# Install
+[![PyPI - Version](https://img.shields.io/pypi/v/mcp-databend)](https://pypi.org/project/mcp-databend)
+
+An MCP server for Databend database interactions.
+
+## What You Can Do
+
+- **execute_sql** - Execute SQL queries with timeout protection
+- **show_databases** - List all databases
+- **show_tables** - List tables in a database (with optional filter)
+- **describe_table** - Get table schema information
+
+## How to Use
+
+### Step 1: Get Databend Connection
+
+**Recommended**: Sign up for [Databend Cloud](https://app.databend.com) (free tier available)
+
+Get your connection string from [Databend documentation](https://docs.databend.com/developer/drivers/#connection-string-dsn).
+
+| Deployment | Connection String Example |
+|------------|---------------------------|
+| **Databend Cloud** | `databend://cloudapp:pass@host:443/database?warehouse=wh` |
+| **Self-hosted** | `databend://user:pass@localhost:8000/database?sslmode=disable` |
+
+### Step 2: Install
 
 ```bash
-uv sync --all-groups --all-extras
+uv tool install mcp-databend
 ```
 
-# ENV configs
+### Step 3: Configure Your MCP Client
+
+#### MCP Configuration
 
-| ENV | usage | default value |
-| --- | --- | --- |
-| DATABEND_DSN | The dsn connect string | databend://default:@127.0.0.1:8000/?sslmode=disable|
+Add to your MCP client configuration (e.g., Claude Desktop, Windsurf):
 
+```json
+{
+  "mcpServers": {
+    "mcp-databend": {
+      "command": "uv",
+      "args": ["tool", "run", "mcp-databend"],
+      "env": {
+        "DATABEND_DSN": "your-connection-string-here"
+      }
+    }
+  }
+}
+```
+
+#### Supported Clients
 
-# Example for using `cherry studio`
+- **Windsurf** / **Claude Desktop** / **Continue.dev** / **Cursor IDE**
 
-![alt text](assets/cherry-studio.png)
-![alt text](assets/list-database-tables.png)
+### Step 4: Start Using
 
+Once configured, you can ask your AI assistant to:
+- "Show me all databases"
+- "List tables in the sales database"
+- "Describe the users table structure"
+- "Run this SQL query: SELECT * FROM products LIMIT 10"
 
-# Dev testing
+## Development
 
 ```bash
-mcp dev server.py
+# Clone and setup
+git clone https://github.com/databendlabs/mcp-databend
+cd mcp-databend
+uv sync
+
+# Run locally
+uv run python -m mcp_databend.main
 ```

assets/cherry-studio.png

@@ -0,0 +1,5 @@
+"""MCP Server for Databend database interactions."""
+
+from .main import main
+
+__all__ = ["main"]

assets/list-database-tables.png

@@ -0,0 +1,21 @@
+"""Main entry point for the MCP Databend server."""
+
+import sys
+import logging
+from .server import mcp, logger
+
+
+def main():
+    """Main entry point for the MCP server."""
+    try:
+        logger.info("Starting Databend MCP Server...")
+        mcp.run()
+    except KeyboardInterrupt:
+        logger.info("Shutting down server by user request")
+    except Exception as e:
+        logger.error(f"Server startup failed: {str(e)}")
+        sys.exit(1)
+
+
+if __name__ == "__main__":
+    main()

mcp_databend/__init__.py

@@ -11,7 +11,7 @@
 
 # Constants
 SERVER_NAME = "mcp-databend"
-DEFAULT_TIMEOUT = 30  # seconds
+DEFAULT_TIMEOUT = 60  # seconds
 
 # Configure logging
 logging.basicConfig(
@@ -159,7 +159,8 @@ def describe_table(table: str, database: Optional[str] = None):
     return execute_sql(sql)
 
 
-if __name__ == "__main__":
+def main():
+    """Main entry point for the MCP server."""
     try:
         logger.info("Starting Databend MCP Server...")
         mcp.run()
@@ -168,3 +169,7 @@ def describe_table(table: str, database: Optional[str] = None):
     except Exception as e:
         logger.error(f"Server startup failed: {str(e)}")
         sys.exit(1)
+
+
+if __name__ == "__main__":
+    main()

databend_env.py mcp_databend/env.pydatabend_env.py renamed to mcp_databend/env.py

@@ -1,21 +1,53 @@
 [project]
-name = "mcp-server-databend"
-version = "0.1.0"
-description = "Add your description here"
+name = "mcp-databend"
+version = "0.1.2"
+description = "An MCP server for Databend."
 readme = "README.md"
 requires-python = ">=3.12"
+authors = [
+    { name = "Databend Labs", email = "[email protected]" },
+]
+maintainers = [
+    { name = "Databend Labs", email = "[email protected]" },
+]
+license = "Apache-2.0"
+keywords = ["mcp", "databend", "database", "sql", "ai"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Database",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
 dependencies = [
     "databend-driver>=0.27.3",
     "mcp>=1.9.0",
     "python-dotenv>=1.1.0",
 ]
 
+[project.urls]
+Homepage = "https://github.com/databendlabs/mcp-databend"
+Repository = "https://github.com/databendlabs/mcp-databend"
+Documentation = "https://github.com/databendlabs/mcp-databend#readme"
+Issues = "https://github.com/databendlabs/mcp-databend/issues"
+
+[project.scripts]
+mcp-databend = "mcp_databend.main:main"
+
 [dependency-groups]
 dev = [
     "mcp[cli]>=1.9.0",
     "ruff>=0.1.0",
 ]
 
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools.packages.find]
+include = ["mcp_databend*"]
+
 [tool.ruff]
 target-version = "py312"
 lint.select = ["E", "F", "I", "N", "Q", "T", "W"]