Skip to main content
Glama

faf_bi_sync

Bi-directionally sync a project's .faf context file with CLAUDE.md and other AI tool formats, resolving conflicts to keep all AI assistant context aligned.

Instructions

Bi-directionally sync a project.faf with CLAUDE.md and, with the format flags or all, also AGENTS.md, .cursorrules, and GEMINI.md. Returns the formats written and any conflicts. Use this to keep every AI tool context file aligned from the single .faf source.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
allNoSync to ALL formats: CLAUDE.md + AGENTS.md + .cursorrules + GEMINI.md
autoNoEnable automatic synchronization
pathNoProject path. Sets session context for subsequent calls.
forceNoForce overwrite conflicting changes
watchNoStart real-time file watching for changes
agentsNoAlso sync to AGENTS.md (OpenAI/Codex format)
cursorNoAlso sync to .cursorrules (Cursor IDE format)
geminiNoAlso sync to GEMINI.md (Google Gemini format)
Behavior3/5

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

Description mentions returns 'formats written and any conflicts,' implying mutation and conflict detection. Annotations show readOnlyHint=false and destructiveHint=false, which align. However, does not disclose if files are created or overwritten, or any side effects beyond what annotations already convey.

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

Conciseness5/5

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

Two sentences front-load purpose and usage. No superfluous information. Efficient and clear.

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?

Description explains target files and return value but omits details like what project.faf is, whether files must exist, or how bi-directional sync behaves in conflict scenarios. No output schema to compensate. Adequate but leaves gaps.

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 covers 100% of 8 parameters with descriptions. Description adds minimal value by grouping flags as 'format flags or all' and mentioning they sync additional files. Baseline 3 is appropriate.

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?

Description clearly states bi-directional sync between project.faf and multiple AI context files (CLAUDE.md, AGENTS.md, .cursorrules, GEMINI.md). Uses specific verb and resource. However, does not distinguish from sibling faf_sync, which may overlap in functionality.

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?

Explicitly says 'Use this to keep every AI tool context file aligned from the single .faf source.' Provides use case but no when-not-to-use or alternatives. No prerequisites or context for when to use other sibling tools like faf_init or faf_check.

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/Wolfe-Jam/faf-mcp'

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