Skip to main content
Glama
platypus-db

platypus-db

Official

describe_table

Inspect a table or view to reveal its columns, types, indexes, foreign keys and constraints. Use it to understand schema structure before writing queries or migrations.

Instructions

Describes a table or view: columns (type, nullable, default, primary key, comment, enum values), indexes, foreign keys, other constraints and the foreign keys of other tables that point at it. Also the notes, tags and sensitive marks the user set in PlatypusDB (note, tags, sensitive: true or false, never values), when there are any.

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

Input Schema

NameRequiredDescriptionDefault
tableYesThe table or view.
schemaYesThe table's schema.
connectionYesThe connection's name, as `list_connections` shows it.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.6.2

TDQS

A3.7/5.0
Behavior3/5

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

With no annotations, the description carries the full disclosure burden. It does add a valuable safety-relevant detail, that PlatypusDB notes/tags/sensitive marks are returned but 'never values', and it clarifies that it also surfaces inbound foreign keys from other tables. It does not state that the operation is read-only, whether it requires privileges on the table, or what happens when the table/schema does not exist.

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?

Two sentences, front-loaded with the core verb and resource before the long parenthetical inventory of returned fields. The second sentence is a worthwhile addition, though the first sentence is dense enough that the field list is somewhat hard to scan.

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?

There is no output schema and no annotations, so the description must explain the return payload, and it does so thoroughly, including the non-obvious inbound-FK and PlatypusDB metadata portions. What remains missing is error/failure behavior for a nonexistent table or inaccessible connection, and any routing guidance versus related describe-style siblings.

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?

All three parameters (connection, schema, table) are fully described in the schema at 100% coverage, including the useful pointer that connection is the name 'as list_connections shows it'. The description adds no further meaning about parameter semantics beyond the schema baseline.

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?

Names a specific verb ('Describes') and resource ('a table or view') and then enumerates the returned metadata: column type, nullability, default, primary key, comment, enum values, indexes, foreign keys, constraints, plus reverse foreign keys from other tables. That enumeration lets an agent distinguish it from schema-level or statistics-oriented siblings (get_ddl, profile_table, sample_rows) without opening any schema.

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

Usage Guidelines3/5

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

Usage is only implied by the scope of what is returned: an agent can infer it should call this when it needs column/constraint/index detail for one table. There is no explicit when-to-use statement, no exclusion, and no sibling is named as an alternative for cases like DDL export or row sampling.

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