Skip to main content
Glama
ImRieul

MySQL MCP Server

by ImRieul
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Remote

add_comment

Add a comment to a MySQL table or column. Preview changes with dryRun before execution.

Instructions

Safely add a comment to a table or column. This tool only modifies comments — it cannot alter table structure, column types, or data. Set dryRun=true to preview the generated SQL without executing it. Use describe_table first to verify column names. Not available in read-only mode.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
tableYesTable name.
columnNoColumn name. If omitted, sets a table-level comment.
dryRunNoIf true, returns the generated SQL without executing it. Defaults to false.
commentYesComment text to set.
databaseNoDatabase name. Uses the current database if omitted.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv1.0.3
    • addedInput schema / properties / dryRun
      Added value: +{
+  "description": "If true, returns the generated SQL without executing it. Defaults to false.",
+  "type": "boolean"
+}
  2. First observedv1.0.2

TDQS

A4.3/5.0
Behavior4/5

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

With no annotations, the description carries full burden. It discloses safety, modification scope, preview capability, and read-only restriction. Could add detail on persistence (e.g., commits immediately) but sufficient.

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?

Four sentences, no redundancy, front-loaded with purpose. Every sentence serves a distinct function: purpose, constraints, usage tip, prerequisite, mode restriction.

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 simple tool with full schema coverage, the description covers safety, prerequisites, preview mode, and read-only restriction. No gaps given the tool's complexity.

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 100% and already explains each parameter. The description adds no new semantic value beyond what the schema descriptions provide, meeting baseline but not exceeding.

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 clearly states that the tool adds comments to tables or columns, distinguishes its limited scope (cannot alter structure or data) from sibling tools like execute and query, and specifies the safety aspect.

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?

Provides explicit usage guidance: use describe_table first to verify column names, set dryRun=true for preview, and notes unavailability in read-only mode. Lacks explicit comparison to alternatives but covers key use cases.

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

Deploy Server

Other Tools