Skip to main content
Glama

List Local PostgreSQL Instances

list_postgresql_instances
Read-only

List local PostgreSQL instances managed by 1Panel on a selected node, excluding remote instances and credentials, to inspect node-specific database deployments.

Instructions

List local PostgreSQL instances managed by 1Panel on the selected node. Remote instances and credentials are excluded.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "list_postgresql_instances"
  }
}

Input Schema

NameRequiredDescriptionDefault
pageNo1-indexed page number.
nodeIdNoTarget node ID: "local" for the Main Node, or a numeric string ID (e.g. "3") from list_nodes.local
page_sizeNo

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=true, destructiveHint=false, and openWorldHint=true, so safety is covered. The description adds genuine context beyond them: results are limited to 1Panel-managed local instances and exclude credentials. It says nothing about pagination behavior, result ordering, or what an instance record contains, leaving those gaps.

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, both front-loaded with the resource scope followed by the exclusion constraint. No filler or restatement of the title beyond what is needed to establish scope.

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 read-only list tool with no output schema and full annotation coverage, the definition supplies what an agent needs to select it correctly. Missing only minor details such as pagination defaults and record shape, which the schema partially covers.

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 67%, with page and nodeId documented in the schema. The description only indirectly reinforces nodeId via "on the selected node"; it adds no meaning for page or page_size. Baseline 3 is appropriate since the schema does most of the work.

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 ("List local PostgreSQL instances") and narrows scope to instances managed by 1Panel on the selected node, which distinguishes it from siblings like list_postgresql_databases. It does not name any sibling explicitly, so differentiation is by scope wording rather than direct routing.

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?

"Remote instances and credentials are excluded" gives a concrete when-not condition that prevents an agent from expecting remote hosts or credential data. There is no pointer to an alternative tool for remote instances or for the related database listing, so it stops short of full when/when-not/alternatives guidance.

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