Server Configuration
Describes the environment variables required to run the server.
| Name | Required | Description | Default |
|---|---|---|---|
| DB_DSN | No | Oracle database connection string in the format hostname:port/service_name | |
| DB_HOST | No | MySQL database host | |
| DB_NAME | No | MySQL database name | |
| DB_PATH | No | Path to the SQLite database file | |
| DB_PORT | No | MySQL database port | |
| DB_TYPE | Yes | The type of database to connect to (sqlite, mysql, or oracle) | |
| DB_USER | No | Database username (for MySQL or Oracle) | |
| DB_PASSWORD | No | Database password (for MySQL or Oracle) | |
| OPENAI_API_KEY | Yes | Your OpenAI API key from platform.openai.com/api-keys |
Schema
Prompts
Interactive templates invoked by user choice
| Name | Description |
|---|---|
| database_context | Provides context about the database schema for the AI assistant |
| example_prompt |
Resources
Contextual data attached and managed by the client
| Name | Description |
|---|---|
No resources | |
Tools
Functions exposed to the LLM to take actions
| Name | Description |
|---|---|
| get_schema | Get the complete database schema with table structures and sample data |
| list_tables | List all tables in the database |
| describe_table | Get detailed information about a specific table including columns and sample data |
| query_data | Execute SQL queries safely. Use get_schema() first to understand the database structure. |
| search_tables | Search for tables or columns containing a specific keyword |