Server Configuration
Describes the environment variables required to run the server.
Name | Required | Description | Default |
---|---|---|---|
No arguments |
Schema
Prompts
Interactive templates invoked by user choice
Name | Description |
---|---|
No prompts |
Resources
Contextual data attached and managed by the client
Name | Description |
---|---|
No resources |
Tools
Functions exposed to the LLM to take actions
Name | Description |
---|---|
list_database_servers | List all available database servers configured in the JDBCX server. Args:
query_timeout_seconds (int, optional): Maximum time to wait for the request in seconds.
Defaults to DEFAULT_QUERY_TIMEOUT_SECONDS.
Returns:
str: JSON string containing the list of database servers along with their corresponding descriptions |
inspect_database_server | Get structural metadata for a specific database server, including its catalogs, schemas, and tables. May take minutes for large servers. Args:
database_server (str): The name of the database server to inspect
query_timeout_seconds (int, optional): Maximum time to wait for the request in seconds.
Defaults to DEFAULT_QUERY_TIMEOUT_SECONDS.
Returns:
str: JSON string containing the structural metadata of the specified database server, including its catalogs, schemas, and tables |
query_database | Execute a SQL query against a specified database server and return formatted results. Maybe slow for complex queries. Args:
database_server (str): The name of the database server to query (must be registered)
sql_query (str): The SQL query to execute (will be wrapped in a SELECT statement)
query_timeout_seconds (int, optional): Maximum time in seconds to wait for query execution.
Defaults to DEFAULT_QUERY_TIMEOUT_SECONDS.
data_format (str, optional): Output format for results. Options:
"md" - Markdown table format
"jsonl" - JSON Lines format (one JSON object per row)
"csv" - Comma-separated values with header row
Defaults to DEFAULT_DATA_FORMAT.
rows_limit (int, optional): Maximum number of rows to return. Defaults to DEFAULT_ROWS_LIMIT.
Returns:
str: Query results as a string in the specified format |