Inspect SQL table structure by retrieving column names, types, and metadata. Provide table name to understand its schema.
Describe columns of a SQL table.
| Name | Required | Description | Default |
|---|---|---|---|
| table | Yes | ||
| schema | No | ||
| session_name | No | default |
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |
Changes observed during successful MCP inspections.
v1.0.0Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The verb 'describe' signals a read-only introspection, which is a useful behavioral cue. However, with no annotations provided, the description carries the full burden and does not disclose whether an active session is required, how session_name affects the operation, or what errors may occur.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single, front-loaded sentence with no filler. It clearly communicates the core action and object without wasting words.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
An output schema exists, so return-value details are not required in the description. However, the description is incomplete for correct invocation: it omits the need for an active database session, the meaning of session_name, and how schema interacts with the table parameter.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 0%, so the description must compensate, but it does not explain any of the parameters. In particular, session_name and schema are non-obvious: session_name selects a connection/session, and schema qualifies the table, but neither is mentioned.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a clear verb and resource: 'Describe columns of a SQL table.' This distinguishes it from sibling tools like db_list_tables, though it could more explicitly say it targets the current session or schema.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No guidance is given about when to use this tool versus alternatives, nor does it mention prerequisites such as an active connection or session. The sibling list includes db_connect, db_list_tables, and db_query, but the description does not reference any of them.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.