Skip to main content
Glama

IA-QA — 130+ QA & Dev Tools for AI Agents

by io.github.JcJamet
OverviewDiscussionsAdmin

flatten_json

Read-onlyIdempotent

Flatten a nested JSON object to single-level dot-notation keys (e.g. {"a":{"b":1}} → {"a.b":1}), or unflatten dot-notation keys back to a nested object. Supports custom separators.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
modeNo"flatten" (default) or "unflatten"
inputYesThe JSON to flatten or unflatten — a JSON string, or the object itself.
separatorNoKey separator (default: ".")

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultNo
key_countNo
max_depthNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • changedInput schema / properties / input / description
      Previous value: -"JSON string to flatten or unflatten"New value: +"The JSON to flatten or unflatten — a JSON string, or the object itself."
    • changedInput schema / properties / input / type
      Previous value: -"string"New value: +[
+  "string",
+  "object",
+  "array"
+]
  2. Changed1 schema field changed
    • addedOutput schema / properties
      Added value: +{
+  "key_count": {
+    "type": "number"
+  },
+  "max_depth": {
+    "type": "array"
+  },
+  "result": {}
+}
  3. Changed1 schema field changed
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
+  "additionalProperties": true,
+  "type": "object"
+}
  4. First observed

TDQS

A4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false, and idempotentHint=true, so the safety profile is clear. The description adds behavioral context about directional behavior (flatten vs. unflatten) and allows custom separators, which is helpful. It does not disclose edge cases (e.g., handling arrays, collisions) or performance traits. Given strong annotations, this is acceptable but not exceptional.

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?

Two sentences cover purpose, both modes, and a key customization. Every sentence adds value with no redundancy or fluff. The example in parentheses is a nice touch that clarifies the output format without being verbose.

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?

The tool is relatively simple with 3 fully documented parameters and a clear output schema. The description covers the bidirectional transformation and customization adequately. It could mention behavior with arrays or nested objects that aren't flat, but the description and schema provide sufficient information for an agent to use the tool correctly.

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 already documents all three parameters. The description adds conceptual context about dot-notation transformation and separators but does not add concrete details beyond the schema. Baseline 3 is appropriate.

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 flattens nested JSON to dot-notation keys and can also unflatten them back. The specific verb 'Flatten' combined with the resource 'nested JSON object' and clear one-to-many directional capability differentiates it from sibling JSON tools.

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?

The description explains both directions (flatten/unflatten) and mentions support for custom separators, giving clear context. However, it does not explicitly state when to use this tool vs. other JSON transformation siblings like 'transform_json_array' or 'merge_json', nor does it mention when not to use it.

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

All IA-QA — 130+ QA & Dev Tools for AI Agents toolsInspect
Try in Browser
One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources