Skip to main content
Glama

replication_status

Check PostgreSQL replication health including physical and logical standbys, replication slots, WAL status, and archiving to diagnose replica lag and potential issues.

Instructions

Comprehensive replication health - physical, logical, CDC, slots, WAL, archiving.

LEVEL: Server (PostgreSQL instance level)

USE FOR: replication status, replica lag, standby, streaming replication, replication slots, CDC, logical replication, publications, subscriptions, WAL archiving, backup progress, "is replication healthy?", "how far behind is the replica?". DO NOT USE FOR: database-level health (use database_health), query performance (use query_performance), PostgreSQL settings (use configuration_review).

INCLUDE OPTIONS:

  • 'all': Everything (default)

  • 'physical': Standbys, streaming replication, replay lag

  • 'logical': CDC status, wal_level, publications, subscriptions, logical slots

  • 'slots': All replication slots (physical and logical), inactive slot warnings

  • 'wal': WAL info, WAL settings

  • 'archiving': Archive mode, archiver status, failed archives, active basebackups

Examples: replication_status() - Full replication report replication_status(include='physical') - Physical replication only replication_status(include='logical') - Logical replication/CDC only replication_status(include='slots') - Replication slots only replication_status(include='wal') - WAL status only replication_status(include='archiving') - WAL archiving status

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
includeNoWhat to include: 'all', 'physical', 'logical', 'slots', 'wal', 'archiving'all
urlNoDatabase URL for auto-connection
formatNoOutput format: 'json' or 'markdown'json

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes
Behavior3/5

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

No annotations are present, so the description carries full burden. It explains the options and examples, but does not disclose potential behavioral traits like required privileges, performance impact, or safety guarantees (e.g., read-only nature). Adequate but could be more explicit.

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 well-organized with labeled sections (LEVEL, USE FOR, DO NOT USE FOR, INCLUDE OPTIONS, Examples). It is concise, front-loaded with a summary, and each sentence is purposeful. No redundancy.

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?

Given the tool's complexity (server-level replication health with multiple facets) and the presence of an output schema, the description covers all necessary aspects: scope, usage, options, examples, and exclusions. It is fully informative for correct invocation.

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

Parameters4/5

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

Schema coverage is 100%. The description adds significant context beyond the schema for the 'include' parameter via the INCLUDE OPTIONS list and examples. For 'url' and 'format', it echoes schema but no added depth. Overall, it enhances understanding.

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 clearly states the tool's purpose: 'Comprehensive replication health - physical, logical, CDC, slots, WAL, archiving.' It specifies the server level and explicitly distinguishes from sibling tools by listing what not to use (database_health, query_performance, configuration_review).

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

Usage Guidelines5/5

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

The description provides explicit 'USE FOR' and 'DO NOT USE FOR' sections, naming alternatives (database_health, query_performance, configuration_review). It also includes examples for each option, guiding correct selection.

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/snss10/DBeast'

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