Skip to main content
Glama
platypus-db

platypus-db

Official

read_script

Retrieve the text of a saved script by its path from PlatypusDB, read-only, so you can inspect SQL content without running or changing anything.

Instructions

Returns the text of a script the user saved in PlatypusDB, by the path list_scripts shows, with the connection it is linked to. At most 256 KiB: a longer script is cut, and the answer says so (truncated). A script linked to a connection agents may not use is refused. Read-only: nothing is run or changed.

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": {
      "path": "<path>"
    },
    "name": "read_script"
  }
}

Input Schema

NameRequiredDescriptionDefault
pathYesThe script's path, as `list_scripts` shows it, e.g. `reports/monthly.sql`.
projectNoThe project's name, as the app shows it; left out for All connections.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.6.2

TDQS

A4.2/5.0
Behavior4/5

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

With no annotations, the description carries the full burden and does well: it discloses a hard 256 KiB cap, that longer scripts are cut, that the response flags truncation, that scripts linked to unavailable connections are refused, and that nothing is executed. The one gap is what a truncated result means practically — whether there is any way to retrieve the remainder.

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?

Three sentences, each doing distinct work: what is returned, the size/truncation behavior, the permission refusal, and the read-only guarantee. Nothing is repeated and the core identification is front-loaded.

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 two-parameter read tool with no output schema, the description covers the essentials: source of the path, what comes back (text plus linked connection), truncation signaling, and authorization refusal. Slightly incomplete in that the shape of the truncated response and any recovery path are left implicit.

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 both params are already documented, including the "left out for All connections" semantics for project. The description adds only the sourcing hint for path (matching list_scripts), so the baseline of 3 is appropriate.

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?

States a specific verb and resource ("Returns the text of a script the user saved in PlatypusDB") and pins the identifier to what a sibling produces ("by the path list_scripts shows"). The addition of "with the connection it is linked to" makes clear this is not just raw text, and it is unambiguously distinct from list_scripts or get_ddl.

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 reference to "the path list_scripts shows" gives a clear precondition and effectively routes the agent through list_scripts first. It does not state when this tool is the wrong choice (e.g., when the agent only needs metadata rather than full text), but the context for use is explicit.

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