Json Flatten
json_flattenFlatten a nested JSON document into single-level dotted-path keys.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| payload | Yes |
json_flattenFlatten a nested JSON document into single-level dotted-path keys.
| Name | Required | Description | Default |
|---|---|---|---|
| payload | Yes |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries the full burden. It discloses the output key format (dotted paths), which is useful, but says nothing about array handling, key collision behavior, whether input is mutated, or the return shape.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
A single front-loaded sentence with no filler. It is efficient, though arguably too terse for the amount of behavior left undocumented.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a nested-object transformation with no annotations and no output schema, the description is too thin. It omits separator configurability, array and null handling, and expected output structure, which an agent needs to call it correctly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 0% and the schema only exposes a nested payload object with an undocumented data field and a separator (default '.'). 'Dotted-path keys' hints at the default separator but never mentions that the separator is configurable, so it fails to compensate for the coverage gap.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb (flatten) and resource (nested JSON document) with the resulting form (single-level dotted-path keys). The transformation is unambiguous, but it does not differentiate itself from JSON siblings like json_query, json_diff, or json_schema-infer.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no when-to-use guidance, no statement of prerequisites, and no mention of related tools. The only usage signal is the implied transformation itself, leaving the agent to infer the scenario.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.