Skip to main content
Glama

Set table or column description

set_description
DestructiveIdempotent

Write 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

NameRequiredDescriptionDefault
tableYesTable name exactly as get_schema lists it.
columnNoColumn name exactly as get_schema lists it. Omit to describe the table.
synonymsNoOther names people use, e.g. ["clients", "accounts"]. Replaces the current list; [] clears it.
descriptionNoPlain-language meaning, units and caveats. Empty string to clear.
connectionIdYesConnection id from list_connections.

Output Schema

NameRequiredDescriptionDefault
tableNo
columnNo
synonymsNo
descriptionNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.8/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Beyond the annotations it discloses real consequences: empty string falls back to the database comment, omitted fields keep their current value, the change is visible to every AI tool and person on the connection, and it is audit-logged with the caller's name. It also lists authorization prerequisites (write scope, connection owner or admin, plan including Context), which is exactly the kind of behavior annotations cannot express.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Purpose is front-loaded in the first clause, and every sentence carries load-bearing information (trigger, semantics, prerequisites, guard). It is dense at eight short sentences, but nothing is filler; a slightly tighter grouping of the prerequisite sentences would make it easier to scan.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

An output schema exists, so return values need no explanation. For a destructive, idempotent write the description covers impact, fallback behavior, prerequisites, and the user-consent requirement, leaving no significant gap for an agent deciding whether and how to call it.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the baseline is 3, but the description adds genuine meaning beyond the schema: that table and column names must exist exactly as get_schema lists them, and that omitted fields preserve current values (partial-update semantics). The clear/replace behaviors of `description` and `synonyms` are already in the schema, so no further credit there.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource (write description and synonyms) plus the exact scoping rule: table-level, or column-level when `column` is set, on a connection. It also names downstream readers (get_schema, get_context), so an agent can distinguish this writer from the read siblings without opening a schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives an explicit trigger ("Use it when the user explains what a table or column means, or asks you to document it") and an explicit gate ("Only make it when the user asked for it or confirmed it"). It also names the read tools whose data it replaces, which is the relevant alternative context for this write.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources