Skip to main content
Glama

Validate and format JSON

bpj_format_json
Read-onlyIdempotent

Parse JSON and format it with the selected indentation. Zero produces compact output.

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>",
      "spaces": "<spaces>"
    },
    "name": "bpj_format_json"
  }
}

Input Schema

NameRequiredDescriptionDefault
jsonYes
spacesYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

B3.2/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 openWorldHint=false, so the safety profile is fully covered by structured data. The description adds the semantics of zero indentation producing compact output, which is useful behavioral context. It does not disclose what happens on invalid JSON input, despite "Parse" implying a failure mode, nor 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.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two short sentences, front-loaded with the core action and with no wasted wording. Brevity is appropriate for a trivial utility, though the second sentence could be integrated more tightly with the first.

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 two-parameter, non-destructive read utility with no output schema, the description covers the essential action and the one non-obvious parameter behavior. It leaves out error behavior on malformed JSON input and whether the output is a returned string, which an agent would need to call it confidently.

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 0%, so the description must carry the burden. It usefully explains that the `spaces` value selects indentation and that 0 yields compact output, which the bare schema (integer 0-4) does not convey. It adds nothing about the `json` parameter, including the 12000-character limit or expected encoding.

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?

The description uses specific verbs tied to the resource: "Parse JSON and format it with the selected indentation." An agent can tell this is a pretty-printer/validator rather than a comparator, flattener, or patch applier among the siblings. It stops short of explicitly naming sibling alternatives to differentiate itself.

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 guidance on when to choose this tool over the many sibling JSON tools (compare, flatten, check_json_lines, etc.) and no stated preconditions. Usage is only implied by the verb "format." The tool is simple, so the gap is modest, but no explicit context is given.

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.