faf-mcp 1.0.5 โ†’ 1.1.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.
Files changed (5) hide show
  1. package/.faf +10 -0
  2. package/CLAUDE.md +14 -0
  3. package/README.md +88 -53
  4. package/package.json +3 -2
  5. package/project.faf +125 -0
package/.faf ADDED
@@ -0,0 +1,10 @@
1
+ project:
2
+ name: faf-mcp
3
+ goal: Universal MCP server for all platforms
4
+ instant_context:
5
+ tech_stack: Node.js/TypeScript
6
+ main_language: TypeScript
7
+ what_building: Universal FAF MCP Server - AI Context Intelligence for All Platforms
8
+ metadata:
9
+ last_claude_sync: 2025-11-13T20:02:49.198Z
10
+ bi_sync: active
package/CLAUDE.md CHANGED
@@ -13,6 +13,20 @@
13
13
  - **Stack:** Node.js/TypeScript
14
14
  - **Quality:** F1-INSPIRED (Championship Performance)
15
15
 
16
+ ## ๐Ÿ’ก Quick Start for AI
17
+
18
+ **Q: How do I get started?**
19
+
20
+ **A: Just USE FAF**
21
+
22
+ ```
23
+ Use FAF to initialize your project
24
+ Use FAF to sync my project.faf to all platforms
25
+ Use FAF to score my AI-readiness
26
+ ```
27
+
28
+ That's it! Start every prompt with "**Use FAF**" and the MCP tools will handle the rest.
29
+
16
30
  ### Our Mission - Universal MCP Integration
17
31
 
18
32
  **v1.0.0 Launch: PLATFORM-AGNOSTIC**
