claude-faf-mcp 2.6.0 β†’ 2.6.1

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.
Files changed (3) hide show
  1. package/CLAUDE.md +289 -0
  2. package/README.md +3 -3
  3. package/package.json +3 -2
package/CLAUDE.md ADDED
@@ -0,0 +1,289 @@
1
+ # 🧑⚑️claude-faf-mcp v2.6.0 πŸ† Claude Desktop MCP Server
2
+ **Project DNA ✨ for AI-Context, On-Demand**
3
+
4
+ ## Project Overview
5
+ **Package:** claude-faf-mcp
6
+ **Version:** 2.6.0
7
+ **Stack:** TypeScript 100%, Node.js 18+
8
+ **License:** MIT (FREE FOREVER)
9
+ **Status:** Published on npm, 800+ weekly downloads
10
+
11
+ ## What is claude-faf-mcp?
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.**
263
+
264
+ ```
265
+ fix: <what changed>
266
+ feat: <what changed>
267
+ docs: <what changed>
268
+
269
+ - <specific change 1>
270
+ - <specific change 2>
271
+ ```
272
+
273
+ ## Versioning
274
+ - **v2.x** = MCP SDK 1.0 compatibility
275
+ - **Sync with CLI:** MCP versions don't match CLI versions
276
+ - **Independent:** MCP can work with any faf-cli version
277
+
278
+ ## Next Steps
279
+ - Monitor npm download growth
280
+ - Track Claude Desktop adoption
281
+ - Add more MCP-specific tools
282
+ - Improve error handling in stdio
283
+
284
+ ---
285
+
286
+ **Championship-grade MCP server. Built with 🧑 by wolfejam.**
287
+
288
+ *Generated: 2025-10-15*
289
+ *Status: v2.6.0 live on npm*
package/README.md CHANGED
@@ -86,8 +86,8 @@ Restart Claude Desktop β†’ Ready! 🏁
86
86
 
87
87
  MCP server that brings `.faf` format to Claude Desktop for instant project understanding.
88
88
 
89
- **.faf = Project DNA for ANY AI ✨**
90
- Universal, shareable context for Claude, ChatGPT, Gemini, or any AI - regardless of stack, size, or setup.
89
+ **.faf = Project DNA ✨ for AI-Context, On-Demand**
90
+ Universal, shareable context for Claude, Codex, Gemini, or any AI - regardless of stack, size, or setup.
91
91
 
92
92
  ### Key Features
93
93
 
@@ -204,7 +204,7 @@ npm link
204
204
 
205
205
  ## πŸ”— The FAF Ecosystem
206
206
 
207
- - [🩡 **faf-cli**](https://npmjs.com/package/faf-cli) - Command line tool (v2.4.6)
207
+ - [🩡 **faf-cli**](https://npmjs.com/package/faf-cli) - Command line tool (v3.0.2 - Championship Edition πŸ† with Turbo Cat 😽)
208
208
  - [🧑 **claude-faf-mcp**](https://npmjs.com/package/claude-faf-mcp) - This MCP server
209
209
  - [πŸ’š **faf.one**](https://faf.one) - Documentation & guides
210
210
  - [πŸ–₯️ **Chrome Extension**](https://chromewebstore.google.com/detail/lnecebepmpjpilldfmndnaofbfjkjlkm) - Browser integration
package/package.json CHANGED
@@ -1,7 +1,8 @@
1
1
  {
2
2
  "name": "claude-faf-mcp",
3
- "version": "2.6.0",
4
- "description": "🧑⚑️ MCP for .faf | Project DNA ✨ for trusted AI context in Claude Desktop - Transform projects with perfect AI understanding β€’ 33+ tools, Championship scoring β€’ 100% TypeScript strict β€’ Orange Smiley MCP β€’ FREE & Open Source",
3
+ "version": "2.6.1",
4
+ "mcpName": "io.github.Wolfe-Jam/claude-faf-mcp",
5
+ "description": "🧑⚑️ MCP for .faf | Project DNA ✨ for AI-Context, On-Demand - Transform projects with perfect AI understanding β€’ 33+ tools, Championship scoring β€’ Works with Claude Desktop, VS Code, GitHub Copilot β€’ Part of .faf ecosystem (see also: faf-cli) β€’ 100% TypeScript strict β€’ FREE & Open Source",
5
6
  "icon": "./assets/icons/faf-icon-64.png",
6
7
  "logo": "./assets/icons/faf-icon-64.png",
7
8
  "displayName": ".faf 🧑⚑️",