Skip to main content
Glama
sussa3007

MySql MCP Server

set_readonly

Control database access by enabling or disabling read-only mode for MySQL databases to restrict write operations or allow updates as needed.

Instructions

Enable or disable read-only mode

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
readonlyYesSet to true to enable read-only mode, false to disable

Implementation Reference

  • Handler function for the 'set_readonly' tool. Sets the 'readonly' flag in the global connectionConfig based on the input boolean parameter and returns a confirmation message.
    case "set_readonly": {
      try {
        const readonly = request.params.arguments?.readonly as boolean;
    
        if (readonly === undefined) {
          throw new Error("readonly parameter is required");
        }
    
        connectionConfig.readonly = readonly;
    
        return {
          content: [
            {
              type: "text",
              text: `Read-only mode ${readonly ? "enabled" : "disabled"}`
            }
          ],
          isError: false
        };
      } catch (error) {
        return {
          content: [
            {
              type: "text",
              text:
                error instanceof Error
                  ? error.message
                  : "Unknown error occurred"
            }
          ],
          isError: true
        };
      }
    }
  • src/index.ts:259-273 (registration)
    Registration of the 'set_readonly' tool in the ListTools response, including its name, description, and input schema definition.
    {
      name: "set_readonly",
      description: "Enable or disable read-only mode",
      inputSchema: {
        type: "object",
        properties: {
          readonly: {
            type: "boolean",
            description:
              "Set to true to enable read-only mode, false to disable"
          }
        },
        required: ["readonly"]
      }
    }
  • Input schema for the 'set_readonly' tool, defining a required boolean 'readonly' parameter.
    inputSchema: {
      type: "object",
      properties: {
        readonly: {
          type: "boolean",
          description:
            "Set to true to enable read-only mode, false to disable"
        }
      },
      required: ["readonly"]
    }

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

B3.2/5.0
Behavior2/5

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

With no annotations, the description must fully disclose behavior, but it only states the basic action. It does not explain consequences of enabling read-only mode, scope, or reversibility, which is insufficient for safe selection.

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?

The description is extremely concise with no filler. It is appropriately front-loaded, though it could optionally expand on context without harming conciseness.

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

Completeness3/5

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

Given the low complexity (1 boolean param, no output schema), the description covers the basic action but lacks context about the tool's effect on the system, such as whether it affects a session or database, leaving some ambiguity.

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% with a clear parameter description. The tool description adds minimal value beyond restating the parameter purpose, so it meets the baseline without improvement.

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 the action (enable/disable) and the resource (read-only mode). It is distinct from sibling tools which focus on database operations like querying or connecting.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

No guidance is provided on when to use this tool vs alternatives, such as query or status. There are no context clues or exclusions, leaving the agent without decision support.

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

Related Tools