Skip to main content
Glama

Faf Stringify

faf_stringify
Read-only

Convert parsed FAF data back into clean YAML for display or editing. Reads a .faf file, parses it, and re-serializes it as raw YAML content.

Instructions

Convert parsed FAF data back to YAML string. Useful for displaying the raw .faf content or preparing it for editing. Reads the file, parses it, then re-serializes to clean YAML.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathNoproject.faf

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.1.2

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so the safety profile is covered. The description adds genuine process detail ('Reads the file, parses it, then re-serializes'), but says nothing about failure behavior on malformed YAML or path resolution. With annotations handling the read-only story, a 3 is fair.

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?

Three brief, front-loaded sentences with no filler. Slight redundancy between the second and third sentences, which restate the display/edit intent alongside the mechanics, but it is efficient overall.

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?

An output schema exists, so return values need not be spelled out, and the operation is a simple single-param read. The main gap is sibling differentiation: the description never clarifies why an agent should choose faf_stringify over faf_read, which matters given twelve related tools.

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?

One parameter ('path') with 0% schema description coverage and a default of project.faf. The description only hints at it via 'Reads the file', never naming the parameter or explaining the default or accepted path forms. Marginal value over the bare schema.

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?

States a concrete verb+resource ('Convert parsed FAF data back to YAML string') and the pipeline that produces it. It is distinguishable from read-only siblings like faf_read, though it never names one directly. Minor tension: it claims to convert 'parsed FAF data' while the third sentence reveals the input is a file path.

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?

Offers two use contexts ('displaying the raw .faf content or preparing it for editing'), which implies when to reach for it. However, it gives no when-not guidance and never contrasts against faf_read or faf_model, which an agent must otherwise infer.

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