Skip to main content
Glama

format_json

Format and prettify JSON strings with proper indentation and customizable spacing to improve readability and structure.

Instructions

Format and prettify JSON with proper indentation. Example: {"a":1,"b":2} → formatted JSON with customizable spacing

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
jsonYesJSON string to format
indentNoNumber of spaces for indentation
Behavior3/5

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

Annotations provide readOnlyHint=false (indicating it's not read-only) and a title, but the description adds useful context about the formatting behavior ('prettify with proper indentation') and mentions customizable spacing. However, it doesn't disclose error handling for invalid JSON, performance characteristics, or output format details beyond what's implied.

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?

The description is appropriately brief with two concise sentences that front-load the core purpose. The example helps illustrate functionality without unnecessary elaboration. However, the second sentence could be slightly more polished in its phrasing.

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 formatting tool with good schema coverage but no output schema, the description adequately explains what the tool does but lacks details about the return format (e.g., whether it returns a string or structured object). It doesn't mention error cases or validation behavior for malformed JSON input.

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?

With 100% schema description coverage, both parameters ('json' and 'indent') are fully documented in the schema. The description adds minimal value by mentioning 'customizable spacing' which relates to the indent parameter, but doesn't provide additional syntax, format requirements, or default values beyond what the schema already specifies.

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's purpose with a specific verb ('Format and prettify') and resource ('JSON'), including the key action of adding proper indentation. It distinguishes itself from sibling tools like 'minify_json' by focusing on formatting rather than compression, and from 'compare_json' by performing transformation rather than comparison.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides an example that implies usage for beautifying JSON strings, but doesn't explicitly state when to use this tool versus alternatives like 'minify_json' (for compression) or 'convert_json_to_csv' (for format conversion). No guidance is given about prerequisites or 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.

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/wrenchpilot/it-tools-mcp'

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