Pretty-print JSON with 2-space indent.
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": {
"text": "<text>"
},
"name": "json_format"
}
}| Name | Required | Description | Default |
|---|---|---|---|
| text | Yes | ||
| indent | No | default 2, max 10 |
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 burden, but it is a deterministic pure transform with low risk. It states the output style (2-space indent) yet omits error behavior on malformed input and whether the indent parameter overrides the stated default.
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 zero padding. Appropriately sized for a trivial utility, though it leaves no room for the constraints an agent would benefit from.
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 two-parameter, no-annotation, no-output-schema utility the core contract is conveyed. Still missing the failure mode for invalid JSON and any note on return value, which matter for an agent deciding whether to chain json_validate first.
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 coverage is 50%: the indent parameter is documented ('default 2, max 10') while text is bare. The description reinforces the default indent value but adds no syntax, size, or validity constraints for text.
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?
Specific verb (pretty-print) plus resource (JSON) and even the output shape (2-space indent). An agent can distinguish it from json_minify and json_validate by name alone, though the description never explicitly contrasts them.
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?
No guidance on when to use this versus json_validate or json_minify, and no statement of what happens if the input is not valid JSON. The agent must infer that this is the right tool for reformatting.
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.