claude-faf-mcp 3.1.5 → 3.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +22 -0
- package/README.md +82 -488
- package/dist/src/handlers/championship-tools.js +79 -1
- package/dist/src/handlers/championship-tools.js.map +1 -1
- package/dist/src/handlers/tool-types.d.ts +1 -0
- package/dist/src/handlers/tools.js.map +1 -1
- package/dist/src/types/tool-visibility.js +2 -4
- package/dist/src/types/tool-visibility.js.map +1 -1
- package/package.json +5 -1
package/CHANGELOG.md
CHANGED
|
@@ -5,6 +5,28 @@ All notable changes to claude-faf-mcp will be documented in this file.
|
|
|
5
5
|
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
|
6
6
|
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
7
7
|
|
|
8
|
+
## [3.2.0] - 2025-11-10
|
|
9
|
+
|
|
10
|
+
### Added
|
|
11
|
+
- **Podium Edition Scorecard** - Full championship-style scorecard with `faf_score --full` flag
|
|
12
|
+
- Dynamic status tiers (PODIUM EDITION, RACE READY, QUALIFYING, IN DEVELOPMENT)
|
|
13
|
+
- Four detailed sections with live progress bars (Core Intelligence, Context Delivery, Performance, Standalone Operation)
|
|
14
|
+
- Real-time metrics calculated based on project files (project.faf, CLAUDE.md, README.md, package.json)
|
|
15
|
+
- Smart next steps based on what's missing in your project
|
|
16
|
+
- Mobile-friendly "project.faf score: podium" format
|
|
17
|
+
- Includes new Claude quote: "It's so logical if it didn't exist, AI would have built it itself"
|
|
18
|
+
|
|
19
|
+
### Changed
|
|
20
|
+
- **README Restructure** - Following Svelte/Vercel pattern for clean landing page
|
|
21
|
+
- README.md now uses clean landing page content (155 lines → from 564 lines)
|
|
22
|
+
- Version history moved to CHANGELOG.md (this file)
|
|
23
|
+
- GitHub Pages (wolfe-jam.github.io/claude-faf-mcp/) is now canonical documentation
|
|
24
|
+
- Landing page tagline updated to new Claude quote
|
|
25
|
+
- Title color changed to orange (#FF8C00) for brand consistency
|
|
26
|
+
|
|
27
|
+
### Project Milestone
|
|
28
|
+
This release inaugurates the "project.faf scorecard era" - transforming the static documentation scorecard into a dynamic, interactive feature accessible through MCP tools.
|
|
29
|
+
|
|
8
30
|
## [3.0.5] - 2025-11-07
|
|
9
31
|
|
|
10
32
|
### Added
|
package/README.md
CHANGED
|
@@ -1,563 +1,157 @@
|
|
|
1
1
|
<div style="display: flex; align-items: center; gap: 12px;">
|
|
2
2
|
<img src="https://raw.githubusercontent.com/Wolfe-Jam/faf/main/assets/logos/orange-smiley.svg" alt="FAF" width="40" />
|
|
3
3
|
<div>
|
|
4
|
-
<h1 style="margin: 0;">claude-faf-mcp</h1>
|
|
4
|
+
<h1 style="margin: 0; color: #FF8C00;">claude-faf-mcp</h1>
|
|
5
5
|
<p style="margin: 4px 0 0 0;"><strong>IANA-Registered Format for AI Context</strong> · <code>application/vnd.faf+yaml</code></p>
|
|
6
6
|
</div>
|
|
7
7
|
</div>
|
|
8
8
|
|
|
9
|
-
> Official MCP server for FAF (Foundational AI-context Format) with 50
|
|
10
|
-
> Persistent project context that integrates seamlessly with Claude Desktop workflows
|
|
9
|
+
> Official MCP server for FAF (Foundational AI-context Format) with 50 tools - Persistent project context that integrates seamlessly with Claude Desktop workflows
|
|
11
10
|
|
|
12
11
|
[](https://www.npmjs.com/package/claude-faf-mcp)
|
|
13
12
|
[](https://discord.com/invite/3pjzpKsP)
|
|
14
13
|
[](https://chromewebstore.google.com/detail/lnecebepmpjpilldfmndnaofbfjkjlkm)
|
|
15
14
|
[](https://faf.one)
|
|
16
|
-
[](https://github.com/Wolfe-Jam/faf/blob/main/SPECIFICATION.md)
|
|
17
|
-
[](https://faf.one/blog/iana-registration)
|
|
18
15
|
[](https://opensource.org/licenses/MIT)
|
|
19
16
|
|
|
20
17
|
---
|
|
21
18
|
|
|
22
|
-
##
|
|
19
|
+
## 🏁 AI-Readiness Scorecard
|
|
23
20
|
|
|
24
|
-
**The
|
|
25
|
-
|
|
26
|
-
```
|
|
27
|
-
Model Context Protocol
|
|
28
|
-
───── ─────── ────────
|
|
29
|
-
LLM → IANA Format → Open Protocol
|
|
30
|
-
Claude → .faf → MCP
|
|
31
|
-
Gemini → .faf → MCP
|
|
32
|
-
Codex → .faf → MCP
|
|
33
|
-
Any LLM → .faf → MCP
|
|
34
|
-
```
|
|
35
|
-
|
|
36
|
-
**.FAF is the foundational, universal base layer** for any Model using the MCP Protocol.
|
|
37
|
-
|
|
38
|
-
.FAF provides the standardized Context that makes the Model Context Protocol work for everyone.
|
|
39
|
-
|
|
40
|
-
---
|
|
41
|
-
|
|
42
|
-
## 🏎️ v3.0.5 - 100% Standalone Achievement
|
|
21
|
+
**The closer you get to 100% the better AI can assist you.**
|
|
43
22
|
|
|
44
|
-
|
|
23
|
+
At 55% you are building your project with half a blueprint and basically flipping a coin with AI. .FAF defines, and AI becomes optimized for Context with the project.faf file.
|
|
45
24
|
|
|
46
|
-
**100% STANDALONE OPERATION** - Zero CLI dependencies across all 50 MCP tools.
|
|
47
|
-
|
|
48
|
-
#### Historic Milestone
|
|
49
|
-
- ✅ **50/50 MCP tools operational** (100% standalone)
|
|
50
|
-
- ✅ **14/14 bundled commands** (zero CLI dependencies)
|
|
51
|
-
- ✅ **16.2x average speedup** over CLI versions
|
|
52
|
-
- ✅ **19ms average execution** across all bundled commands
|
|
53
|
-
|
|
54
|
-
#### New Bundled Commands
|
|
55
|
-
- **faf_quick** - Lightning-fast project.faf creation (3ms avg)
|
|
56
|
-
- **faf_enhance** - Intelligent enhancement with auto-detection + MCP-native questionnaire (63ms)
|
|
57
|
-
|
|
58
|
-
#### Mk3 Bundled Engine
|
|
59
|
-
Core FAF CLI compiler code bundled directly into MCP:
|
|
60
|
-
- **16.2x faster** (direct function calls vs process spawning)
|
|
61
|
-
- **19ms average** across all bundled commands
|
|
62
|
-
- **Fastest: 1ms** (formats command)
|
|
63
|
-
- **Unmeasurable: 0ms** (migrate command - too fast!)
|
|
64
|
-
- **Zero memory leaks** with championship-grade performance
|
|
65
|
-
|
|
66
|
-
#### project.faf Standard
|
|
67
|
-
ONE filename for new projects:
|
|
68
|
-
- **New files use project.faf** (visible, universal standard)
|
|
69
|
-
- **Legacy .faf still readable** (with gentle migration suggestion)
|
|
70
|
-
- **Visible like package.json** (no more hidden files for new projects!)
|
|
71
|
-
- **ONE standard going forward** across all tools and platforms
|
|
72
|
-
|
|
73
|
-
### 💡 Legacy .faf Support with Migration Path
|
|
74
|
-
|
|
75
|
-
v3.0.0 prioritizes `project.faf` but **still reads** legacy `.faf` files.
|
|
76
|
-
|
|
77
|
-
**What happens with `.faf` files:**
|
|
78
|
-
- ✅ **Reads your existing `.faf` files** (no breakage!)
|
|
79
|
-
- 💡 **Shows migration suggestion** (gentle reminder)
|
|
80
|
-
- 🚫 **Never creates new `.faf` files** (always uses project.faf)
|
|
81
|
-
|
|
82
|
-
**To migrate (optional):**
|
|
83
|
-
```bash
|
|
84
|
-
# Run this in your project directory:
|
|
85
|
-
faf migrate
|
|
86
|
-
|
|
87
|
-
# Takes <1 second, renames .faf → project.faf
|
|
88
25
|
```
|
|
26
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
27
|
+
🏎️ FAF AI-READINESS SCORE: 100/100 — PODIUM EDITION
|
|
28
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
89
29
|
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
30
|
+
📊 CORE INTELLIGENCE 🎯 CONTEXT DELIVERY
|
|
31
|
+
├─ Project DNA [██████] 100% ├─ MCP Protocol [██████] 100%
|
|
32
|
+
├─ Architecture Map [██████] 100% ├─ 50 Native Tools [██████] 100%
|
|
33
|
+
├─ Domain Model [██████] 100% ├─ IANA Format [██████] 100%
|
|
34
|
+
└─ Version Tracking [██████] 100% └─ Universal Context [██████] 100%
|
|
93
35
|
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
npx -y claude-faf-mcp
|
|
100
|
-
```
|
|
36
|
+
🚀 PERFORMANCE ⚡ STANDALONE OPERATION
|
|
37
|
+
├─ 16.2x CLI Speedup [██████] 100% ├─ Zero Dependencies [██████] 100%
|
|
38
|
+
├─ 19ms Avg Execution [██████] 100% ├─ Bundled Engine [██████] 100%
|
|
39
|
+
├─ 50/50 Tools Active [██████] 100% ├─ Direct Function [██████] 100%
|
|
40
|
+
└─ Zero Memory Leaks [██████] 100% └─ 14 Bundled Cmds [██████] 100%
|
|
101
41
|
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
{
|
|
105
|
-
"mcpServers": {
|
|
106
|
-
"claude-faf-mcp": {
|
|
107
|
-
"command": "npx",
|
|
108
|
-
"args": ["-y", "claude-faf-mcp"]
|
|
109
|
-
}
|
|
110
|
-
}
|
|
111
|
-
}
|
|
42
|
+
🏆 project.faf score: podium
|
|
43
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
112
44
|
```
|
|
113
45
|
|
|
114
|
-
### Performance Metrics
|
|
115
|
-
|
|
116
|
-
- **Average execution**: 19ms (championship grade ✅)
|
|
117
|
-
- **Fastest command**: 1ms (formats)
|
|
118
|
-
- **Unmeasurable**: 0ms (migrate - too fast to measure!)
|
|
119
|
-
- **Speedup vs CLI**: 16.2x average
|
|
120
|
-
- **Memory**: Zero leaks with championship performance ✅
|
|
121
|
-
- **WJTTC Certified**: 14/14 bundled commands, 50/50 tools, 100% pass rate ✅
|
|
122
|
-
|
|
123
46
|
---
|
|
124
47
|
|
|
125
|
-
|
|
126
|
-
**faf-expert** is on-hand, 24/7 - your resident faf specialist and Master of
|
|
127
|
-
**21 Core Tools** and **30+ Advanced Tools**, **51 in all**
|
|
128
|
-
|
|
129
|
-
---
|
|
130
|
-
|
|
131
|
-
## TL;DR
|
|
132
|
-
|
|
133
|
-
**Problem:** AI needs persistent project context—not just md docs or tools, but foundational infrastructure.
|
|
134
|
-
|
|
135
|
-
**Solution:** The .faf format is a structured, machine-readable context layer. This MCP server gives Claude 50+ tools to create, score, and improve your project's persistent context through format-driven architecture.
|
|
136
|
-
|
|
137
|
-
**How it works:** Get a score (0-100%) showing how well AI understands your project. Higher scores = AI more in-tune with your codebase. Use tools to improve your score and context quality. Your .faf context persists across sessions.
|
|
138
|
-
|
|
139
|
-
**DROP or PASTE, Click & Go!**
|
|
140
|
-
|
|
141
|
-
🎯 Got .faf? DROP or PASTE it
|
|
142
|
-
📦 Got project? DROP or PASTE README or package.json
|
|
143
|
-
💬 Starting fresh? Just ask
|
|
144
|
-
|
|
145
|
-
**Install:**
|
|
146
|
-
|
|
147
|
-
Via npm:
|
|
148
|
-
```bash
|
|
149
|
-
npm install -g claude-faf-mcp
|
|
150
|
-
```
|
|
48
|
+
## ⚡ Quick Start
|
|
151
49
|
|
|
152
|
-
Via Homebrew:
|
|
153
50
|
```bash
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
**Configure:** Add to `claude_desktop_config.json`:
|
|
158
|
-
```json
|
|
159
|
-
{
|
|
160
|
-
"mcpServers": {
|
|
161
|
-
"claude-faf-mcp": {
|
|
162
|
-
"command": "claude-faf-mcp"
|
|
163
|
-
}
|
|
164
|
-
}
|
|
165
|
-
}
|
|
166
|
-
```
|
|
167
|
-
|
|
168
|
-
## Using Other AI Tools?
|
|
169
|
-
|
|
170
|
-
This MCP server is for **Claude Desktop**. If you also use **Claude Code**, **Cursor**, **Windsurf**, **Gemini CLI**, **OpenAI Codex**, **Warp**, or any terminal-based AI:
|
|
51
|
+
# Install via npx (recommended - always latest)
|
|
52
|
+
npx @modelcontextprotocol/inspector npx -y claude-faf-mcp
|
|
171
53
|
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
npm install -g faf-cli
|
|
175
|
-
# or
|
|
176
|
-
brew install faf-cli
|
|
54
|
+
# Or install globally
|
|
55
|
+
npm install -g claude-faf-mcp
|
|
177
56
|
```
|
|
178
57
|
|
|
179
|
-
|
|
180
|
-
Works with every AI tool. **[faf-cli on npm →](https://www.npmjs.com/package/faf-cli)**
|
|
181
|
-
|
|
182
|
-
**[Website](https://faf.one)** • **[Discord](https://discord.com/invite/3pjzpKsP)** • **[GitHub](https://github.com/Wolfe-Jam/claude-faf-mcp)** • **[Discussions](https://github.com/Wolfe-Jam/claude-faf-mcp/discussions)**
|
|
183
|
-
|
|
184
|
-
---
|
|
185
|
-
|
|
186
|
-
### 📸 See It In Action
|
|
187
|
-
|
|
188
|
-
<div align="center">
|
|
189
|
-
<img src="https://raw.githubusercontent.com/Wolfe-Jam/faf/main/assets/screenshots/package-json-project-faf.png" alt="project.faf sits between package.json and README.md" width="500" />
|
|
190
|
-
|
|
191
|
-
**`project.faf` sits right between `package.json` and `README.md`** - exactly where it belongs.
|
|
192
|
-
|
|
193
|
-
Visible. Discoverable. Universal.
|
|
194
|
-
</div>
|
|
195
|
-
|
|
196
|
-
---
|
|
197
|
-
|
|
198
|
-
## Official Status
|
|
199
|
-
|
|
200
|
-
claude-faf-mcp is officially published in the Anthropic MCP Registry (PR #2759). This is the first and only persistent project context server in the official Anthropic ecosystem.
|
|
201
|
-
|
|
202
|
-
Registry listing: "MCP server for .faf format. The only persistent project context scoring engine in the Anthropic registry."
|
|
203
|
-
|
|
204
|
-
Published to official Anthropic MCP registry with validation by Anthropic engineering team. Current metrics: 4,700 total downloads with 598 downloads per week.
|
|
205
|
-
|
|
206
|
-
## Major Milestones
|
|
207
|
-
|
|
208
|
-
- **Aug 8, 2025** - Format created, first official .faf file is generated
|
|
209
|
-
- **Sep 1, 2025** - Developer platform launch (fafdev.tools)
|
|
210
|
-
- **Sep 11, 2025** - First Google Chrome Web Store approval
|
|
211
|
-
- **Sep 16, 2025** - MCP Server v2.0.0 published to npm
|
|
212
|
-
- **Sep 24, 2025** - CLI v2.1.0 published to npm
|
|
213
|
-
- **Oct 17, 2025** - Official Anthropic MCP Registry merger (PR #2759)
|
|
214
|
-
- **Oct 29, 2025** - Second Google Chrome Web Store approval
|
|
215
|
-
- **Oct 31, 2025** - **IANA Registration** 🏆 (`application/vnd.faf+yaml`)
|
|
216
|
-
|
|
217
|
-
**Quadruple Validation: IANA, Anthropic, Google (2x)**
|
|
218
|
-
|
|
219
|
-
---
|
|
220
|
-
|
|
221
|
-
## What's New in v2.8.0 - Tool Visibility System
|
|
222
|
-
|
|
223
|
-
**v2.8.0 introduces intelligent tool filtering to reduce cognitive load.**
|
|
224
|
-
|
|
225
|
-
### New Features
|
|
226
|
-
|
|
227
|
-
**21 Core Tools (Default)**
|
|
228
|
-
Essential workflow tools shown by default:
|
|
229
|
-
- Workflow: `faf`, `faf_auto`, `faf_init`, `faf_innit`, `faf_status`
|
|
230
|
-
- Quality: `faf_score`, `faf_validate`, `faf_doctor`, `faf_audit`
|
|
231
|
-
- Intelligence: `faf_formats`, `faf_stacks`, `faf_skills`
|
|
232
|
-
- Sync: `faf_sync`, `faf_bi_sync`, `faf_update`, `faf_migrate`
|
|
233
|
-
- AI: `faf_chat`, `faf_enhance`
|
|
234
|
-
- Help: `faf_index`, `faf_faq`, `faf_about`
|
|
235
|
-
|
|
236
|
-
**30+ Advanced Tools (Opt-in)**
|
|
237
|
-
Expert-level tools available via environment variable:
|
|
238
|
-
- Display variants: `faf_display`, `faf_show`, `faf_check`
|
|
239
|
-
- Trust system: `faf_trust`, `faf_trust_confidence`, `faf_trust_garage`
|
|
240
|
-
- File operations: `faf_read`, `faf_write`, `faf_list`, `faf_exists`
|
|
241
|
-
- DNA tracking: `faf_dna`, `faf_log`, `faf_auth`, `faf_recover`
|
|
242
|
-
- Utilities: `faf_choose`, `faf_clear`, `faf_share`, `faf_credit`
|
|
243
|
-
|
|
244
|
-
**Enable Advanced Tools:**
|
|
58
|
+
**Claude Desktop Configuration:**
|
|
245
59
|
```json
|
|
246
60
|
{
|
|
247
61
|
"mcpServers": {
|
|
248
|
-
"
|
|
249
|
-
"command": "
|
|
250
|
-
"
|
|
251
|
-
"FAF_MCP_SHOW_ADVANCED": "true"
|
|
252
|
-
}
|
|
62
|
+
"faf": {
|
|
63
|
+
"command": "npx",
|
|
64
|
+
"args": ["-y", "claude-faf-mcp"]
|
|
253
65
|
}
|
|
254
66
|
}
|
|
255
67
|
}
|
|
256
68
|
```
|
|
257
69
|
|
|
258
|
-
**New! Claude Code Skill**
|
|
259
|
-
The `faf-expert` skill is now available - your on-hand 24/7 FAF specialist:
|
|
260
|
-
- Expert guidance on .faf files and project DNA
|
|
261
|
-
- Tool Visibility System documentation
|
|
262
|
-
- MCP server configuration help
|
|
263
|
-
- AI-readiness scoring assistance
|
|
264
|
-
|
|
265
|
-
### Performance
|
|
266
|
-
- **<10ms tool filtering** (5x better than 50ms championship target)
|
|
267
|
-
- **57 tests passing** - All existing functionality preserved
|
|
268
|
-
- **Zero regressions** - Complete validation
|
|
269
|
-
- **WJTTC Gold Certified** - F1-inspired testing standards
|
|
270
|
-
|
|
271
|
-
### Previous: v2.7.2 - IANA Registration
|
|
272
|
-
|
|
273
|
-
On **October 31, 2025**, IANA officially registered `.faf` as `application/vnd.faf+yaml` - making it an Internet-standard format alongside PDF, JSON, and XML
|
|
274
|
-
- API standardization across platforms
|
|
275
|
-
|
|
276
|
-
This documentation update adds IANA information throughout the README to reflect this major infrastructure-level achievement.
|
|
277
|
-
|
|
278
70
|
---
|
|
279
71
|
|
|
280
|
-
## What
|
|
281
|
-
|
|
282
|
-
**v2.7.0 introduces `project.faf` as the new standard for every repository.**
|
|
283
|
-
|
|
284
|
-

|
|
285
|
-
|
|
286
|
-
**`package.json` for AI.**
|
|
72
|
+
## 🎯 What is FAF?
|
|
287
73
|
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
| File | Purpose | Who Reads It |
|
|
291
|
-
|------|---------|--------------|
|
|
292
|
-
| `package.json` | Dependencies, scripts, metadata | npm, Node.js, developers |
|
|
293
|
-
| `project.faf` | **Context, architecture, purpose** | **AI, Claude, Cursor, any AI tool** |
|
|
294
|
-
|
|
295
|
-
Same pattern. Same universality. Same necessity.
|
|
296
|
-
|
|
297
|
-
**What changed:**
|
|
298
|
-
- New projects create `project.faf` (not hidden `.faf`)
|
|
299
|
-
- Your existing `.faf` files work perfectly
|
|
300
|
-
- Rename with `faf migrate` (CLI v3.1.0) for better visibility
|
|
301
|
-
|
|
302
|
-
**Why it matters:**
|
|
303
|
-
|
|
304
|
-
```bash
|
|
305
|
-
# Before (hidden like secrets)
|
|
306
|
-
ls -la
|
|
307
|
-
.env # Hidden (secrets - should be hidden)
|
|
308
|
-
.faf # Hidden (AI context - should be visible!)
|
|
309
|
-
|
|
310
|
-
# After (visible like package.json)
|
|
311
|
-
ls
|
|
312
|
-
package.json # Visible (dependencies)
|
|
313
|
-
project.faf # Visible (AI context)
|
|
314
|
-
.env # Still hidden (secrets stay secret)
|
|
315
|
-
```
|
|
316
|
-
|
|
317
|
-
`.env` hides secrets. `project.faf` shares context.
|
|
318
|
-
|
|
319
|
-
`.faf` was hiding in the wrong category. `project.faf` fixes that.
|
|
320
|
-
|
|
321
|
-
You wouldn't skip `package.json`. Don't skip `project.faf`.
|
|
322
|
-
|
|
323
|
-
Coordinated with faf-cli v3.1.0 for seamless ecosystem integration.
|
|
324
|
-
|
|
325
|
-
---
|
|
326
|
-
|
|
327
|
-
## What is FAF?
|
|
328
|
-
|
|
329
|
-
FAF (Foundational AI-context Format) is the **IANA-registered format** for persistent project context in AI development tools.
|
|
330
|
-
|
|
331
|
-
**Official Media Type:** `application/vnd.faf+yaml`
|
|
332
|
-
**Registration Date:** October 31, 2025
|
|
333
|
-
**IANA Status:** Recognized Internet standard
|
|
334
|
-
|
|
335
|
-
### Why IANA Registration Matters
|
|
336
|
-
|
|
337
|
-
- **Internet-Scale Legitimacy** - Same recognition as PDF (`application/pdf`), JSON (`application/json`), XML (`application/xml`)
|
|
338
|
-
- **Universal Compatibility** - Browsers, email clients, APIs handle `.faf` files properly
|
|
339
|
-
- **HTTP Standard Headers** - `Content-Type: application/vnd.faf+yaml` is officially registered
|
|
340
|
-
- **Future-Proof** - Format backed by Internet standards body
|
|
341
|
-
|
|
342
|
-
### The .faf Advantage
|
|
343
|
-
|
|
344
|
-
Traditional approach:
|
|
345
|
-
```bash
|
|
346
|
-
# Manual context setup (5+ minutes)
|
|
347
|
-
1. Copy README
|
|
348
|
-
2. List files
|
|
349
|
-
3. Explain architecture
|
|
350
|
-
4. Share with AI
|
|
351
|
-
```
|
|
352
|
-
|
|
353
|
-
FAF approach:
|
|
354
|
-
```bash
|
|
355
|
-
# Automated context (< 1 second)
|
|
356
|
-
npx -y claude-faf-mcp
|
|
357
|
-
faf init
|
|
358
|
-
# Done - complete project DNA in .faf file
|
|
359
|
-
```
|
|
360
|
-
|
|
361
|
-
---
|
|
362
|
-
|
|
363
|
-
## What is claude-faf-mcp?
|
|
364
|
-
|
|
365
|
-
An MCP server that brings the .faf format to Claude Desktop for persistent project context. The .faf format (Foundational AI-Context Format) is a structured, machine-readable context layer designed as foundational infrastructure—not tools, not documentation, but format.
|
|
366
|
-
|
|
367
|
-
**Format-Driven Architecture**
|
|
368
|
-
|
|
369
|
-
Everything flows through structured format. The .faf file is your project's persistent context layer. It survives across sessions, tools, and AI systems without re-explanation. It works with any MCP client, CLI, workflow automation (n8n, Make, etc.), or AI assistant. It supports any language, framework, or project setup. Optimized for Claude Desktop while maintaining compatibility with any AI model or platform.
|
|
370
|
-
|
|
371
|
-
Format-driven means the architecture is built on data structure first, not tooling first. Your project context becomes machine-readable, persistent, and interoperable. This is foundational infrastructure for AI-context operations.
|
|
372
|
-
|
|
373
|
-
**Key Features**
|
|
374
|
-
|
|
375
|
-
- **IANA-Registered Format** - Official Internet media type `application/vnd.faf+yaml`
|
|
376
|
-
- Proper HTTP Content-Type headers
|
|
377
|
-
- Browser recognition and handling
|
|
378
|
-
- Email client support
|
|
379
|
-
- API standardization across platforms
|
|
380
|
-
|
|
381
|
-
- **50+ MCP Tools** - Complete project context management
|
|
382
|
-
- Project DNA generation and scoring
|
|
383
|
-
- Bi-directional CLAUDE.md sync
|
|
384
|
-
- Format validation and conversion
|
|
385
|
-
|
|
386
|
-
- **Podium Quality Scoring** - 0-100% AI-readiness assessment
|
|
387
|
-
- 🏆 Trophy (85%+), 🥇 Gold (70%+), 🥈 Silver (55%+), 🥉 Bronze (40%+)
|
|
388
|
-
|
|
389
|
-
- **Official Anthropic Registry** - PR #2759 merged
|
|
390
|
-
- Listed in official MCP server catalog
|
|
391
|
-
- 4,700 total downloads (598/week)
|
|
392
|
-
- Production-tested and validated
|
|
393
|
-
|
|
394
|
-
Zero configuration required - works out of the box after installation. Operations average under 11 milliseconds. Synchronizes .faf files with CLAUDE.md automatically. Built with 100% TypeScript strict mode. All 57 tests passing with production readiness confirmed.
|
|
395
|
-
|
|
396
|
-
---
|
|
397
|
-
|
|
398
|
-
## Scoring System
|
|
399
|
-
|
|
400
|
-
Track your project's AI-readiness with a tiered scoring system:
|
|
401
|
-
|
|
402
|
-
Trophy (100%) - Podium. Perfect AI and human balance. Gold (99%) - Gold standard. Silver (95-98%) - Excellence. Bronze (85-94%) - Production ready. Green (70-84%) - Good foundation. Yellow (55-69%) - Getting there. Red (0-54%) - Needs attention.
|
|
403
|
-
|
|
404
|
-
Live output in Claude Desktop shows your score with a progress bar, current tier, and next milestone guidance.
|
|
405
|
-
|
|
406
|
-
---
|
|
407
|
-
|
|
408
|
-
## Quick Start
|
|
409
|
-
|
|
410
|
-
Install globally via npm:
|
|
411
|
-
```bash
|
|
412
|
-
npm install -g claude-faf-mcp
|
|
413
|
-
```
|
|
74
|
+
**The .FAF Position in the MCP Ecosystem:**
|
|
414
75
|
|
|
415
|
-
Or via Homebrew:
|
|
416
|
-
```bash
|
|
417
|
-
brew install wolfe-jam/faf/claude-faf-mcp
|
|
418
76
|
```
|
|
419
|
-
|
|
420
|
-
|
|
421
|
-
|
|
422
|
-
|
|
423
|
-
|
|
424
|
-
|
|
425
|
-
"claude-faf-mcp": {
|
|
426
|
-
"command": "claude-faf-mcp"
|
|
427
|
-
}
|
|
428
|
-
}
|
|
429
|
-
}
|
|
77
|
+
Model Context Protocol
|
|
78
|
+
───── ─────── ────────
|
|
79
|
+
Claude → .faf → MCP
|
|
80
|
+
Gemini → .faf → MCP
|
|
81
|
+
Codex → .faf → MCP
|
|
82
|
+
Any LLM → IANA Format → Open Protocol
|
|
430
83
|
```
|
|
431
84
|
|
|
432
|
-
|
|
433
|
-
|
|
434
|
-
---
|
|
435
|
-
|
|
436
|
-
## Scoring System Experience
|
|
437
|
-
|
|
438
|
-
This is what persistent project context looks like in action. When you run `faf_auto`, Claude scores your project's AI-readiness with a visual breakdown showing exactly where you stand and what to improve next.
|
|
439
|
-
|
|
440
|
-

|
|
441
|
-
|
|
442
|
-
Live in Claude Desktop. Persistent across sessions. Your foundational context layer, measured and actionable.
|
|
85
|
+
**.FAF is the foundational, universal base layer** for any Model using the MCP Protocol. It provides the standardized Context that makes the Model Context Protocol work for everyone.
|
|
443
86
|
|
|
444
87
|
---
|
|
445
88
|
|
|
446
|
-
##
|
|
447
|
-
|
|
448
|
-
**Core Tools**
|
|
449
|
-
|
|
450
|
-
faf_init - Initialize project context. faf_innit 🇬🇧 - It's a Brit thing! (works same as init). faf_auto - Auto-detect and populate context. faf_score - Calculate AI readiness. faf_status - Project health check.
|
|
451
|
-
|
|
452
|
-
**Enhancement Tools**
|
|
453
|
-
|
|
454
|
-
faf_enhance - Optimize scoring. faf_sync - Sync files. faf_bi_sync - Bidirectional synchronization.
|
|
455
|
-
|
|
456
|
-
**File Operations**
|
|
457
|
-
|
|
458
|
-
faf_read - Read files. faf_write - Write files. faf_list - List directories. faf_search - Search file content.
|
|
459
|
-
|
|
460
|
-
**Skills Integration**
|
|
461
|
-
|
|
462
|
-
faf_skills - List Claude Code skills from .faf file.
|
|
463
|
-
|
|
464
|
-
Full tool documentation available at https://faf.one/docs/tools.
|
|
465
|
-
|
|
466
|
-
---
|
|
467
|
-
|
|
468
|
-
## Usage Example
|
|
469
|
-
|
|
470
|
-
**DROP or PASTE, Click & Go!**
|
|
471
|
-
|
|
472
|
-
1. DROP or PASTE any project file into Claude Desktop
|
|
473
|
-
2. Type: "Run faf_auto to analyze this project"
|
|
474
|
-
3. Get instant context - Claude understands your codebase
|
|
475
|
-
4. Access 50+ commands naturally in conversation
|
|
476
|
-
|
|
477
|
-
The .faf file persists across conversations - no need to re-explain your project each time.
|
|
89
|
+
## 🛠️ Core Features
|
|
478
90
|
|
|
479
|
-
|
|
480
|
-
|
|
481
|
-
|
|
482
|
-
|
|
483
|
-
|
|
484
|
-
|
|
485
|
-
|
|
486
|
-
|
|
487
|
-
|
|
488
|
-
|
|
489
|
-
|
|
490
|
-
|
|
491
|
-
|
|
492
|
-
|
|
493
|
-
|
|
494
|
-
|
|
495
|
-
|
|
496
|
-
|
|
497
|
-
|
|
498
|
-
|
|
499
|
-
```
|
|
500
|
-
|
|
501
|
-
Run tests:
|
|
502
|
-
```bash
|
|
503
|
-
npm test
|
|
504
|
-
```
|
|
505
|
-
|
|
506
|
-
Link locally:
|
|
507
|
-
```bash
|
|
508
|
-
npm link
|
|
509
|
-
```
|
|
91
|
+
### 50 MCP Tools (100% Standalone)
|
|
92
|
+
- **faf_quick** - Lightning-fast project.faf creation (3ms avg)
|
|
93
|
+
- **faf_enhance** - Intelligent enhancement with auto-detection
|
|
94
|
+
- **faf_read** - Parse and validate FAF files
|
|
95
|
+
- **faf_write** - Create/update FAF with validation
|
|
96
|
+
- **faf_score** - AI-readiness scoring engine
|
|
97
|
+
- **faf_compress** - Intelligent size optimization
|
|
98
|
+
- **14 bundled commands** - Zero CLI dependencies, 16.2x faster
|
|
99
|
+
|
|
100
|
+
### IANA-Registered Standard
|
|
101
|
+
- Official MIME type: `application/vnd.faf+yaml`
|
|
102
|
+
- W3C-compliant structured format
|
|
103
|
+
- Universal AI context protocol
|
|
104
|
+
- Cross-platform compatibility
|
|
105
|
+
|
|
106
|
+
### Championship Performance
|
|
107
|
+
- **16.2x faster** than CLI versions (direct function calls vs process spawning)
|
|
108
|
+
- **19ms average** execution across all bundled commands
|
|
109
|
+
- **Fastest: 1ms** (formats command)
|
|
110
|
+
- **Zero memory leaks** with F1-grade engineering
|
|
510
111
|
|
|
511
112
|
---
|
|
512
113
|
|
|
513
|
-
##
|
|
114
|
+
## 📚 Documentation
|
|
514
115
|
|
|
515
|
-
|
|
116
|
+
- **[CHANGELOG](./CHANGELOG.md)** - Version history and release notes
|
|
117
|
+
- **[Full Documentation](https://wolfe-jam.github.io/claude-faf-mcp/)** - Complete guide
|
|
118
|
+
- **[FAQ](https://github.com/Wolfe-Jam/claude-faf-mcp/blob/main/docs/FAQ.md)** - Common questions
|
|
119
|
+
- **[Getting Started](https://github.com/Wolfe-Jam/claude-faf-mcp/blob/main/docs/getting-started.md)** - Installation & setup
|
|
120
|
+
- **[MCP Tools Reference](https://github.com/Wolfe-Jam/claude-faf-mcp/blob/main/docs/mcp-tools.md)** - All 50 tools
|
|
121
|
+
- **[Website](https://faf.one)** - faf.one
|
|
122
|
+
- **[Discord Community](https://discord.com/invite/3pjzpKsP)** - Join the discussion
|
|
516
123
|
|
|
517
124
|
---
|
|
518
125
|
|
|
519
|
-
##
|
|
126
|
+
## 🏆 Why FAF?
|
|
520
127
|
|
|
521
|
-
|
|
128
|
+
> "README for the AI era" — Gemini CLI
|
|
522
129
|
|
|
523
|
-
|
|
524
|
-
# Install from npm package
|
|
525
|
-
mkdir -p ~/.claude/skills/faf-expert
|
|
526
|
-
cp node_modules/claude-faf-mcp/skill/SKILL.md ~/.claude/skills/faf-expert/
|
|
527
|
-
|
|
528
|
-
# Or download directly
|
|
529
|
-
curl -o ~/.claude/skills/faf-expert/SKILL.md \
|
|
530
|
-
https://cdn.jsdelivr.net/npm/claude-faf-mcp@latest/skill/SKILL.md
|
|
531
|
-
```
|
|
130
|
+
**Persistent Context** - Your project's DNA lives in `project.faf`, readable by any AI or human
|
|
532
131
|
|
|
533
|
-
|
|
534
|
-
- Expert guidance on .faf files and project DNA
|
|
535
|
-
- v2.8.0 Tool Visibility System documentation
|
|
536
|
-
- MCP server configuration help
|
|
537
|
-
- AI-readiness scoring assistance
|
|
132
|
+
**Universal Format** - IANA-registered standard works across Claude, Gemini, Codex, any LLM
|
|
538
133
|
|
|
539
|
-
|
|
540
|
-
|
|
541
|
-
## The FAF Ecosystem
|
|
134
|
+
**Zero Setup Tax** - One file (`project.faf`) eliminates AI context setup across your entire team
|
|
542
135
|
|
|
543
|
-
|
|
136
|
+
**Championship Engineering** - F1-inspired performance with strict TypeScript, zero runtime errors
|
|
544
137
|
|
|
545
138
|
---
|
|
546
139
|
|
|
547
|
-
##
|
|
140
|
+
## 📦 Ecosystem
|
|
548
141
|
|
|
549
|
-
|
|
142
|
+
- **[FAF Format Spec](https://github.com/Wolfe-Jam/faf)** - Official IANA specification
|
|
143
|
+
- **[FAF CLI](https://github.com/Wolfe-Jam/faf-cli)** - Command-line tooling
|
|
144
|
+
- **[Chrome Extension](https://chromewebstore.google.com/detail/lnecebepmpjpilldfmndnaofbfjkjlkm)** - Browser integration
|
|
145
|
+
- **[faf.one](https://faf.one)** - Official website and documentation
|
|
550
146
|
|
|
551
147
|
---
|
|
552
148
|
|
|
553
|
-
## License
|
|
554
|
-
|
|
555
|
-
MIT License. See LICENSE file for details.
|
|
149
|
+
## 📄 License
|
|
556
150
|
|
|
557
|
-
|
|
151
|
+
MIT License - Free and open source
|
|
558
152
|
|
|
559
153
|
---
|
|
560
154
|
|
|
561
|
-
|
|
155
|
+
**Built with F1-inspired engineering principles** 🏎️⚡
|
|
562
156
|
|
|
563
|
-
|
|
157
|
+
*"It's so logical if it didn't exist, AI would have built it itself" — Claude*
|