Skip to main content
Glama
neverinfamous

MySQL MCP Server

MySQL JSON Keys

mysql_json_keys
Read-only

Retrieve keys of a JSON object at a specified path from a MySQL table column.

Instructions

Get the keys of a JSON object at the specified path.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
colNoAlias for column
sqlNoAlias for where
nameNoAlias for table
pathNoOptional JSON path (defaults to root)
limitNoMaximum rows to return
queryNoAlias for where
rowIdNoAlias for where (used with idColumn)
tableNoTable name (Anti-Hallucination: Pass 'table', not 'tableName')
whereNoOptional WHERE clause
columnNoJSON column name
filterNoAlias for where
idColumnNoAlias for where (used with rowId)
tableNameNoAlias for table
columnNameNoAlias for column

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
codeNoError code (e.g. VALIDATION_ERROR, QUERY_ERROR)
dataNo
errorNoError message if operation failed
detailsNoAdditional error context
metricsNoToken estimation metrics
successYesWhether the operation succeeded
categoryNoError category (validation, query, connection, internal)
suggestionNoSuggested fix for the error
recoverableNoWhether the error is recoverable
Behavior3/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so the agent knows this is a safe read operation. The description adds that it operates 'at the specified path' and returns keys, which is useful context beyond annotations. It does not disclose any potential side effects or limitations (e.g., behavior on non-object JSON). With annotations covering safety, a score of 3 is appropriate.

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, front-loaded sentence with no wasted words. It efficiently conveys the tool's purpose without unnecessary details.

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 high parameter count (14) and presence of an output schema, the description is minimal but functional. It does not clarify typical usage patterns (e.g., specifying column and table) or the relationship between aliases. However, since the schema covers parameters and an output schema exists, the description is adequate but could be improved for a tool with many parameters.

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 14 parameters have descriptions in the schema. The tool description does not add extra meaning beyond what the schema already provides. For example, it does not explain how 'path' defaults to root or how the aliases interact. Baseline 3 is correct.

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 tool retrieves keys of a JSON object at a specified path. It uses a specific verb ('Get') and resource ('keys of a JSON object'), and it distinguishes from siblings like mysql_json_extract (which extracts values) or mysql_json_get (which retrieves values).

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?

The description provides no guidance on when to use this tool versus alternatives. It does not mention exclusions or scenarios where other tools (e.g., mysql_json_contains, mysql_json_search) would be more appropriate. The sibling list includes many JSON tools, but no differentiation 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/neverinfamous/mysql-mcp'

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