Skip to main content
Glama
dsh-databases

dsh-databases

by nvznc

Describir una tabla

describe_table
Read-onlyIdempotent

Retrieve a table or view schema—columns, types, nullability, defaults, identity, indexes, and foreign keys—before writing SQL queries.

Instructions

Devuelve el esquema detallado de una tabla o vista: columnas con tipo, nulabilidad, valor por defecto, auto-incremento/identidad, índices y claves foráneas. Úsala antes de escribir consultas.

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": {
      "table": "<table>"
    },
    "name": "describe_table"
  }
}

Input Schema

NameRequiredDescriptionDefault
tableYesNombre exacto de la tabla o vista.
engineNoMotor de base de datos. Por defecto usa MSSQL_ENGINE del .env (mssql si no existe).
schemaNoEsquema de la tabla: "dbo" (mssql), "public" (postgres) o la base (mysql).
databaseNoNombre de la base de datos. Si se omite se usa la de la conexión (por defecto master).
connectionNoNombre de la conexión definida en configs/connections.json, guardada con save_connection o "default" (.env). Si se omite se usa la conexión por defecto o la indicada por DSH_MCP_SQL_CONNECTION.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

A3.8/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint and closed-world, so the safety profile is covered. The description adds useful scope information by listing what the returned schema includes, but says nothing about connection selection behavior, permission requirements, or what happens if the table is not found.

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

Conciseness5/5

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

Two sentences, output contents front-loaded, then the usage directive. Nothing redundant and nothing that could be cut without losing information.

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

Completeness4/5

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

No output schema exists, so the description carries the return-value burden, which it does well by enumerating the schema elements returned. For a read-only introspection tool with fully documented parameters, this is nearly complete; only error/empty-result behavior is unaddressed.

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

Parameters3/5

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

Schema description coverage is 100%, so the engine/schema/database/connection defaults and their fallbacks are already fully documented in the input schema. The description adds no meaning beyond it, so the baseline 3 applies.

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

Purpose4/5

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

States a specific verb and resource ("Devuelve el esquema detallado de una tabla o vista") and enumerates exactly what the schema contains: columns with type, nullability, default, identity, indexes and foreign keys. It is distinguishable from list_tables and run_query by that output scope, though it never names a sibling explicitly.

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

Usage Guidelines4/5

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

"Úsala antes de escribir consultas" gives a clear usage context that positions it ahead of run_query. No when-not guidance or mention of how it relates to list_tables, so it stops short of explicit alternative routing.

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