Skip to main content
Glama

Sync .faf to CLAUDE.md

faf_sync
Idempotent

Write project.faf into CLAUDE.md, AGENTS.md, .cursorrules, GEMINI.md, or copilot-instructions.md as a managed block, keeping all other lines intact. Run after editing project.faf.

Instructions

Write project.faf into CLAUDE.md as a faf-managed block (faf-cli's render and injector), and on request into AGENTS.md (agents), .cursorrules (cursor), GEMINI.md (gemini) and .github/copilot-instructions.md (copilot) — or all of them (all) — with faf-cli's writers. Each file keeps every line outside faf's block. Returns the files written and any requested file that could not be written, with the reason (then isError). Use it after editing project.faf.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
allNoWrite every format: CLAUDE.md + AGENTS.md + .cursorrules + GEMINI.md + .github/copilot-instructions.md
pathNoProject path. Sets session context for subsequent calls.
agentsNoAlso write AGENTS.md (OpenAI Codex and other agents)
cursorNoAlso write .cursorrules (Cursor IDE)
geminiNoAlso write GEMINI.md (Google Gemini CLI)
copilotNoAlso write .github/copilot-instructions.md (GitHub Copilot)

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
scoreNofaf-cli's score of that .faf, as text ("85%" or "unknown (—)")
fafPathNoThe .faf the files were written from
filesFailedYesRequested files that were not written
filesWrittenYesFiles written, CLAUDE.md first

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed6 schema fields changedv6.0.0
    • changedInput schema / properties / agents / description
      Previous value: -"Also sync to AGENTS.md (OpenAI/Codex format)"New value: +"Also write AGENTS.md (OpenAI Codex and other agents)"
    • changedInput schema / properties / all / description
      Previous value: -"Sync to ALL formats: CLAUDE.md + AGENTS.md + .cursorrules + GEMINI.md + .github/copilot-instructions.md"New value: +"Write every format: CLAUDE.md + AGENTS.md + .cursorrules + GEMINI.md + .github/copilot-instructions.md"
    • changedInput schema / properties / copilot / description
      Previous value: -"Also sync to .github/copilot-instructions.md (GitHub Copilot)"New value: +"Also write .github/copilot-instructions.md (GitHub Copilot)"
    • changedInput schema / properties / cursor / description
      Previous value: -"Also sync to .cursorrules (Cursor IDE format)"New value: +"Also write .cursorrules (Cursor IDE)"
    • changedInput schema / properties / gemini / description
      Previous value: -"Also sync to GEMINI.md (Google Gemini format)"New value: +"Also write GEMINI.md (Google Gemini CLI)"
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "additionalProperties": true,
      +  "description": "The files faf_sync wrote, and each requested file it could not write.",
      +  "properties": {
      +    "fafPath": {
      +      "description": "The .faf the files were written from",
      +      "type": "string"
      +    },
      +    "filesFailed": {
      +      "description": "Requested files that were not written",
      +      "items": {
      +        "properties": {
      +          "file": {
      +            "type": "string"
      +          },
      +          "reason": {
      +            "type": "string"
      +          }
      +        },
      +        "required": [
      +          "file",
      +          "reason"
      +        ],
      +        "type": "object"
      +      },
      +      "type": "array"
      +    },
      +    "filesWritten": {
      +      "description": "Files written, CLAUDE.md first",
      +      "items": {
      +        "type": "string"
      +      },
      +      "type": "array"
      +    },
      +    "score": {
      +      "description": "faf-cli's score of that .faf, as text (\"85%\" or \"unknown (—)\")",
      +      "type": "string"
      +    }
      +  },
      +  "required": [
      +    "filesWritten",
      +    "filesFailed"
      +  ],
      +  "type": "object"
      +}
  2. Changed5 schema fields changedv5.14.1
    • addedInput schema / properties / agents
      Added value: +{
      +  "description": "Also sync to AGENTS.md (OpenAI/Codex format)",
      +  "type": "boolean"
      +}
    • addedInput schema / properties / all
      Added value: +{
      +  "description": "Sync to ALL formats: CLAUDE.md + AGENTS.md + .cursorrules + GEMINI.md + .github/copilot-instructions.md",
      +  "type": "boolean"
      +}
    • addedInput schema / properties / copilot
      Added value: +{
      +  "description": "Also sync to .github/copilot-instructions.md (GitHub Copilot)",
      +  "type": "boolean"
      +}
    • addedInput schema / properties / cursor
      Added value: +{
      +  "description": "Also sync to .cursorrules (Cursor IDE format)",
      +  "type": "boolean"
      +}
    • addedInput schema / properties / gemini
      Added value: +{
      +  "description": "Also sync to GEMINI.md (Google Gemini format)",
      +  "type": "boolean"
      +}
  3. First observedv4.0.0

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already declare idempotentHint=true and destructiveHint=false, so the safety profile is covered. The description adds real behavioral context beyond that: each target file preserves all lines outside faf's block, and failures are returned per-file with a reason plus isError. It does not say whether concurrent writes are safe, but the merge semantics are a meaningful addition.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

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

The purpose is front-loaded, but the text is one long run-on with redundant jargon — "faf-cli's render and injector" and "with faf-cli's writers" say the same thing twice and cost the reader without adding information. It is functional but not tight.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/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-value documentation is not strictly required, yet the description usefully frames the write results and failure reporting. With 6 optional params all documented in the schema, and file-preservation semantics stated, an agent has enough to invoke it correctly; only the sibling distinction is missing.

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 100%, so the baseline is 3. The description restates the flag-to-file mapping (agents, cursor, gemini, copilot, all) that the schema already documents, adding no syntax, precedence (e.g. all vs a single flag), or default behavior beyond it.

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 specific verb and resource — writing project.faf into CLAUDE.md as a faf-managed block, optionally into four other files. It is clear what the tool does, but it never distinguishes itself from the sibling faf_tri_sync, which is the nearest potential overlap, so an agent cannot rule that one out from the text alone.

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

Usage Guidelines4/5

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

"Use it after editing project.faf" gives a concrete trigger condition that tells the agent when this tool is appropriate. It provides no when-not guidance and does not name alternatives among the 13 siblings, so it stops short of full routing guidance but is more than implied usage.

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