Skip to main content
Glama
Sign In
MCPg - Production-grade PostgreSQL MCP Server

MCPg - Production-grade PostgreSQL MCP Server

by devopam
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Hybrid

Get TurboQuant heap stats

get_turboquant_heap_stats
Read-only

Retrieve the exact heap row count for a single TurboQuant index (schema.index); requires pg_turboquant and preserves raw upstream payload for extra counters.

Instructions

Return the exact heap row count tq_index_heap_stats() reports for a single turboquant index (schema.index). The raw upstream payload is preserved in raw for any extra counters upstream may add. Requires the pg_turboquant extension.

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": {
      "schema": "<schema>",
      "index": "<index>"
    },
    "name": "get_turboquant_heap_stats"
  }
}

Input Schema

NameRequiredDescriptionDefault
indexYes
schemaYes
databaseNoOptional: a database id from list_databases, to target a configured secondary (read-only) database; omit for the primary. Database names that are not configured ids are rejected.

Output Schema

NameRequiredDescriptionDefault
rawYes
indexYes
schemaYes
row_countYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.8.4
    • changedInput schema / properties / database / description
      Previous value: -"Optional: target a configured secondary (read-only) database by name; omit for the primary. Call list_databases to see the configured ids."New value: +"Optional: a database id from list_databases, to target a configured secondary (read-only) database; omit for the primary. Database names that are not configured ids are rejected."
  2. First observedv0.6.8

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so the safety profile is covered. The description adds two useful behavioral facts beyond that: the result mirrors tq_index_heap_stats() exactly and the untouched upstream payload is carried in a 'raw' field for future counters. It stops short of saying what happens when the extension is absent or the index is not a turboquant index.

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?

Three short sentences, front-loaded with the core purpose, then the payload-passthrough note, then the prerequisite. Nothing is redundant, though the 'for any extra counters upstream may add' clause is slightly speculative padding.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

An output schema exists, so return values need not be explained, and the description covers purpose, identifier shape and extension prerequisite. For a read-only single-index stats tool with one undocumented optional param, it is adequate, but it omits error/absence behavior and any hint about which sibling to use when only metadata is wanted.

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 33%, and the two required parameters ('schema', 'index') carry no per-parameter descriptions. The description partially compensates by writing them as a paired '(schema.index)' identifier, which tells the agent the two fields jointly address one index. The optional 'database' parameter's targeting semantics live only in the schema, so the description adds meaning but does not fully close the coverage gap.

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 gives a precise verb and resource: 'Return the exact heap row count tq_index_heap_stats() reports for a single turboquant index', and clarifies the (schema.index) addressing, so an agent knows exactly what data comes back. It does not explicitly contrast itself with nearby siblings like get_turboquant_index_metadata or get_turboquant_last_scan_stats, which keeps it short of 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 only implied: an agent can infer this is the tool for raw heap-count statistics on one turboquant index. The only explicit guidance is the prerequisite 'Requires the pg_turboquant extension', with no statement of when to prefer this over get_turboquant_index_metadata or the list_turboquant_* tools, and no failure conditions.

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