Skip to main content
Glama
foxter-io

PostgreSQL MCP Server

by foxter-io

Get DDL (CREATE statement) for a Database Object

pg_get_ddl
Read-onlyIdempotent

Retrieve the DDL (CREATE statement) for any PostgreSQL table, view, materialized view, function, or index. Generate SQL code to replicate object definitions across environments.

Instructions

Get the CREATE statement (DDL) for a table, view, materialized view, function, or index.

Args:

  • object_name: Name of the object (required)

  • schema: Schema name (default: public)

  • object_type: Type of object: 'table', 'view', 'matview', 'function', 'index' (default: 'table')

Returns: JSON: { schema, object_name, object_type, ddl: string } Markdown: formatted SQL code block

Useful for understanding table structure, reproducing objects in other environments, or code review.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
object_nameYesName of the object
schemaNoPostgreSQL schema name (default: public)public
object_typeNoObject type: 'table', 'view', 'matview', 'function', 'index'table
Behavior4/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false, idempotentHint=true. The description adds return format details (JSON fields, Markdown code block) and lists supported object types, enhancing transparency beyond annotations.

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 concise with two paragraphs: a purpose sentence, then args, return format, and usage. It is front-loaded with the essential action and well-organized.

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?

Despite no output schema, the description explains the return JSON fields and Markdown formatting. It covers tool purpose, parameters, return, and usage scenarios fully, given the tool's complexity.

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 coverage is 100%, so baseline is 3. The description's 'Args:' section mirrors the schema and adds readability but does not provide new semantic meaning beyond what the schema already conveys.

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?

The description specifies the verb 'Get' and the resource 'CREATE statement (DDL)' for multiple object types. It clearly distinguishes from sibling tools like pg_describe_table or pg_list_tables by focusing on DDL retrieval.

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?

The description explicitly states use cases: 'understanding table structure, reproducing objects in other environments, or code review.' It does not mention when not to use or alternatives, but sibling differentiation is inherent.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/foxter-io/mcp-postgresql'

If you have feedback or need assistance with the MCP directory API, please join our Discord server