Convert a JSON object to clean, human-readable YAML. Handles nested objects, arrays, multiline strings, and special characters. No external dependencies.
| Name | Required | Description | Default |
|---|---|---|---|
| input | Yes | The JSON to convert to YAML — a JSON string, or the value itself. | |
| indent | No | Indentation size in spaces (default: 2) |
| Name | Required | Description | Default |
|---|---|---|---|
| yaml | No | ||
| lines | No |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint, idempotentHint, and non-destructive, so the bar is lower. Description adds value by clarifying output is human-readable YAML, handles special cases (nested, arrays, multiline), and has no external dependencies. No contradictions.
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?
Two informative sentences with no waste. First sentence states core purpose, second adds behavioral details. Every part earns its place.
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?
Output schema exists to describe return values, so description doesn't need to explain output structure. The description, combined with annotations and schema, provides a complete understanding for a simple conversion tool.
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 100%, so baseline is 3. Description adds context for the input parameter (JSON string or value itself) and mentions clean human-readable output, which supplements schema. The indent parameter is well-described by schema, no extra needed.
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?
The description clearly states the tool converts JSON to YAML, highlighting handling of nested objects, arrays, multiline strings, and special characters. It effectively distinguishes from sibling tools like yaml_to_json and other json-related conversions.
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?
The description implies usage by naming the conversion task, but doesn't guide when to use this tool versus alternatives (e.g., other format converters in sibling list). No explicit when-not or context for choosing this over similar tools.
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.