Skip to main content
Glama
platypus-db

platypus-db

Official

propose_sql

Open proposed SQL in a new PlatypusDB editor tab for user review, editing, and manual execution; nothing runs automatically, so changes can be checked before applying.

Instructions

Proposes SQL to the user: PlatypusDB opens it in a new editor tab on the connection (now if the app is open, else when it starts), where the user reviews, edits and runs it by hand. Nothing runs here, whatever the connection's agent access: use it for changes the user should check, or that read_only access does not allow. title names the tab.

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>",
      "sql": "<sql>"
    },
    "name": "propose_sql"
  }
}

Input Schema

NameRequiredDescriptionDefault
sqlYesThe SQL to open in the editor: one statement or a script.
titleNoThe editor tab's title, e.g. what the SQL does.
connectionYesThe connection's name, as `list_connections` shows it.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.6.2

TDQS

A4.1/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 that nothing executes, that the SQL appears in a new editor tab, and the timing nuance (immediately if the app is open, otherwise at next start). It also states the behavior is independent of the connection's agent access, which is important for read_only contexts. It does not say what happens on repeated calls (tab stacking) or what the call returns.

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?

Front-loaded with the core action and mechanism, then the safety/timing constraints. Slightly compressed to the point of density (parenthetical timing clause, long colon clause), but every sentence contributes information and there is no filler.

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 three-parameter, non-executing tool with no output schema, the definition covers what an agent needs: what it does, that it does not run anything, and when the proposal surfaces. Only minor gaps remain—return value and behavior across repeated invocations—which do not block correct invocation.

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 all three parameters are already documented. The description corroborates rather than extends this, adding only that the title names the tab and that connection refers to the connection the editor opens on. No syntax, format, or naming-convention guidance beyond the schema, so baseline 3 applies.

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 ("Proposes SQL to the user") plus the concrete mechanism: PlatypusDB opens it in a new editor tab on the given connection. This clearly separates it from execution tools like run_query, since the description immediately says the user runs it by hand.

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?

Gives an explicit when-to-use rule: changes the user should check, or statements that read_only access does not allow. It also clearly excludes execution ("Nothing runs here"). It stops short of naming a sibling (e.g. run_query) as the alternative for statements that should execute, so it is strong but not fully routing.

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