Skip to main content
Glama
pg-readonly-mcp

pg-readonly-mcp

by landaida

describe_table

Inspect an allow-listed PostgreSQL table to retrieve columns, types, nullability, defaults, primary key, and indexes before building SELECT queries.

Instructions

Describe an allow-listed table: columns (name, type, nullable, default), primary key, indexes.

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
tableYes

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.6/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 burden of behavioral disclosure. It usefully states that only allow-listed tables are supported and describes the returned metadata, but it does not explicitly confirm read-only behavior, describe permission errors, or explain failure modes for non-allow-listed tables.

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?

The description is a single front-loaded sentence with no wasted wording. It states the purpose first and then compactly lists the metadata categories returned.

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?

For a simple one-parameter metadata tool with an output schema, the definition is largely complete: it covers the allow-list constraint and summarizes the return contents. The main remaining gap is routing guidance relative to sibling tools such as list_tables and query.

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?

The schema provides no parameter descriptions, so the description must compensate. It adds the important constraint that the table must be allow-listed, but it does not explain the expected table identifier format, casing, qualification, or examples.

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?

The description uses a specific verb and resource: 'Describe an allow-listed table.' It also enumerates the metadata returned, including columns, primary key, and indexes. It does not explicitly distinguish this tool from siblings like list_tables or query, which keeps it from a 5.

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 implied: an agent would call this to inspect a table's structure. However, the description gives no explicit when-to-use guidance, no when-not-to-use conditions, and does not name alternatives such as list_tables or query.

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

Deploy Server

Other Tools