Skip to main content

Persistent Project Context for Google Gemini. IANA-registered .faf format, MCP server + Cloud Run REST API, unifies CLAUDE.md, GEMINI.md, AGENTS.md.

Project description

gemini-faf-mcp — The Chameleon Edition

Persistent Project Context for Google Gemini. Define once. Sync everywhere.

FAF defines. MD instructs. AI codes.

Stop re-explaining your project to every new Gemini session. Every Gemini conversation starts cold — you re-state your stack, your goals, your conventions every single time. .faf is one structured file that captures all of it. This package is the MCP server that lets Gemini read it.

PyPI FAF Trophy 100% Tests IANA: vnd.faf+yaml IANA: vnd.fafm+yaml DOI: Context paper DOI: Memory paper

Before and after

Without FAF                           With FAF (.faf at 85%+ Bronze)
─────────────────────────             ─────────────────────────
You: "I'm using FastAPI with...       You: "Add a /users/me endpoint"
      PostgreSQL, pytest, and..."     Gemini: [generates correct code,
Gemini: "Got it. What's the              uses your auth pattern,
        codebase like?"                  matches your test style]
You: "It's a REST API for..."
[5 minutes of re-explaining]
Gemini: [now ready to help]

.faf is read once at session start. Every tool call lands on a Gemini that already knows your project.

What's New in v2.4.2 — The Confinement Edition

Security release. Caller-supplied path arguments are now confined: read tools open only .faf / .fafm context files, and faf_init writes only inside the project root (override with FAF_ALLOWED_ROOTS). Closes a path-traversal / arbitrary local-file read — and an arbitrary file write via faf_init. Reported via coordinated disclosure. See the CHANGELOG.

v2.4.0 — The Chameleon Edition: one command, both modes — gemini-faf-mcp auto-selects its transport: stdio locally, Streamable HTTP on Cloud Run. Same binary, 12 tools, zero config. v2.3.0 moved the hosted path off deprecated SSE onto Streamable HTTP (stateless + JSON) for Cloud Run.


One-Minute Setup

1. Install

pip install gemini-faf-mcp

2. Add to Gemini CLI

gemini extensions install https://github.com/Wolfe-Jam/gemini-faf-mcp

3. Generate your project context

In your Gemini CLI:

> /faf:setup

You should see: Created project.faf — Score: 85% (BRONZE). From this point, every Gemini session in this project reads it automatically.

Tip: A score of 85% (BRONZE) is the minimum where Gemini stops guessing. Run /faf:score to see what's missing and how to push to 100% (TROPHY).


The "One-File" Advantage

A .faf file is structured YAML that captures your project DNA. Every AI agent reads it once and knows exactly what you're building.

# project.faf — your project, machine-readable
faf_version: '2.5.0'
project:
  name: my-api
  goal: REST API for user management
  main_language: Python
stack:
  backend: FastAPI
  database: PostgreSQL
  testing: pytest
human_context:
  who: Backend developers
  what: User CRUD with auth
  why: Replace legacy PHP service

Result: Gemini reads this once and knows your project. No 20-minute onboarding. No wrong assumptions. Every session starts aligned.

FAF defines. MD instructs. AI codes.

What about my GEMINI.md?

You don't replace it. .faf generates it. Run faf_gemini and you get a fresh GEMINI.md with the structured project data baked in as YAML frontmatter — the same GEMINI.md Gemini CLI already reads, but generated from a single source of truth instead of hand-maintained.

> /faf:export
# Generates GEMINI.md from project.faf

.faf is the source. GEMINI.md is one of its outputs. Same logic for AGENTS.md (OpenAI Codex), .cursorrules, CLAUDE.md, and others — write once, render everywhere.


Auto-Detect Your Stack

faf_auto scans your project's manifest files and generates a .faf with accurate slot values. No manual entry needed.

> Auto-detect my project stack
{
  "detected": {
    "main_language": "Python",
    "package_manager": "pip",
    "build_tool": "setuptools",
    "framework": "FastMCP",
    "api_type": "MCP",
    "database": "BigQuery"
  },
  "score": 100,
  "tier": "TROPHY"
}

What it scans:

File Detects
pyproject.toml Python + build system + frameworks (FastAPI, Django, Flask, FastMCP) + databases
package.json JavaScript/TypeScript + frameworks (React, Vue, Next.js, Express)
Cargo.toml Rust + cargo + frameworks (Axum, Actix)
go.mod Go + go modules + frameworks (Gin, Echo)
requirements.txt Python (fallback)
Gemfile Ruby
composer.json PHP

Priority rule: pyproject.toml / Cargo.toml / go.mod take priority over package.json. Only sets values that are actually detected — no hardcoded defaults.


All 12 Tools

Create & Detect

Tool What it does
faf_init Create a starter .faf file with project name, goal, and language
faf_auto Auto-detect stack from manifest files and generate/update .faf
faf_discover Find .faf files in the project tree

Validate & Score

Tool What it does
faf_validate Full Mk4 validation — score, tier, slot counts, errors, warnings
faf_score Quick Mk4 score — score, tier, populated/active/total slot counts

Read & Transform

Tool What it does
faf_read Parse a .faf file into structured data
faf_stringify Convert parsed FAF data back to clean YAML
faf_context Get Gemini-optimized context (project + stack + score)

Export & Interop

