Skip to main content
Glama

Database migration safety review

submit_database_migration_review
Idempotent

Review a SQL migration for destructive and blocking operations — dropped tables and columns, NOT NULL columns without defaults, type changes and renames — and deliver a safe deployment order. Before running a migration against a database that is serving traffic. Do not choose this when you need an execution plan or an actual lock-time estimate. Example requests: Is this migration safe to run on a live database? | Review this SQL migration for downtime risks. | What could go wrong if I run this migration?

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": {
      "inputs": "<inputs>",
      "authorized_by": "<authorized_by>"
    },
    "name": "submit_database_migration_review"
  }
}

Input Schema

NameRequiredDescriptionDefault
inputsYes
quote_idNoThe quote_id returned by POST /v1/jobs. Required to authorize a priced capability; the service rejects a priced job that does not name the quote it issued.
authorized_byYesIdentifier of the human or agent authorizing this job.
accepted_priceNoThe amount accepted, exactly as quoted (for example "5.00" or 5). Checked against the stored quote, so a price that moved between quote and authorize is refused rather than silently absorbed. Optional, but sent to make the acceptance explicit.

Output Schema

NameRequiredDescriptionDefault
quoteNo
stateYes
job_idYes
artifactsNo
access_tokenNoPer-job credential. Present it as the X-Job-Token header to read the job or list it. Keep it; it is the only credential for this job.
verificationNoIndependent verification. verification.ok = false means the job failed, not a partial success.
capability_idNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already declare the safety profile (readOnlyHint=false, destructiveHint=false, idempotentHint=true, openWorldHint=false), so the description's job is to add context — and it does, by disclosing the analysis dimensions and that the output is a reordered deployment sequence rather than just a pass/fail. It does not mention that this is a priced, quote-authorized job or anything about cost/latency, which is left entirely to the schema.

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 purpose, then trigger, then exclusion, then examples — a sensible ordering with no filler. The example-request block is slightly redundant with the opening sentence but earns its place by supplying matchable user phrasings.

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?

An output schema exists, so return values need not be explained, and the description covers scope, trigger and exclusions well for a nested 4-parameter tool. The one gap is the pricing/authorization workflow implied by quote_id and accepted_price, which an agent only discovers by reading the schema.

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 75% and the schema already documents migration text, quote_id, authorized_by and accepted_price in detail. The description says nothing about any of the four parameters — not the SQL input format, not the authorization/quote requirement — so it adds no meaning beyond the structured fields; 3 is the appropriate baseline here.

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 ('Review a SQL migration') and enumerates the exact findings it produces — dropped tables/columns, NOT NULL columns without defaults, type changes and renames — plus the deliverable ('a safe deployment order'). This clearly separates it from the many sibling submit_* tools, including the adjacent submit_sql_to_dataframe_migration.

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?

Gives an explicit trigger ('Before running a migration against a database that is serving traffic') and explicit exclusions ('Do not choose this when you need an execution plan or an actual lock-time estimate'). The three example requests further anchor the utterances that should route here.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources