claude-faf-mcp 2.6.5 โ 2.6.7
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 +28 -0
- package/CLAUDE.md +20 -279
- package/README.md +84 -192
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -5,6 +5,34 @@ 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
|
+
## [2.6.7] - 2025-10-25
|
|
9
|
+
|
|
10
|
+
### Fixed
|
|
11
|
+
- Corrected Homebrew installation command from `Wolfe-Jam/tap` to `wolfe-jam/faf`
|
|
12
|
+
- Fixed tap name in both installation sections of README
|
|
13
|
+
|
|
14
|
+
### Added
|
|
15
|
+
- Created Homebrew formula for claude-faf-mcp in wolfe-jam/faf tap
|
|
16
|
+
- Homebrew installation now fully functional and verified
|
|
17
|
+
|
|
18
|
+
## [2.6.6] - 2025-10-25
|
|
19
|
+
|
|
20
|
+
### Changed
|
|
21
|
+
- Redesigned README for professional clarity and credibility
|
|
22
|
+
- Removed decorative emoji and formatting from meta-content
|
|
23
|
+
- Emphasized "persistent project context" in official registry listing
|
|
24
|
+
- Clarified format-driven architecture (format-first, not tools-first)
|
|
25
|
+
|
|
26
|
+
### Added
|
|
27
|
+
- "Scoring System Experience" section with product screenshot
|
|
28
|
+
- Homebrew installation option (brew install Wolfe-Jam/tap/claude-faf-mcp)
|
|
29
|
+
- Strengthened positioning: "first and only persistent project context server"
|
|
30
|
+
|
|
31
|
+
### Documentation
|
|
32
|
+
- Format-driven architecture now leads value proposition
|
|
33
|
+
- Distinguished .faf from tools.md and CLAUDE.md
|
|
34
|
+
- Professional, noise-free README structure
|
|
35
|
+
|
|
8
36
|
## [2.6.3] - 2025-10-20
|
|
9
37
|
|
|
10
38
|
### Fixed
|
package/CLAUDE.md
CHANGED
|
@@ -1,289 +1,30 @@
|
|
|
1
|
-
#
|
|
2
|
-
**Project DNA โจ for AI-Context, On-Demand**
|
|
1
|
+
# ๐๏ธ CLAUDE.md - claude-faf-mcp Persistent Context & Intelligence
|
|
3
2
|
|
|
4
|
-
##
|
|
5
|
-
**
|
|
6
|
-
**
|
|
7
|
-
**Stack:** TypeScript 100%, Node.js 18+
|
|
8
|
-
**License:** MIT (FREE FOREVER)
|
|
9
|
-
**Status:** Published on npm, 800+ weekly downloads
|
|
3
|
+
## PROJECT STATE: GOOD ๐
|
|
4
|
+
**Current Position:** Provide FAF context tools directly in Claude Desktop via MCP
|
|
5
|
+
**Tyre Compound:** ULTRASOFT C5 (Maximum Performance)
|
|
10
6
|
|
|
11
|
-
|
|
12
|
-
Model Context Protocol (MCP) server that brings .faf Project DNA โจ directly into Claude Desktop for AI-Context, On-Demand. 33+ tools for creating, scoring, syncing, and managing AI context without leaving your conversation.
|
|
13
|
-
|
|
14
|
-
## MCP Architecture
|
|
15
|
-
**Protocol:** Model Context Protocol (Anthropic)
|
|
16
|
-
**Transport:** stdio (standard input/output)
|
|
17
|
-
**SDK:** @modelcontextprotocol/sdk ^1.0.0
|
|
18
|
-
**Tools:** 33 registered MCP tools
|
|
19
|
-
|
|
20
|
-
## Installation
|
|
21
|
-
Add to Claude Desktop config (`~/Library/Application Support/Claude/claude_desktop_config.json`):
|
|
22
|
-
|
|
23
|
-
```json
|
|
24
|
-
{
|
|
25
|
-
"mcpServers": {
|
|
26
|
-
"faf": {
|
|
27
|
-
"command": "npx",
|
|
28
|
-
"args": ["-y", "claude-faf-mcp"]
|
|
29
|
-
}
|
|
30
|
-
}
|
|
31
|
-
}
|
|
32
|
-
```
|
|
33
|
-
|
|
34
|
-
## 33 MCP Tools
|
|
35
|
-
|
|
36
|
-
### ๐๏ธ Power Tools
|
|
37
|
-
- `faf_init` - Create .faf from project
|
|
38
|
-
- `faf_auto` - Zero to Championship (auto-detect)
|
|
39
|
-
- `faf_score` - Rate AI readiness (0-100%)
|
|
40
|
-
- `faf_enhance` - AI-powered improvements
|
|
41
|
-
|
|
42
|
-
### ๐ฝ TURBO-CAT Tools
|
|
43
|
-
- `faf_formats` - 153 format discovery
|
|
44
|
-
- `faf_stacks` - Technology signatures
|
|
45
|
-
- `faf_vibe` - Platform detection
|
|
46
|
-
|
|
47
|
-
### ๐งฌ DNA & Evolution
|
|
48
|
-
- `faf_dna` - Show evolution journey
|
|
49
|
-
- `faf_log` - Complete history
|
|
50
|
-
- `faf_update` - Save checkpoint
|
|
51
|
-
- `faf_recover` - Disaster recovery
|
|
52
|
-
- `faf_auth` - Birth certificate
|
|
53
|
-
|
|
54
|
-
### ๐ Scoring & Trust
|
|
55
|
-
- `faf_score` - Context quality rating
|
|
56
|
-
- `faf_trust` - Unified dashboard
|
|
57
|
-
- `faf_credit` - Technical credit
|
|
58
|
-
- `faf_check` - Validation
|
|
59
|
-
- `faf_validate` - Structure check
|
|
60
|
-
- `faf_audit` - Freshness check
|
|
61
|
-
|
|
62
|
-
### ๐ Sync & Mirror
|
|
63
|
-
- `faf_bi_sync` - .faf โ CLAUDE.md (8ms!)
|
|
64
|
-
- `faf_sync` - Dependency updates
|
|
65
|
-
- `faf_tsa` - Inspect deps
|
|
66
|
-
|
|
67
|
-
### ๐ Content Management
|
|
68
|
-
- `faf_show` - Display content
|
|
69
|
-
- `faf_edit` - Interactive editor
|
|
70
|
-
- `faf_convert` - Format conversion
|
|
71
|
-
- `faf_share` - Secure sharing
|
|
72
|
-
|
|
73
|
-
### ๐ Discovery & Analysis
|
|
74
|
-
- `faf_search` - Content search
|
|
75
|
-
- `faf_doctor` - Diagnose issues
|
|
76
|
-
- `faf_verify` - AI compatibility
|
|
77
|
-
|
|
78
|
-
### ๐ Family & Integrations
|
|
79
|
-
- `faf_fam` - View integrations (6 total)
|
|
80
|
-
- `faf_fam_show` - Integration details
|
|
81
|
-
|
|
82
|
-
### ๐ Information
|
|
83
|
-
- `faf_status` - Quick health check
|
|
84
|
-
- `faf_version` - Version info
|
|
85
|
-
- `faf_welcome` - Onboarding guide
|
|
86
|
-
|
|
87
|
-
## Key Features
|
|
88
|
-
- **Zero Setup** - npx auto-installs, no config needed
|
|
89
|
-
- **Real-time Context** - Tools execute in your project directory
|
|
90
|
-
- **Championship Scoring** - ๐ ๐ฅ ๐ฅ ๐ฅ ๐ข ๐ก ๐ด ๐ค
|
|
91
|
-
- **Network Effects** - Works with 6 integrations (React, Next, Svelte, TS, Vite, n8n)
|
|
92
|
-
- **Bi-directional Sync** - 8ms .faf โ CLAUDE.md mirroring
|
|
93
|
-
|
|
94
|
-
## Architecture
|
|
95
|
-
```
|
|
96
|
-
claude-faf-mcp/
|
|
97
|
-
โโโ src/
|
|
98
|
-
โ โโโ index.ts # MCP server entry
|
|
99
|
-
โ โโโ cli.ts # CLI wrapper
|
|
100
|
-
โ โโโ server.ts # MCP implementation
|
|
101
|
-
โ โโโ tools/ # 33 MCP tool definitions
|
|
102
|
-
โ โโโ handlers/ # Tool execution handlers
|
|
103
|
-
โโโ dist/ # Compiled output
|
|
104
|
-
โโโ assets/ # Icons, branding
|
|
105
|
-
โโโ tests/ # Jest test suites
|
|
106
|
-
```
|
|
107
|
-
|
|
108
|
-
## Tool Definition Pattern
|
|
109
|
-
Each MCP tool follows this structure:
|
|
110
|
-
|
|
111
|
-
```typescript
|
|
112
|
-
{
|
|
113
|
-
name: "faf_[command]",
|
|
114
|
-
description: "User-facing description for Claude",
|
|
115
|
-
inputSchema: {
|
|
116
|
-
type: "object",
|
|
117
|
-
properties: {
|
|
118
|
-
path: { type: "string", description: "Project path" },
|
|
119
|
-
// ... other params
|
|
120
|
-
}
|
|
121
|
-
}
|
|
122
|
-
}
|
|
123
|
-
```
|
|
124
|
-
|
|
125
|
-
## Handler Pattern
|
|
126
|
-
Handlers execute faf-cli commands via child_process:
|
|
127
|
-
|
|
128
|
-
```typescript
|
|
129
|
-
async function handleFafCommand(
|
|
130
|
-
command: string,
|
|
131
|
-
args: string[] = [],
|
|
132
|
-
cwd?: string
|
|
133
|
-
): Promise<MCPResult> {
|
|
134
|
-
const { stdout, stderr } = await execCommand(
|
|
135
|
-
`faf ${command} ${args.join(' ')}`,
|
|
136
|
-
{ cwd }
|
|
137
|
-
);
|
|
138
|
-
return { content: [{ type: "text", text: stdout }] };
|
|
139
|
-
}
|
|
140
|
-
```
|
|
141
|
-
|
|
142
|
-
## Development
|
|
143
|
-
```bash
|
|
144
|
-
# Clone
|
|
145
|
-
git clone https://github.com/Wolfe-Jam/claude-faf-mcp.git
|
|
146
|
-
cd claude-faf-mcp
|
|
147
|
-
|
|
148
|
-
# Install
|
|
149
|
-
npm install
|
|
150
|
-
|
|
151
|
-
# Build
|
|
152
|
-
npm run build # TypeScript โ dist/
|
|
153
|
-
|
|
154
|
-
# Test
|
|
155
|
-
npm test # Jest test suite
|
|
156
|
-
npm run test:mcp # MCP inspector
|
|
157
|
-
|
|
158
|
-
# Dev modes
|
|
159
|
-
npm run dev:stdio # stdio transport (default)
|
|
160
|
-
npm run dev:http # HTTP-SSE transport
|
|
161
|
-
npm run debug # Node debugger
|
|
162
|
-
```
|
|
163
|
-
|
|
164
|
-
## Testing with MCP Inspector
|
|
165
|
-
```bash
|
|
166
|
-
# Start inspector
|
|
167
|
-
npm run test:mcp
|
|
168
|
-
|
|
169
|
-
# Or manually
|
|
170
|
-
mcp-inspector stdio ts-node src/cli.ts
|
|
171
|
-
```
|
|
172
|
-
|
|
173
|
-
## Publishing
|
|
174
|
-
```bash
|
|
175
|
-
# Pre-publish
|
|
176
|
-
npm run build # Compile TypeScript
|
|
177
|
-
npm test # Run test suite
|
|
178
|
-
|
|
179
|
-
# Publish
|
|
180
|
-
npm publish # Runs prepublishOnly automatically
|
|
181
|
-
```
|
|
182
|
-
|
|
183
|
-
## Dependencies
|
|
184
|
-
**Production:** 1 only
|
|
185
|
-
- `@modelcontextprotocol/sdk` ^1.0.0
|
|
186
|
-
|
|
187
|
-
**Dev:** TypeScript 5.3.0, Jest 29.7.0, ts-node, eslint
|
|
188
|
-
|
|
189
|
-
## Network Effects Strategy
|
|
190
|
-
**Keywords (82 total):**
|
|
191
|
-
- Core: `claude`, `mcp`, `model-context-protocol`, `claude-desktop`
|
|
192
|
-
- Integrations: `chatgpt`, `gemini`, `cursor`, `codex`, `windsurf`, `warp`
|
|
193
|
-
- Context: `ai-context`, `context-management`, `context-mirroring`
|
|
194
|
-
- Features: `championship-scoring`, `bi-sync`, `zero-config`
|
|
195
|
-
|
|
196
|
-
## Integration with faf-cli
|
|
197
|
-
This MCP server wraps faf-cli commands:
|
|
198
|
-
- **CLI required:** faf-cli must be installed globally or locally
|
|
199
|
-
- **Execution:** Tools spawn `faf [command]` as child processes
|
|
200
|
-
- **Output:** Captures stdout/stderr and returns to Claude
|
|
201
|
-
- **Context:** Executes in user's project directory
|
|
202
|
-
|
|
203
|
-
## Performance
|
|
204
|
-
- **Tool Registration:** <100ms on startup
|
|
205
|
-
- **Tool Execution:** Inherits faf-cli performance (<50ms)
|
|
206
|
-
- **Bi-sync:** 8ms typical (via faf-cli)
|
|
207
|
-
- **Zero overhead:** Direct CLI passthrough
|
|
208
|
-
|
|
209
|
-
## Real Stats (Verified)
|
|
210
|
-
- โ
800+ weekly downloads
|
|
211
|
-
- โ
33 MCP tools
|
|
212
|
-
- โ
100% TypeScript strict mode
|
|
213
|
-
- โ
Works with Claude Desktop
|
|
214
|
-
- โ
Zero-config installation
|
|
215
|
-
|
|
216
|
-
## Claude Desktop Integration
|
|
217
|
-
**Location:** `~/Library/Application Support/Claude/claude_desktop_config.json`
|
|
218
|
-
|
|
219
|
-
**Restart Required:** After config changes, restart Claude Desktop
|
|
220
|
-
|
|
221
|
-
**Debug Logs:**
|
|
222
|
-
- macOS: `~/Library/Logs/Claude/mcp*.log`
|
|
223
|
-
- Check for connection errors
|
|
224
|
-
|
|
225
|
-
## Tool Usage in Claude
|
|
226
|
-
Once installed, Claude can use tools naturally:
|
|
227
|
-
|
|
228
|
-
```
|
|
229
|
-
User: "Initialize a .faf file in my project"
|
|
230
|
-
Claude: [Uses faf_init tool]
|
|
231
|
-
|
|
232
|
-
User: "What's my AI readiness score?"
|
|
233
|
-
Claude: [Uses faf_score tool]
|
|
234
|
-
|
|
235
|
-
User: "Show me my project's evolution"
|
|
236
|
-
Claude: [Uses faf_dna tool]
|
|
237
|
-
```
|
|
238
|
-
|
|
239
|
-
## NO BS ZONE ๐
|
|
240
|
-
**Trust is everything.**
|
|
241
|
-
- NO fake statistics
|
|
242
|
-
- NO inflated numbers
|
|
243
|
-
- NO guarantees (it's free software)
|
|
244
|
-
- ONLY verified claims
|
|
245
|
-
- ONLY real achievements
|
|
246
|
-
|
|
247
|
-
## Ecosystem
|
|
248
|
-
- **CLI** - npmjs.com/package/faf-cli (main tool)
|
|
249
|
-
- **MCP Server** (this) - npmjs.com/package/claude-faf-mcp
|
|
250
|
-
- **Chrome Extension** - chromewebstore.google.com (LIVE)
|
|
251
|
-
- **Website** - faf.one
|
|
252
|
-
- **Homebrew** - brew install faf-cli
|
|
253
|
-
|
|
254
|
-
## Important Context
|
|
255
|
-
- **MCP** = Model Context Protocol (Anthropic standard)
|
|
256
|
-
- **stdio** = Standard input/output (default transport)
|
|
257
|
-
- **Tool** = MCP function Claude can call
|
|
258
|
-
- **Handler** = Server-side function that executes the tool
|
|
259
|
-
- **Orange Smiley MCP** = Our brand/nickname ๐งกโก๏ธ
|
|
260
|
-
|
|
261
|
-
## Git Protocol
|
|
262
|
-
**Professional. Boring. Trusted.**
|
|
7
|
+
---
|
|
263
8
|
|
|
264
|
-
|
|
265
|
-
fix: <what changed>
|
|
266
|
-
feat: <what changed>
|
|
267
|
-
docs: <what changed>
|
|
9
|
+
## ๐จ CORE CONTEXT
|
|
268
10
|
|
|
269
|
-
|
|
270
|
-
-
|
|
271
|
-
|
|
11
|
+
### Project Identity
|
|
12
|
+
- **Name:** claude-faf-mcp
|
|
13
|
+
- **Stack:** Node.js/TypeScript
|
|
14
|
+
- **Quality:** F1-INSPIRED (Championship Performance)
|
|
272
15
|
|
|
273
|
-
|
|
274
|
-
- **
|
|
275
|
-
- **
|
|
276
|
-
- **Independent:** MCP can work with any faf-cli version
|
|
16
|
+
### Technical Architecture
|
|
17
|
+
- **What Building:** Universal FAF MCP Server for Claude Desktop - AI Context Intelligence
|
|
18
|
+
- **Main Language:** TypeScript
|
|
277
19
|
|
|
278
|
-
|
|
279
|
-
-
|
|
280
|
-
-
|
|
281
|
-
- Add more MCP-specific tools
|
|
282
|
-
- Improve error handling in stdio
|
|
20
|
+
### ๐ Context Quality Status
|
|
21
|
+
- **Overall Assessment:** Good
|
|
22
|
+
- **Last Updated:** 2025-10-23
|
|
283
23
|
|
|
284
24
|
---
|
|
285
25
|
|
|
286
|
-
**
|
|
26
|
+
**STATUS: BI-SYNC ACTIVE ๐ - Synchronized with .faf context!**
|
|
287
27
|
|
|
288
|
-
*
|
|
289
|
-
*
|
|
28
|
+
*Last Sync: 2025-10-23T17:02:56.806Z*
|
|
29
|
+
*Sync Engine: F1-Inspired Software Engineering*
|
|
30
|
+
*๐๏ธโก๏ธ_championship_sync*
|
package/README.md
CHANGED
|
@@ -2,17 +2,24 @@
|
|
|
2
2
|
|
|
3
3
|
## TL;DR
|
|
4
4
|
|
|
5
|
-
**Problem:** AI needs persistent project context
|
|
5
|
+
**Problem:** AI needs persistent project contextโnot just docs or tools, but foundational infrastructure.
|
|
6
6
|
|
|
7
|
-
**Solution:** The .faf format
|
|
7
|
+
**Solution:** The .faf format is a structured, machine-readable context layer. This MCP server gives Claude 33+ tools to create, score, and improve your project's persistent context through format-driven architecture.
|
|
8
8
|
|
|
9
|
-
**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.
|
|
9
|
+
**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.
|
|
10
10
|
|
|
11
11
|
**Install:**
|
|
12
|
+
|
|
13
|
+
Via npm:
|
|
12
14
|
```bash
|
|
13
15
|
npm install -g claude-faf-mcp
|
|
14
16
|
```
|
|
15
17
|
|
|
18
|
+
Via Homebrew:
|
|
19
|
+
```bash
|
|
20
|
+
brew install wolfe-jam/faf/claude-faf-mcp
|
|
21
|
+
```
|
|
22
|
+
|
|
16
23
|
**Configure:** Add to `claude_desktop_config.json`:
|
|
17
24
|
```json
|
|
18
25
|
{
|
|
@@ -25,85 +32,66 @@ npm install -g claude-faf-mcp
|
|
|
25
32
|
```
|
|
26
33
|
|
|
27
34
|
**CLI vs MCP clarity**
|
|
28
|
-
- **faf-cli** ([npm](https://www.npmjs.com/package/faf-cli)): Runs on your machine locally in a terminal
|
|
29
|
-
- **claude-faf-mcp** (this): Runs through Claude Desktop as a tool
|
|
30
35
|
|
|
31
|
-
Same .faf, different
|
|
36
|
+
faf-cli (npm) runs on your machine locally in a terminal. claude-faf-mcp (this) runs through Claude Desktop as a tool. Same .faf format, different execution layer. Same persistent context and scoring. Same capabilities (create, score, improve).
|
|
32
37
|
|
|
33
38
|
Use CLI for raw speed and local development; use MCP for AI-integrated workflows. No feature gaps between them - pick based on your flow.
|
|
34
39
|
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
[Website](https://faf.one) | [GitHub](https://github.com/Wolfe-Jam/claude-faf-mcp) | [Discussions](https://github.com/Wolfe-Jam/claude-faf-mcp/discussions)
|
|
40
|
+
Website: https://faf.one | GitHub: https://github.com/Wolfe-Jam/claude-faf-mcp | Discussions: https://github.com/Wolfe-Jam/claude-faf-mcp/discussions
|
|
38
41
|
|
|
39
42
|
---
|
|
40
43
|
|
|
41
|
-
##
|
|
42
|
-
|
|
43
|
-
**For developers who want the full story**, here's everything about FAF's architecture, testing, and championship engineering standards.
|
|
44
|
-
|
|
45
|
-
<div align="center">
|
|
44
|
+
## Official Status
|
|
46
45
|
|
|
47
|
-
|
|
46
|
+
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.
|
|
48
47
|
|
|
49
|
-
|
|
48
|
+
Registry listing: "MCP server for .faf format. The only persistent project context scoring engine in the Anthropic registry."
|
|
50
49
|
|
|
51
|
-
|
|
50
|
+
Published to official Anthropic MCP registry with validation by Anthropic engineering team. Current metrics: 4,100+ total downloads with 462 downloads per week (4.5x growth from 108/week baseline).
|
|
52
51
|
|
|
53
|
-
|
|
52
|
+
---
|
|
54
53
|
|
|
55
|
-
|
|
56
|
-
[](https://www.npmjs.com/package/claude-faf-mcp)
|
|
57
|
-
[](https://opensource.org/licenses/MIT)
|
|
54
|
+
## What is claude-faf-mcp?
|
|
58
55
|
|
|
59
|
-
|
|
60
|
-
[](https://www.typescriptlang.org/)
|
|
61
|
-
[](./docs/evaluations/)
|
|
56
|
+
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.
|
|
62
57
|
|
|
63
|
-
**
|
|
58
|
+
**Format-Driven Architecture**
|
|
64
59
|
|
|
65
|
-
|
|
60
|
+
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.
|
|
66
61
|
|
|
67
|
-
|
|
62
|
+
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.
|
|
68
63
|
|
|
69
|
-
|
|
64
|
+
**Key Features**
|
|
70
65
|
|
|
71
|
-
|
|
66
|
+
Zero configuration required - works out of the box after installation. Includes 33+ tools for format operations. Operations average under 11 milliseconds. Synchronizes .faf files with CLAUDE.md automatically (keeping human-readable docs in sync with machine-readable persistent context). Built with 100% TypeScript strict mode. All 35 tests passing with production readiness confirmed.
|
|
72
67
|
|
|
73
|
-
|
|
68
|
+
---
|
|
74
69
|
|
|
75
|
-
|
|
76
|
-
๐ Trophy (100%) - Championship - Perfect AI|HUMAN balance
|
|
77
|
-
๐ฅ Gold (99%) - Gold standard
|
|
78
|
-
๐ฅ Silver (95-98%) - Excellence
|
|
79
|
-
๐ฅ Bronze (85-94%) - Production ready
|
|
80
|
-
๐ข Green (70-84%) - Good foundation
|
|
81
|
-
๐ก Yellow (55-69%) - Getting there
|
|
82
|
-
๐ด Red (0-54%) - Needs attention
|
|
83
|
-
```
|
|
70
|
+
## Scoring System
|
|
84
71
|
|
|
85
|
-
|
|
72
|
+
Track your project's AI-readiness with a tiered scoring system:
|
|
86
73
|
|
|
87
|
-
|
|
88
|
-
๐ฅ Score: 88/100
|
|
89
|
-
โโโโโโโโโโโโโโโโโโโโโโโโ 88%
|
|
90
|
-
Status: Bronze - Production Ready
|
|
74
|
+
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.
|
|
91
75
|
|
|
92
|
-
|
|
93
|
-
```
|
|
76
|
+
Live output in Claude Desktop shows your score with a progress bar, current tier, and next milestone guidance.
|
|
94
77
|
|
|
95
78
|
---
|
|
96
79
|
|
|
97
|
-
##
|
|
80
|
+
## Quick Start
|
|
98
81
|
|
|
82
|
+
Install globally via npm:
|
|
99
83
|
```bash
|
|
100
|
-
# Install globally
|
|
101
84
|
npm install -g claude-faf-mcp
|
|
85
|
+
```
|
|
102
86
|
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
87
|
+
Or via Homebrew:
|
|
88
|
+
```bash
|
|
89
|
+
brew install wolfe-jam/faf/claude-faf-mcp
|
|
90
|
+
```
|
|
106
91
|
|
|
92
|
+
Add to Claude Desktop configuration. On macOS and Linux, edit ~/Library/Application Support/Claude/claude_desktop_config.json. On Windows, edit %APPDATA%\Claude\claude_desktop_config.json.
|
|
93
|
+
|
|
94
|
+
```json
|
|
107
95
|
{
|
|
108
96
|
"mcpServers": {
|
|
109
97
|
"claude-faf-mcp": {
|
|
@@ -113,207 +101,111 @@ npm install -g claude-faf-mcp
|
|
|
113
101
|
}
|
|
114
102
|
```
|
|
115
103
|
|
|
116
|
-
Restart Claude Desktop
|
|
104
|
+
Restart Claude Desktop to load the server.
|
|
117
105
|
|
|
118
106
|
---
|
|
119
107
|
|
|
120
|
-
##
|
|
121
|
-
|
|
122
|
-
**claude-faf-mcp** is officially published in the [Anthropic MCP Registry](https://github.com/modelcontextprotocol/servers).
|
|
108
|
+
## Scoring System Experience
|
|
123
109
|
|
|
124
|
-
|
|
125
|
-
โ๏ธ **[PR #2759](https://github.com/modelcontextprotocol/servers/pull/2759)** - Approved and available in registry
|
|
126
|
-
โ๏ธ **3,600+ total downloads** - Growing adoption across the Claude community
|
|
110
|
+
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.
|
|
127
111
|
|
|
128
|
-
|
|
112
|
+

|
|
129
113
|
|
|
130
|
-
|
|
114
|
+
Live in Claude Desktop. Persistent across sessions. Your foundational context layer, measured and actionable.
|
|
131
115
|
|
|
132
116
|
---
|
|
133
117
|
|
|
134
|
-
##
|
|
118
|
+
## Available Tools
|
|
135
119
|
|
|
136
|
-
**
|
|
120
|
+
**Core Tools**
|
|
137
121
|
|
|
138
|
-
|
|
122
|
+
faf_init - Initialize project context. faf_auto - Auto-detect and populate context. faf_score - Calculate AI readiness. faf_status - Project health check.
|
|
139
123
|
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
**Format-Driven Architecture:**
|
|
143
|
-
- **Persistent** - Context survives across sessions, tools, and AIs
|
|
144
|
-
- **Universal** - Works with any MCP client, CLI, workflow automation (n8n, Make, etc.), or AI assistant
|
|
145
|
-
- **Stack-Agnostic** - Any language, framework, or setup
|
|
146
|
-
- **Built with Claude** - Optimized for Claude Desktop while maintaining compatibility with ANY AI model or platform
|
|
147
|
-
|
|
148
|
-
No limits. No restrictions. No boundaries. The only true format-first architecture for the AI era.
|
|
149
|
-
|
|
150
|
-
### Key Features
|
|
151
|
-
|
|
152
|
-
- โ
**Zero Config** - Works out of the box
|
|
153
|
-
- โ
**33+ Tools** - Complete project management
|
|
154
|
-
- โ
**<11ms Speed** - Championship performance
|
|
155
|
-
- โ
**Bi-Sync** - .faf โ CLAUDE.md synchronization
|
|
156
|
-
- โ
**Type Safe** - 100% TypeScript strict mode
|
|
157
|
-
- โ
**Production Ready** - 35/35 tests passing
|
|
158
|
-
|
|
159
|
-
---
|
|
124
|
+
**Enhancement Tools**
|
|
160
125
|
|
|
161
|
-
|
|
126
|
+
faf_enhance - Optimize scoring. faf_sync - Sync files. faf_bi_sync - Bidirectional synchronization.
|
|
162
127
|
|
|
163
|
-
|
|
164
|
-
- `faf_init` - Initialize project context
|
|
165
|
-
- `faf_auto` - Auto-detect and populate
|
|
166
|
-
- `faf_score` - Calculate AI readiness
|
|
167
|
-
- `faf_status` - Project health check
|
|
128
|
+
**File Operations**
|
|
168
129
|
|
|
169
|
-
|
|
170
|
-
- `faf_enhance` - Optimize scoring
|
|
171
|
-
- `faf_sync` - Sync files
|
|
172
|
-
- `faf_bi_sync` - Bidirectional sync
|
|
130
|
+
faf_read - Read files. faf_write - Write files. faf_list - List directories. faf_search - Search file content.
|
|
173
131
|
|
|
174
|
-
|
|
175
|
-
- `faf_read` - Read files
|
|
176
|
-
- `faf_write` - Write files
|
|
177
|
-
- `faf_list` - List directories
|
|
178
|
-
- `faf_search` - Search content
|
|
132
|
+
**Skills Integration**
|
|
179
133
|
|
|
180
|
-
|
|
181
|
-
- `faf_skills` - ๐ธ List Claude Code skills from .faf file
|
|
134
|
+
faf_skills - List Claude Code skills from .faf file.
|
|
182
135
|
|
|
183
|
-
|
|
136
|
+
Full tool documentation available at https://faf.one/docs/tools.
|
|
184
137
|
|
|
185
138
|
---
|
|
186
139
|
|
|
187
|
-
##
|
|
140
|
+
## Usage Example
|
|
188
141
|
|
|
189
|
-
1.
|
|
190
|
-
2.
|
|
191
|
-
3.
|
|
192
|
-
4.
|
|
142
|
+
1. Drop any project file into Claude Desktop
|
|
143
|
+
2. Type: "Run faf_auto to analyze this project"
|
|
144
|
+
3. Get instant context - Claude understands your codebase
|
|
145
|
+
4. Access 33+ commands naturally in conversation
|
|
193
146
|
|
|
194
|
-
The
|
|
147
|
+
The .faf file persists across conversations - no need to re-explain your project each time.
|
|
195
148
|
|
|
196
149
|
---
|
|
197
150
|
|
|
198
|
-
##
|
|
151
|
+
## Technical Specifications
|
|
199
152
|
|
|
200
|
-
|
|
201
|
-
Performance: <11ms operations
|
|
202
|
-
TypeScript: 100% strict mode
|
|
203
|
-
Dependencies: 1 (MCP SDK only)
|
|
204
|
-
Testing: 730 C.O.R.E empirical tests (part of 12,500+ FAF ecosystem validation)
|
|
205
|
-
Build: Zero errors
|
|
206
|
-
Coverage: 4,400+ lines
|
|
207
|
-
```
|
|
153
|
+
Performance: Sub-11ms average operation time. TypeScript: 100% strict mode. Dependencies: 1 (MCP SDK only). Testing: 730 C.O.R.E empirical tests (part of 12,500+ FAF ecosystem validation). Build: Zero errors. Coverage: 4,400+ lines of code.
|
|
208
154
|
|
|
209
155
|
---
|
|
210
156
|
|
|
211
|
-
##
|
|
212
|
-
|
|
213
|
-
### v2.6.2 - Documentation Improvements
|
|
214
|
-
- **DRY Principle** - Version management simplified
|
|
215
|
-
- **Single Source of Truth** - Version appears once in title
|
|
216
|
-
- **Easier Maintenance** - Streamlined documentation updates
|
|
217
|
-
|
|
218
|
-
### v2.6.1 - Official MCP Registry Publication
|
|
219
|
-
- โ๏ธ **Published to Anthropic MCP Registry** - [PR #2759](https://github.com/modelcontextprotocol/servers/pull/2759) MERGED
|
|
220
|
-
- **server.json** added for official registry listing
|
|
221
|
-
- **mcpName** updated with correct capitalization format
|
|
222
|
-
- **Registry validation** - First .faf format server in official ecosystem
|
|
223
|
-
|
|
224
|
-
### v2.6.0 - Post-Evaluation Release (94.4/100 Gold Standard)
|
|
225
|
-
|
|
226
|
-
๐ **Post-Evaluation Release (94.4/100 Gold Standard)**
|
|
227
|
-
- Type-safe tool handlers with proper TypeScript definitions
|
|
228
|
-
- Community contribution framework (templates, guidelines, funding)
|
|
229
|
-
- Repository cleanup: Removed 17K+ lines of legacy docs
|
|
230
|
-
- Improved TypeScript strict mode compliance across all handlers
|
|
231
|
-
|
|
232
|
-
### v2.5.2 - Visual Championship Experience
|
|
233
|
-
- **Orange Smiley branding** - Complete visual identity on NPM
|
|
234
|
-
- **Score card screenshot** - See the actual terminal output
|
|
235
|
-
- **Championship polish** - Professional presentation
|
|
236
|
-
|
|
237
|
-
### v2.5.1 - Documentation Polish
|
|
238
|
-
- **Championship README** - Trophy section leads for immediate impact
|
|
239
|
-
- **Optimized description** - Cleaner NPM presence
|
|
240
|
-
- **Professional structure** - Scannable, modern layout
|
|
241
|
-
|
|
242
|
-
### v2.5.0 - Championship Edition
|
|
243
|
-
- **7-tier medal system** for AI-readiness scoring
|
|
244
|
-
- **Visual progress bars** in terminal output
|
|
245
|
-
- **Milestone tracking** with next-level guidance
|
|
246
|
-
- **Enhanced scoring** for better project analysis
|
|
247
|
-
|
|
248
|
-
---
|
|
249
|
-
|
|
250
|
-
## ๐๏ธ Development
|
|
157
|
+
## Development
|
|
251
158
|
|
|
159
|
+
Clone the repository:
|
|
252
160
|
```bash
|
|
253
|
-
# Clone
|
|
254
161
|
git clone https://github.com/Wolfe-Jam/claude-faf-mcp.git
|
|
255
162
|
cd claude-faf-mcp
|
|
163
|
+
```
|
|
256
164
|
|
|
257
|
-
|
|
165
|
+
Install dependencies and build:
|
|
166
|
+
```bash
|
|
258
167
|
npm install
|
|
259
168
|
npm run build
|
|
169
|
+
```
|
|
260
170
|
|
|
261
|
-
|
|
171
|
+
Run tests:
|
|
172
|
+
```bash
|
|
262
173
|
npm test
|
|
174
|
+
```
|
|
263
175
|
|
|
264
|
-
|
|
176
|
+
Link locally:
|
|
177
|
+
```bash
|
|
265
178
|
npm link
|
|
266
179
|
```
|
|
267
180
|
|
|
268
181
|
---
|
|
269
182
|
|
|
270
|
-
##
|
|
183
|
+
## Requirements
|
|
271
184
|
|
|
272
|
-
|
|
273
|
-
- **Claude Desktop** (latest version)
|
|
274
|
-
- **OS**: macOS, Linux, or Windows
|
|
185
|
+
Node.js 18 or later. Claude Desktop (latest version). Operating system: macOS, Linux, or Windows.
|
|
275
186
|
|
|
276
187
|
---
|
|
277
188
|
|
|
278
|
-
##
|
|
189
|
+
## The FAF Ecosystem
|
|
279
190
|
|
|
280
|
-
|
|
281
|
-
- [๐งก **claude-faf-mcp**](https://npmjs.com/package/claude-faf-mcp) - This MCP server
|
|
282
|
-
- [๐ **faf.one**](https://faf.one) - Documentation & guides
|
|
283
|
-
- [๐ฅ๏ธ **Chrome Extension**](https://chromewebstore.google.com/detail/lnecebepmpjpilldfmndnaofbfjkjlkm) - Browser integration
|
|
191
|
+
faf-cli (npm) - Command line tool for local context management. claude-faf-mcp - This MCP server for Claude Desktop integration. faf.one - Documentation and guides. Chrome Extension - Browser integration for context collection.
|
|
284
192
|
|
|
285
193
|
---
|
|
286
194
|
|
|
287
|
-
##
|
|
195
|
+
## Author
|
|
288
196
|
|
|
289
|
-
|
|
290
|
-
Creator, .faf Format
|
|
291
|
-
ORCID: [0009-0007-0801-3841](https://orcid.org/0009-0007-0801-3841)
|
|
197
|
+
James Wolfe (Wolfe-Jam), creator of the .faf format. ORCID: 0009-0007-0801-3841.
|
|
292
198
|
|
|
293
199
|
---
|
|
294
200
|
|
|
295
|
-
##
|
|
201
|
+
## License
|
|
296
202
|
|
|
297
|
-
MIT License
|
|
203
|
+
MIT License. See LICENSE file for details.
|
|
298
204
|
|
|
299
|
-
|
|
205
|
+
Note: The .faf-Engine is proprietary and available under separate license.
|
|
300
206
|
|
|
301
207
|
---
|
|
302
208
|
|
|
303
|
-
##
|
|
304
|
-
|
|
305
|
-
We welcome contributions! Join our [community discussions](https://github.com/Wolfe-Jam/claude-faf-mcp/discussions) or submit issues/PRs.
|
|
306
|
-
|
|
307
|
-
---
|
|
308
|
-
|
|
309
|
-
<div align="center">
|
|
310
|
-
|
|
311
|
-
**AI? Context? faf innit โจ**
|
|
312
|
-
|
|
313
|
-
Made with ๐งก by wolfejam.dev
|
|
314
|
-
|
|
315
|
-
**Free forever** โข **Zero dependencies** โข **Zero Faffโข**
|
|
316
|
-
|
|
317
|
-
[โญ Star on GitHub](https://github.com/Wolfe-Jam/claude-faf-mcp) โข [๐ฆ View on NPM](https://www.npmjs.com/package/claude-faf-mcp)
|
|
209
|
+
## Contributing
|
|
318
210
|
|
|
319
|
-
|
|
211
|
+
Contributions are welcome. Join community discussions at https://github.com/Wolfe-Jam/claude-faf-mcp/discussions or submit issues and pull requests on GitHub.
|
package/package.json
CHANGED