package/README.md CHANGED
@@ -1,21 +1,12 @@
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; color: #FF8C00;">USE>FAFโ„ข</h1>
4
+ <h1 style="margin: 0; color: #FF8C00;">faf-mcp | use>faf</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
- > **Universal MCP server** for .FAF (Foundational AI-context Format) with 50 tools
10
- > Works with Claude Desktop, Cursor, Windsurf, and all MCP-compatible platforms
11
-
12
- ## ๐Ÿ’ก Quick Start
13
-
14
- ```
15
- Use FAF to initialize your project
16
- ```
17
-
18
- That's it! Start every prompt with "**Use FAF**" and the MCP tools will handle the rest.
9
+ > Universal MCP server for .FAF (Foundational AI-context Format) with 50 tools - Persistent project context for Cursor, Windsurf, Cline, VS Code, and all MCP-compatible platforms (including [Claude Desktop](https://github.com/Wolfe-Jam/claude-faf-mcp))
19
10
 
20
11
  [![NPM Downloads](https://img.shields.io/npm/dt/faf-mcp?label=total%20downloads&color=00CCFF)](https://www.npmjs.com/package/faf-mcp)
21
12
  [![Discord](https://img.shields.io/badge/Discord-Join%20Community-5865F2?logo=discord&logoColor=white)](https://discord.com/invite/3pjzpKsP)
@@ -25,17 +16,48 @@ That's it! Start every prompt with "**Use FAF**" and the MCP tools will handle t
25
16
 
26
17
  ---
27
18
 
28
- ## ๐Ÿ AI-Readiness Scorecard
19
+ ## โšก Quick Start
29
20
 
30
- **The closer you get to 100% the better AI can assist you.**
21
+ **1. Install:**
31
22
 
32
- 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.
23
+ ```bash
24
+ npm install -g faf-mcp
25
+ ```
26
+
27
+ **2. Copy and paste this to your AI:**
28
+
29
+ ```
30
+ Install the FAF MCP server: npm install -g faf-mcp, then add this to my MCP config: {"mcpServers": {"faf": {"command": "npx", "args": ["-y", "faf-mcp"]}}} and restart.
31
+ ```
32
+
33
+ ### Platform-Specific Setup
34
+
35
+ **Cursor IDE:** Add to `~/.cursor/mcp.json` ([setup guide](https://docs.cursor.com/context/model-context-protocol))
36
+
37
+ **Windsurf Editor:** Add to `~/.codeium/windsurf/mcp_config.json` ([Cascade docs](https://docs.windsurf.com/windsurf/cascade/mcp))
38
+
39
+ **Cline:** Add to Cline's MCP settings
40
+
41
+ **VS Code:** Install MCP extension, then add server config
42
+
43
+ **Claude Desktop:** Use the [dedicated claude-faf-mcp package](https://github.com/Wolfe-Jam/claude-faf-mcp) for optimized Claude integration
44
+
45
+ ---
46
+
47
+ ## ๐Ÿ AI-Readiness Scorecard
48
+
49
+ > **"README for the AI era"** โ€” Google Gemini
33
50
 
34
51
  <div align="center">
35
- <img src="./assets/Project-faf-pckg-json-README.png" alt="project.faf file positioning" width="600" />
36
- <p><em>project.faf lives at the project root, between package.json and README.md</em></p>
52
+ <img src="https://raw.githubusercontent.com/Wolfe-Jam/faf-mcp/main/packages/faf-mcp/assets/Project-faf-pckg-json-README.png" alt="project.faf file positioning" width="600" />
53
+ <p><em><strong>project.faf is to AI context what package.json is to dependencies</strong></em></p>
54
+ <p><em>Lives at the project root, between package.json and README.md</em></p>
37
55
  </div>
38
56
 
57
+ **The closer you get to 100% the better AI can assist you.**
58
+
59
+ 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.
60
+
39
61
  ```
40
62
  โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”
41
63
  ๐ŸŽ๏ธ FAF AI-READINESS SCORE: 100/100 โ€” PODIUM EDITION
@@ -59,24 +81,6 @@ At 55% you are building your project with half a blueprint and basically flippin
59
81
 
60
82
  ---
61
83
 
62
- ## โšก Quick Start
63
-
64
- **Copy and paste this to Claude/your AI:**
65
-
66
- > Install the FAF MCP server: `npm install -g faf-mcp`, then add this to my MCP config: `{"mcpServers": {"faf": {"command": "npx", "args": ["-y", "faf-mcp"]}}}` and restart.
67
-
68
- ### Platform-Specific Setup
69
-
70
- **Claude Desktop:** Add to `claude_desktop_config.json` ([location guide](https://wolfe-jam.github.io/claude-faf-mcp/))
71
-
72
- **Cursor IDE:** Add to `~/.cursor/mcp.json` ([setup guide](https://docs.cursor.com/context/model-context-protocol))
73
-
74
- **Windsurf Editor:** Add to `~/.codeium/windsurf/mcp_config.json` ([Cascade docs](https://docs.windsurf.com/windsurf/cascade/mcp))
75
-
76
- **VS Code:** Install MCP extension, then add server config
77
-
78
- ---
79
-
80
84
  ## ๐ŸŽฏ Want a Platform-Specific Package?
81
85
 
82
86
  We're launching `faf-mcp` as the universal package. If you'd prefer a dedicated package for your platform (like `cursor-faf-mcp` or `windsurf-faf-mcp` with tailored setup instructions), **[request it here](https://github.com/Wolfe-Jam/faf-mcp/issues)**.
@@ -85,33 +89,48 @@ We'll publish platform-specific packages based on demand.
85
89
 
86
90
  ---
87
91
 
88
- ## ๐Ÿ’ฌ How to Use FAF (MCP Standard)
92
+ ## ๐Ÿ’ฌ use>faf | Prompt Pattern
89
93
 
90
- Start every prompt with **"Use FAF"** to invoke the MCP tools:
94
+ **Start every prompt with "Use FAF"** to invoke MCP tools directly:
91
95
 
92
- ### Claude Desktop
96
+ ### All Platforms
93
97
  ```
94
98
  Use FAF to initialize my project
95
99
  Use FAF to sync my project.faf to all platforms
96
100
  Use FAF to score my AI-readiness
97
- ```
98
-
99
- ### Cursor IDE
100
- ```
101
- Use FAF to create 4 context files from my project.faf
102
101
  Use FAF to enhance my project context
103
- Use FAF to migrate .faf to project.faf
102
+ Use FAF to create platform sync files
104
103
  ```
105
104
 
106
- ### Why "Use FAF"?
105
+ ### Why "Use FAF" Works Everywhere
106
+
107
+ **Claude Desktop:**
108
+ - โœ… Calls MCP tool instead of searching web
109
+ - โœ… No void container issues
110
+ - โœ… Direct tool invocation
107
111
 
108
- This is the **MCP standard** for explicit tool invocation. It tells the AI:
109
- - โœ… Use the installed MCP tool (not web search)
110
- - โœ… Don't create files manually
111
- - โœ… Invoke the proper FAF commands
112
+ **Claude.ai (Web):**
113
+ - โœ… Stops web search addiction immediately
114
+ - โœ… Forces MCP tool usage
115
+ - โœ… No more guessing
112
116
 
113
- **Without "Use FAF"**: AI might search the web or create files manually
114
- **With "Use FAF"**: AI calls the correct MCP tool every time
117
+ **Cursor / Windsurf / Cline:**
118
+ - โœ… MCP standard compliance
119
+ - โœ… Tool invocation (not manual file creation)
120
+ - โœ… Consistent behavior
121
+
122
+ ### The Pattern
123
+
124
+ **Without "Use FAF":**
125
+ - โŒ AI searches the web
126
+ - โŒ AI creates files manually
127
+ - โŒ Void containers
128
+ - โŒ Inconsistent results
129
+
130
+ **With "Use FAF":**
131
+ - โœ… MCP tool called correctly
132
+ - โœ… Championship output
133
+ - โœ… Every time
115
134
 
116
135
  ---
117
136
 
@@ -122,11 +141,13 @@ This is the **MCP standard** for explicit tool invocation. It tells the AI:
122
141
  ```
123
142
  Platform Context Protocol
124
143
  โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€ โ”€โ”€โ”€โ”€โ”€โ”€โ”€ โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€
125
- Claude โ†’ .faf โ†’ MCP
144
+ Any IDE โ†’ IANA Format โ†’ Open Protocol
126
145
  Cursor โ†’ .faf โ†’ MCP
127
146
  Windsurf โ†’ .faf โ†’ MCP
147
+ Cline โ†’ .faf โ†’ MCP
128
148
  VS Code โ†’ .faf โ†’ MCP
129
- Any IDE โ†’ IANA Format โ†’ Open Protocol
149
+ Claude โ†’ .faf โ†’ MCP
150
+ Gemini โ†’ .faf โ†’ MCP
130
151
  ```
131
152
 
132
153
  **.FAF is the foundational, universal base layer** for any platform using the Model Context Protocol. It provides the standardized Context that makes MCP work for everyone.
@@ -170,7 +191,17 @@ This is the **MCP standard** for explicit tool invocation. It tells the AI:
170
191
 
171
192
  ## ๐Ÿ† Why FAF?
172
193
 
173
- > "README for the AI era" โ€” Gemini CLI
194
+ ### Championship Credentials
195
+
196
+ **๐Ÿ… Creators of the Format** - We designed .FAF (IANA-registered `application/vnd.faf+yaml`)
197
+ **๐Ÿ… First & Only** - Persistent Project Context MCP Server approved by Anthropic
198
+ **๐Ÿ… Creators of Context-Mirroring** - faf_bi_sync creates native files for all platforms
199
+ **๐Ÿ… Google Chrome-Approved** - Published Chrome Extension
200
+ **๐Ÿ… 12K+ npm Downloads** - Proven adoption across the ecosystem
201
+
202
+ > "README for the AI era" โ€” Google Gemini
203
+
204
+ ### The FAF Advantage
174
205
 
175
206
  **Persistent Context** - Your project's DNA lives in `project.faf`, readable by any AI or human
176
207
 
@@ -178,6 +209,10 @@ This is the **MCP standard** for explicit tool invocation. It tells the AI:
178
209
 
179
210
  **Zero Setup Tax** - One file (`project.faf`) eliminates AI context setup across your entire team
180
211
 
212
+ **FREE FOREVER** - MIT License, open source, no subscription
213
+
214
+ **All Boats Rise Together** - Improving projects, AI performance, code quality, speed to market for everyone
215
+
181
216
  **Championship Engineering** - F1-inspired performance with strict TypeScript, zero runtime errors
182
217
 
183
218
  ---
package/package.json CHANGED
@@ -1,8 +1,8 @@
1
1
  {
2
2
  "name": "faf-mcp",
3
- "version": "1.0.5",
3
+ "version": "1.1.0",
4
4
  "mcpName": "io.github.Wolfe-Jam/faf-mcp",
5
- "description": "USE>FAFโ„ข - IANA-registered format (application/vnd.faf+yaml) โ€ข Universal AI context โ€ข MCP server for all platforms โ€ข Start with 'Use FAF'",
5
+ "description": "faf-mcp | use>faf โ€ข IANA-registered format (application/vnd.faf+yaml) โ€ข Universal MCP server for Cursor, Windsurf, Cline, VS Code, and all platforms",
6
6
  "icon": "./assets/icons/faf-icon-256.png",
7
7
  "logo": "./assets/icons/faf-icon-256.png",
8
8
  "displayName": ".faf ๐Ÿงกโšก๏ธ",
@@ -85,6 +85,7 @@
85
85
  "README.md",
86
86
  "CLAUDE.md",
87
87
  ".faf",
88
+ "project.faf",
88
89
  "LICENSE",
89
90
  "CHANGELOG.md"
90
91
  ],
package/project.faf ADDED
@@ -0,0 +1,125 @@
1
+ faf_version: 2.5.0
2
+ ai_scoring_system: 2025-09-20
3
+ ai_score: 85%
4
+ ai_confidence: HIGH
5
+ ai_value: 30_seconds_replaces_20_minutes_of_questions
6
+ ai_tldr:
7
+ project: Faf Mcp - "USE>FAFโ„ข - IANA-registered format (application/vnd.faf+yaml)
8
+ โ€ข Universal AI context โ€ข MCP server for all platforms โ€ข Start with 'Use
9
+ FAF'"
10
+ stack: CLI/TypeScript/TypeScript (tsc)/npm registry/Node.js
11
+ quality_bar: ZERO_ERRORS_F1_STANDARDS
12
+ current_focus: Production deployment preparation
13
+ your_role: Build features with perfect context
14
+ instant_context:
15
+ what_building: USE>FAFโ„ข - IANA-registered format (application/vnd.faf+yaml) โ€ข
16
+ Universal AI context โ€ข MCP server for all platforms โ€ข Start with 'Use FAF'
17
+ tech_stack: CLI/TypeScript/TypeScript (tsc)/npm registry/Node.js
18
+ main_language: TypeScript
19
+ deployment: npm registry
20
+ key_files:
21
+ - package.json
22
+ - tsconfig.json
23
+ context_quality:
24
+ slots_filled: 16/21 (76%)
25
+ ai_confidence: GOOD
26
+ handoff_ready: true
27
+ missing_context:
28
+ - CI/CD pipeline
29
+ - Database
30
+ project:
31
+ name: Faf Mcp
32
+ goal: USE>FAFโ„ข - IANA-registered format (application/vnd.faf+yaml) โ€ข Universal
33
+ AI context โ€ข MCP server for all platforms โ€ข Start with 'Use FAF'
34
+ main_language: TypeScript
35
+ type: cli-ts
36
+ generated: 2025-11-13T20:02:03.291Z
37
+ mission: ๐Ÿš€ Make Your AI Happy! ๐Ÿงก Trust-Driven ๐Ÿค–
38
+ revolution: 30 seconds replaces 20 minutes of questions
39
+ brand: F1-Inspired Software Engineering - Championship AI Context
40
+ ai_instructions:
41
+ how_to_start: "Just USE FAF - Start every prompt with 'Use FAF to...' and MCP tools handle the rest"
42
+ priority_order:
43
+ - 1. Read THIS .faf file first
44
+ - 2. Check CLAUDE.md for session context
45
+ - 3. Review package.json for dependencies
46
+ quick_commands:
47
+ - "Use FAF to initialize your project"
48
+ - "Use FAF to sync my project.faf to all platforms"
49
+ - "Use FAF to score my AI-readiness"
50
+ working_style:
51
+ code_first: true
52
+ explanations: minimal
53
+ quality_bar: zero_errors
54
+ testing: required
55
+ warnings:
56
+ - Never modify dial components without approval
57
+ - All TypeScript must pass strict mode
58
+ - Test coverage required for new features
59
+ stack:
60
+ frontend: CLI
61
+ css_framework: None
62
+ ui_library: None
63
+ state_management: None
64
+ backend: Node.js
65
+ runtime: Node.js >=18.0.0
66
+ database: None
67
+ build: TypeScript (tsc)
68
+ package_manager: npm
69
+ api_type: CLI
70
+ hosting: npm registry
71
+ cicd: None
72
+ preferences:
73
+ quality_bar: zero_errors
74
+ commit_style: conventional_emoji
75
+ response_style: concise_code_first
76
+ explanation_level: minimal
77
+ communication: direct
78
+ testing: required
79
+ documentation: as_needed
80
+ state:
81
+ phase: development
82
+ version: 1.0.0
83
+ focus: production_deployment
84
+ status: green_flag
85
+ next_milestone: npm_publication
86
+ blockers: null
87
+ tags:
88
+ auto_generated:
89
+ - faf-mcp
90
+ - cli
91
+ - typescript
92
+ - typescript-(tsc)
93
+ - npm-registry
94
+ - node.js
95
+ smart_defaults:
96
+ - .faf
97
+ - ai-ready
98
+ - "2025"
99
+ - software
100
+ - open-source
101
+ user_defined: null
102
+ human_context:
103
+ who: Development teams
104
+ what: "everything:"
105
+ why: To MCP work for everyone
106
+ where: Web platform
107
+ when: Production/Stable
108
+ how: Use FAF to initialize your project
109
+ additional_context: null
110
+ context_score: 0
111
+ total_prd_score: 85
112
+ success_rate: 50%
113
+ ai_scoring_details:
114
+ system_date: 2025-09-20
115
+ slot_based_percentage: 76
116
+ ai_score: 85
117
+ total_slots: 21
118
+ filled_slots: 16
119
+ scoring_method: Honest percentage - no fake minimums
120
+ trust_embedded: COUNT ONCE architecture - trust MY embedded scores
121
+ faf_dna:
122
+ birth_dna: 22
123
+ birth_certificate: FAF-2025-FAFMCP-NR94
124
+ birth_date: 2025-11-13T20:02:03.306Z
125
+ current_score: 83