Skip to main content
Glama

migrate-diff

Generate migration files by comparing current database schema to desired state for managing schema changes.

Instructions

Generate a new migration file by comparing current state to desired schema

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
toYesDesired schema state (file:// or schema HCL)
devUrlNoURL for dev database to compute diff
dirUrlNoURL to migration directory
nameNoName for the new migration file
editNoOpen editor for manual changes
formatNoOutput format: text or json
Behavior2/5

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

With no annotations provided, the description carries full burden but only states the basic action. It doesn't disclose behavioral traits like whether this is a read-only or mutating operation, what permissions are needed, how errors are handled, or what the output looks like (e.g., file creation details). For a tool with 6 parameters and no annotations, this is a significant gap.

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?

The description is a single, efficient sentence that front-loads the core purpose without unnecessary words. Every element ('generate', 'new migration file', 'comparing current state to desired schema') earns its place by contributing essential information.

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

Completeness2/5

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

Given the tool's complexity (6 parameters, no output schema, no annotations), the description is incomplete. It doesn't explain the output (e.g., where the file is saved, format details), error conditions, or integration with sibling tools. For a migration generation tool, this leaves critical gaps in understanding its full behavior.

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 schema fully documents all 6 parameters. The description adds no additional parameter semantics beyond implying a comparison between 'current state' and 'desired schema', which loosely relates to the 'to' parameter. Baseline 3 is appropriate when the schema does the heavy lifting.

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 clearly states the tool's purpose as 'Generate a new migration file by comparing current state to desired schema', which specifies the verb (generate), resource (migration file), and method (comparing states). It distinguishes from siblings like migrate-apply (applies migrations) or migrate-status (checks status), but doesn't explicitly name alternatives for the comparison function.

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?

The description implies usage for creating migration files through schema comparison, but doesn't explicitly state when to use this versus alternatives like migrate-new (creates empty migration) or migrate-validate (validates migrations). No guidance on prerequisites, exclusions, or specific scenarios is provided.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/mpreziuso/mcp-atlas'

If you have feedback or need assistance with the MCP directory API, please join our Discord server