Tool What it does
faf_gemini Export GEMINI.md with YAML frontmatter for Gemini CLI
faf_agents Export AGENTS.md for OpenAI Codex, Cursor, and other AI tools

Reference

Tool What it does
faf_about FAF format info — IANA registration, version, ecosystem
faf_model Get a 100% Trophy-scored example .faf for any of 15 project types

Score and Tier System

Your .faf file is scored on completeness — how many slots are filled with real values.

Score Tier Meaning
100% TROPHY AI has full context for your project
99% GOLD Exceptional
95% SILVER Top tier
85% BRONZE Minimum recommended — AI can build from here
70% GREEN Solid foundation
55% YELLOW Needs improvement
<55% RED Major gaps — AI will guess
0% WHITE Empty

Aim for Bronze (85%+). That's where AI stops guessing and starts knowing.


Using with Gemini CLI

> Create a .faf file for my Python FastAPI project
> Auto-detect my project and fill in the stack
> Score my .faf and show what's missing
> Export GEMINI.md for this project
> Show me a 100% example for an MCP server
> What is FAF and how does it work?
> Read my project.faf and summarize the stack
> Validate my .faf and fix the warnings

Architecture

gemini-faf-mcp v2.4.2
├── server.py              → FastMCP MCP server (12 tools, dual-transport, Mk4 scoring)
├── safe_path.py           → path confinement for caller-supplied `path` args
├── main.py                → Cloud Run REST API (GET/POST/PUT)
├── models.py              → 15 project type examples
└── src/gemini_faf_mcp/    → Python SDK (FAFClient, parser)

The MCP server delegates to faf-python-sdk for parsing, validation, and Mk4 scoring. Stack detection in faf_auto is Python-native — no external CLI dependencies.


Testing

pip install -e ".[dev]"
python -m pytest tests/ -v

221 tests passing across 9 WJTTC tiers (125 MCP server + 55 Cloud Function + 41 Mk4 WJTTC championship). Championship-grade test coverage — WJTTC certified.


FAF Ecosystem

One format, every AI platform.

Package Platform Registry
claude-faf-mcp Anthropic npm + MCP #2759
gemini-faf-mcp Google PyPI
grok-faf-mcp xAI npm
rust-faf-mcp Rust crates.io
faf-cli Universal npm

Python SDK

Use FAF directly in Python without MCP:

from gemini_faf_mcp import FAFClient, parse_faf, validate_faf, find_faf_file

# Parse and validate locally
data = parse_faf("project.faf")
result = validate_faf(data)
print(f"Score: {result['score']}%, Tier: {result['tier']}")

# Find .faf files automatically
faf_path = find_faf_file(".")

# Or use the Cloud Run endpoint
client = FAFClient()
dna = client.get_project_dna()

Cloud Run REST API

Live endpoint for badges, multi-agent context brokering, and voice-to-FAF mutations.

https://faf-source-of-truth-631316210911.us-east1.run.app

Supports agent-optimized responses (Gemini, Claude, Grok, Jules, Codex/Copilot/Cursor) via X-FAF-Agent header. Voice mutations via Gemini Live through PUT endpoint. Auto-deploys via Cloud Build on push to main.


If gemini-faf-mcp has been useful, consider starring the repo — it helps others find it.


Links

License

MIT


Built by @wolfe_jam | wolfejam.dev


Get the CLI

faf-cli — The original AI-Context CLI. A must-have for every builder.

npx faf-cli auto

Anthropic MCP #2759 · IANA Registered: application/vnd.faf+yaml · faf.one · npm

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gemini_faf_mcp-2.4.2.tar.gz (42.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

gemini_faf_mcp-2.4.2-py3-none-any.whl (27.7 kB view details)

Uploaded Python 3

File details

Details for the file gemini_faf_mcp-2.4.2.tar.gz.

File metadata

  • Download URL: gemini_faf_mcp-2.4.2.tar.gz
  • Upload date:
  • Size: 42.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for gemini_faf_mcp-2.4.2.tar.gz
Algorithm Hash digest
SHA256 dacb8827bee4c299528e5b703f99d86936d38765c9b566544385729324a32136
MD5 2d513ae148de240a3c0b73ad3d616cb9
BLAKE2b-256 0ab8fec14c04cc9f28ac6b215c15a88674c940b46dc16f0bc475f11c554e57a8

See more details on using hashes here.

Provenance

The following attestation bundles were made for gemini_faf_mcp-2.4.2.tar.gz:

Publisher: pypi.yml on Wolfe-Jam/gemini-faf-mcp

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file gemini_faf_mcp-2.4.2-py3-none-any.whl.

File metadata

  • Download URL: gemini_faf_mcp-2.4.2-py3-none-any.whl
  • Upload date:
  • Size: 27.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for gemini_faf_mcp-2.4.2-py3-none-any.whl
Algorithm Hash digest
SHA256 14a5e6a992325d3e1d3707f1133caa04f532fb36548fe25fc28406a7a3b068ca
MD5 21c2aa3e1788a83863456a3cbbfdf3b4
BLAKE2b-256 8263cbd6d4875c71e48583bad99b1131406084b835d6923216080826063e0bdd

See more details on using hashes here.

Provenance

The following attestation bundles were made for gemini_faf_mcp-2.4.2-py3-none-any.whl:

Publisher: pypi.yml on Wolfe-Jam/gemini-faf-mcp

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page