Skip to main content
Glama

Flatten JSON field paths

bpj_flatten_json
Read-onlyIdempotent

List leaf values with their JSON Pointer paths, including empty containers.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "json": "<json>"
    },
    "name": "bpj_flatten_json"
  }
}

Input Schema

NameRequiredDescriptionDefault
jsonYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

B3/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and a closed-world scope, so the safety profile is fully covered without the description. The description adds one genuine behavioral detail the annotations do not: empty containers are included in the output, which affects result shape and size. It says nothing about error handling for malformed JSON or about ordering of returned paths.

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?

One sentence, front-loaded with the output contract, with no filler or restated boilerplate. It is arguably too terse for the amount of behavioral information an agent needs, but nothing in it is wasted.

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?

For a simple one-parameter utility with rich annotations, the definition covers what comes back (leaf values, pointer paths, empty containers), which is the main unknown absent an output schema. It leaves out input encoding, size limits, root/scalar edge cases, and failure behavior, so it is adequate but not complete.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

With a single parameter and 0% schema description coverage, the description must carry the burden, but it says nothing about the `json` argument. It does not clarify that the input is JSON serialized as a string rather than a structured object, nor does it mention the 12000-character limit, both of which are the most likely invocation mistakes.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

Uses a specific verb ("List") with a specific resource (leaf values) and names the identifier scheme (JSON Pointer paths), which separates it from pointer-reading siblings like bpj_read_json_pointer or structural siblings like bpj_format_json. It never explicitly names or contrasts any alternative, so it stops short of a 5.

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?

There is no when-to-use framing, no prerequisites, and no mention of when a different sibling (e.g. a pointer reader or a comparison/merge tool) would be the better choice. The only guidance an agent can infer is that this is a read/extract operation over an already-available JSON payload.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.