Set table or column description
set_descriptionWrite the team's description and synonyms for one table, or one column when column is set, on a connection. AI tools then read it in get_schema and get_context in place of the database's own comment. Use it when the user explains what a table or column means, or asks you to document it. An empty description falls back to the database's comment; omitted fields keep their current value. The table and column must exist in get_schema. Changes what every AI tool and person on this connection reads, and is recorded in SaturnSQL with your name. Only make it when the user asked for it or confirmed it. Needs the write scope, the connection's owner or an admin, and a plan that includes Context.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"connectionId": "<connectionId>",
"table": "<table>"
},
"name": "set_description"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| table | Yes | Table name exactly as get_schema lists it. | |
| column | No | Column name exactly as get_schema lists it. Omit to describe the table. | |
| synonyms | No | Other names people use, e.g. ["clients", "accounts"]. Replaces the current list; [] clears it. | |
| description | No | Plain-language meaning, units and caveats. Empty string to clear. | |
| connectionId | Yes | Connection id from list_connections. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| table | No | ||
| column | No | ||
| synonyms | No | ||
| description | No |