Server Configuration
Describes the environment variables required to run the server.
| Name | Required | Description | Default |
|---|---|---|---|
| OPENGAUSS_HOST | Yes | The openGauss database host | |
| OPENGAUSS_PORT | Yes | The openGauss database port | |
| OPENGAUSS_USER | Yes | The openGauss database user | |
| OPENGAUSS_DBNAME | Yes | The openGauss database name | |
| OPENGAUSS_PASSWORD | Yes | The openGauss database password |
Capabilities
Features and capabilities supported by this server
| Capability | Details |
|---|---|
| tasks | {
"list": {},
"cancel": {},
"requests": {
"tools": {
"call": {}
},
"prompts": {
"get": {}
},
"resources": {
"read": {}
}
}
} |
| tools | {
"listChanged": true
} |
| prompts | {
"listChanged": false
} |
| resources | {
"subscribe": false,
"listChanged": false
} |
| experimental | {} |
Tools
Functions exposed to the LLM to take actions
| Name | Description |
|---|---|
| execute_query | Execute an SQL commands on the openGauss server. Args: query: SQL command |
| list_tables_in_current_schema | List table names in current schema on the openGauss server. |
| get_table_definition | Get table definition. |
| get_current_user_and_schema | Get current schema and current user. |
Prompts
Interactive templates invoked by user choice
| Name | Description |
|---|---|
No prompts | |
Resources
Contextual data attached and managed by the client
| Name | Description |
|---|---|
| ListSchemas | Get all schemas of the database. |
| ListTables | Get all table names in current schema, in qualified table names, of the form <schema_name>.<table_name>. |