Skip to main content
Glama
platypus-db

platypus-db

Official

list_objects

Lists tables, views, functions, and other schema objects with type, comment, and estimated row counts; page through results or search by name.

Instructions

Lists the tables, views, sequences, functions, procedures, triggers and types of a schema, with their kind, comment and estimated rows: a list of up to 500 objects (limit raises it to 2000). A schema with more returns {objects, truncated: true, total, offset, next_offset}: call again with offset=next_offset for the next page, or use search_objects to find names.

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": {
      "connection": "<connection>",
      "schema": "<schema>"
    },
    "name": "list_objects"
  }
}

Input Schema

NameRequiredDescriptionDefault
limitNoObjects returned at most: 500 by default, up to 2000.
offsetNoObjects to skip: the `next_offset` of the previous page.
schemaYesThe schema (a database in MySQL, `main` in SQLite and DuckDB).
connectionYesThe connection's name, as `list_connections` shows it.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.6.2

TDQS

A4.7/5.0
Behavior5/5

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

With no annotations supplied, the description carries the full behavioral burden and does so well: it discloses the default page size of 500, the maximum of 2000 when limit is raised, and the exact shape of a truncated response ({objects, truncated: true, total, offset, next_offset}). That is precisely the context an agent needs to handle large schemas correctly.

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, front-loaded with the resource and output fields, followed by pagination behavior and the alternative tool. Every clause carries information and nothing is redundant.

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?

For a paginated listing tool with no output schema and no annotations, the description supplies the limits, truncation contract, and next-step guidance. An agent can call it and handle its results without further context.

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 description coverage is 100%, so the baseline is 3. The description reiterates the limit range (500 default, 2000 max) and the offset=next_offset relationship, but those semantics are already documented in the schema itself, so it adds little meaning beyond the structured fields.

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 states a specific verb (Lists) and enumerates exactly what is returned: tables, views, sequences, functions, procedures, triggers and types, along with kind, comment and estimated rows. It also names search_objects as a distinct alternative for name lookup, so an agent can differentiate the two siblings without reading either schema.

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?

It says when to paginate (when the response is truncated, call again with offset=next_offset) and when to switch tools (use search_objects to find names). This is explicit routing guidance with a concrete alternative, leaving little to inference.

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