An open API service indexing awesome lists of open source software.

https://github.com/Wolfe-Jam/faf-mcp

Universal MCP server for .faf โ€” Cursor, Windsurf, VS Code, Cline, and all MCP-compatible platforms
https://github.com/Wolfe-Jam/faf-mcp

agents-md ai ai-context claude cline cursor developer-tools faf gemini grok mcp mcp-server model-context-protocol nodejs npm project-dna typescript vscode warp windsurf

Last synced: 3 months ago
JSON representation

Universal MCP server for .faf โ€” Cursor, Windsurf, VS Code, Cline, and all MCP-compatible platforms

Awesome Lists containing this project

README

          


FAF

faf-mcp


v2.0.0 โ€” The Interop MCP for Context



The MCP you didn't realise you needed, or wanted but didn't know who to ask, is here. Building on 36,000+ downloads across Claude and now Gemini, we bring you faf-mcp v2.0.0 to cure your syncing pain and fuel your chosen AI with optimized context, on-demand.

**The only IANA-Registered Format for AI Context** ยท `application/vnd.faf+yaml`

[![CI](https://github.com/Wolfe-Jam/faf-mcp/actions/workflows/ci.yml/badge.svg)](https://github.com/Wolfe-Jam/faf-mcp/actions/workflows/ci.yml)
[![NPM Downloads](https://img.shields.io/npm/dt/faf-mcp?label=total%20downloads&color=00CCFF)](https://www.npmjs.com/package/faf-mcp)
[![npm version](https://img.shields.io/npm/v/faf-mcp?color=00CCFF)](https://www.npmjs.com/package/faf-mcp)
[![Website](https://img.shields.io/badge/Website-faf.one-orange)](https://faf.one)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![project.faf](https://img.shields.io/badge/project.faf-inside-00D4D4)](https://github.com/Wolfe-Jam/faf)
[![Deploy](https://img.shields.io/badge/Deploy-Vercel-black)](https://vercel.com/new?repository-url=https://github.com/Wolfe-Jam/faf-mcp)

---

## Define once. Sync everywhere.

You maintain `.cursorrules`. Your teammate uses `AGENTS.md`. Someone on the team just switched to Gemini. Every AI tool wants its own context file โ€” and they all say the same thing in different formats.

**faf-mcp is the dedicated MCP server for Cursor, Windsurf, Cline, VS Code, and every non-Claude platform.** One `.faf` file in your repo, synced to every format your team needs.

```
project.faf
โ”‚
โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”
โ–ผ โ–ผ โ–ผ โ–ผ
CLAUDE.md AGENTS.md .cursorrules GEMINI.md
(Claude) (Codex) (Cursor) (Gemini)
```

### Quick Start

```bash
npx faf-mcp
```

Add to your MCP config:

```json
{"mcpServers": {"faf": {"command": "npx", "args": ["-y", "faf-mcp"]}}}
```

| Platform | Config File |
|----------|-------------|
| **Cursor** | `~/.cursor/mcp.json` |
| **Windsurf** | `~/.codeium/windsurf/mcp_config.json` |
| **Cline** | Cline MCP settings |
| **VS Code** | MCP extension config |
| **Claude Desktop** | Use [claude-faf-mcp](https://github.com/Wolfe-Jam/claude-faf-mcp) |

---

## Three Ways to Deploy

| Door | Method | Best For |
|------|--------|----------|
| **Hosted** | [mcpaas.live](https://mcpaas.live) | Zero-install, point any MCP client to the URL |
| **Self-Deploy** | [Deploy to Vercel](https://vercel.com/new?repository-url=https://github.com/Wolfe-Jam/faf-mcp) | Your own instance, full control |
| **Local** | `npx faf-mcp` | IDE integration via stdio transport |

### Hosted (mcpaas.live)

Point your MCP client to `https://mcpaas.live/sse` โ€” no install, no config, no maintenance. Served from 300+ Cloudflare edges with sub-ms cold starts via 2.7KB Zig-WASM engine.

### Self-Deploy (Vercel)

Deploy your own MCP server on Vercel in one click. Once deployed, your server exposes:
- `/health` โ€” Health check
- `/info` โ€” Server metadata + tool list
- `/sse` โ€” MCP Server-Sent Events transport

### Local (npm)

```bash
npx faf-mcp
```

---

## ๐Ÿ”„ Interop Tools

| Tool | Platform | Action |
|------|----------|--------|
| `faf_agents` | OpenAI Codex | Import/export/sync AGENTS.md |
| `faf_cursor` | Cursor IDE | Import/export/sync .cursorrules |
| `faf_gemini` | Google Gemini | Import/export/sync GEMINI.md |
| `faf_conductor` | Conductor | Import/export directory structure |
| `faf_git` | GitHub | Generate .faf from any repo URL |

```bash
# Sync to all formats at once
faf bi-sync --all

# Generate .faf from any GitHub repo
faf_git { url: "https://github.com/facebook/react" }
```

**61 tools** (25 core + 36 advanced) ยท **309 tests** (9 suites) ยท **7 bundled parsers**

---

## โ˜๏ธ Cloud Sync

Share your FAF context globally via [mcpaas.live](https://mcpaas.live):

| Tool | Purpose |
|------|---------|
| `faf_cloud_publish` | Upload to cloud, get shareable URL |
| `faf_cloud_fetch` | Pull context from cloud |
| `faf_cloud_list` | List available souls |
| `faf_cloud_search` | Search across souls |
| `faf_cloud_share` | Generate share links |

**Example Workflow:**
```bash
# Upload your project.faf
faf_cloud_publish { soul_name: "my-project" }
โ†’ https://mcpaas.live/souls/my-project

# Anyone can fetch it
faf_cloud_fetch { soul_name: "my-project" }
โ†’ Context merged into local project.faf
```

**Zero-install sharing** - Recipients need no MCP setup. Served from 300+ Cloudflare edges with <1ms cold starts via 2.7KB Zig-WASM engine.

---

## ๐Ÿ”„ Eternal Bi-Sync

Your `.faf` file and your platform context files stay synchronized in milliseconds.

```
project.faf โ†โ”€โ”€ 8ms โ”€โ”€โ†’ .cursorrules / AGENTS.md / CLAUDE.md / GEMINI.md
Single source of truth
```

- Update either side โ†’ both stay aligned
- `--all` flag syncs to all four formats at once
- Zero manual maintenance
- Works across teams, branches, sessions

AI assistants forget. They drift. Every new session, AI starts guessing again. Bi-sync means **context never goes stale**.

---

## Tier System: From Blind to Optimized

| Tier | Score | Status |
|------|-------|--------|
| ๐Ÿ† **Trophy** | 100% | **AI Optimized** โ€” Gold Code |
| ๐Ÿฅ‡ **Gold** | 99%+ | Near-perfect context |
| ๐Ÿฅˆ **Silver** | 95%+ | Excellent |
| ๐Ÿฅ‰ **Bronze** | 85%+ | Production ready |
| ๐ŸŸข **Green** | 70%+ | Solid foundation |
| ๐ŸŸก **Yellow** | 55%+ | AI flipping coins |
| ๐Ÿ”ด **Red** | <55% | AI working blind |
| ๐Ÿค **White** | 0% | No context at all |

**At 55%, AI is guessing half the time.** At 100%, AI is optimized.

---

## ๐Ÿ’ฌ use>faf | Prompt Pattern

**Start every prompt with "Use FAF"** to invoke MCP tools:

```
Use FAF to initialize my project
Use FAF to score my AI-readiness
Use FAF to sync my context
Use FAF to enhance my project
```

Works on all platforms โ€” stops web search, forces tool usage.

---

## ๐Ÿ› ๏ธ 25 Core MCP Tools

| Tool | Purpose |
|------|---------|
| `faf_init` | Initialize project.faf |
| `faf_score` | Check AI-readiness (0-100%) |
| `faf_sync` | Sync context across platforms |
| `faf_bi_sync` | Bi-directional .faf โ†” CLAUDE.md |
| `faf_enhance` | Intelligent enhancement |
| `faf_read` | Parse and validate FAF files |
| `faf_write` | Create/update FAF with validation |
| **๐Ÿ”„ Interop Tools** | |
| `faf_agents` | Import/export/sync AGENTS.md |
| `faf_cursor` | Import/export/sync .cursorrules |
| `faf_gemini` | Import/export/sync GEMINI.md |
| `faf_conductor` | Import/export directory structure |
| `faf_git` | Generate .faf from GitHub repo URL |
| **โ˜๏ธ Cloud Tools** | |
| `faf_cloud_publish` | Upload to mcpaas.live |
| `faf_cloud_fetch` | Pull from cloud |
| `faf_cloud_list` | List souls |
| `faf_cloud_search` | Search souls |
| `faf_cloud_share` | Generate share links |

**Plus 36 advanced tools and CLI fallback** (via faf-cli v5.0.1):
- `faf readme` - Extract 6 Ws from README (+25-35% boost)
- `faf human-add` - Non-interactive YAML merge (6Ws Builder)
- `faf git` - GitHub repo analysis without cloning
- And 40+ more commands...

---

## ๐Ÿ“ฆ Ecosystem

- **[claude-faf-mcp](https://npmjs.com/package/claude-faf-mcp)** โ€” Claude Desktop (33 tools)
- **[faf-cli](https://npmjs.com/package/faf-cli)** โ€” Terminal CLI
- **[faf-wasm](https://www.npmjs.com/package/faf-wasm)** โ€” WASM SDK (<5ms scoring)
- **[faf.one](https://faf.one)** โ€” Official website

---

## ๐Ÿ“„ License

MIT License โ€” Free and open source

---

**Zero drift. Eternal sync. AI optimized.** ๐Ÿ†

*"It's so logical if it didn't exist, AI would have built it itself" โ€” Claude*