claude-faf-mcp 2.2.8 โ†’ 2.2.10

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 (2) hide show
  1. package/README.md +62 -245
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,116 +1,70 @@
1
- # ๐ŸŽ๏ธโšก๏ธ Claude .faf MCP Server
2
- ## .faf The JPEG for AI is here
1
+ # ๐ŸŽ๏ธโšก๏ธ claude-faf-mcp
3
2
 
4
- > **๐Ÿ† MCP READY - The JPEG for AI is REAL! ๐Ÿ†**
3
+ ## .faf The JPEG for AIโ„ข - Universal AI Context Management
5
4
 
6
- > **๐Ÿ Testing Center: [faf.one/testing](https://faf.one/testing) ๐Ÿ**
5
+ > **MCP Compatible | Zero Dependencies | Production Ready**
7
6
 
7
+ Transform your projects into AI-optimized collaboration spaces with championship-grade performance.
8
8
 
9
- > **Claude .faf MCP Server | AI-Context on-demand management with bi-sync for Claude Users of all levels, with C.O.R.E performance faf-engine-Mk1**
10
-
11
- Transform your projects into AI-optimized collaboration spaces with **C.O.R.E (Comprehensive, Optimized, Relentless, Empirical) performance** powered by the **faf-engine-Mk1** architecture.
12
-
13
- [![MCP Compatible](https://img.shields.io/badge/MCP-โœ…%20Protocol%20Compatible-green)](https://modelcontextprotocol.io)
14
9
  [![NPM Version](https://img.shields.io/npm/v/claude-faf-mcp)](https://www.npmjs.com/package/claude-faf-mcp)
15
- [![Claude Desktop](https://img.shields.io/badge/Claude-Desktop%20Ready-purple)](https://claude.ai)
16
- [![AI Readiness](https://img.shields.io/badge/AI%20Readiness-99%25-orange)](https://faf.one)
17
- [![TypeScript](https://img.shields.io/badge/TypeScript-Strict%20Mode-blue)](https://www.typescriptlang.org/)
18
- [![F1-Inspired](https://img.shields.io/badge/Philosophy-F1--Inspired-red)](https://github.com/faf-dev/claude-faf-mcp)
10
+ [![Downloads](https://img.shields.io/npm/dt/claude-faf-mcp)](https://www.npmjs.com/package/claude-faf-mcp)
11
+ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
19
12
 
20
13
  ## ๐Ÿšจ ZERO DEPENDENCIES, ZERO FAFFโ„ข
21
- **11,000+ tests run** โ€ข **240+ npm downloads** โ€ข **<50ms operations**
22
-
23
- ## ๐ŸŠ ZERO .faf | .fafLESS AI
24
14
 
25
- **We ARE the C in MCP.** Vitamin Context for healthy AI. Iโšก๐ŸŠ
15
+ **Production v2.2.9** โ€ข **11,000+ tests run** โ€ข **<50ms operations** โ€ข **1 dependency only**
26
16
 
27
- ## ๐Ÿš€ Quick Install (2 Commands!)
17
+ ## ๐Ÿš€ Quick Install
28
18
 
29
19
  ```bash
30
- # Step 1: Install globally
20
+ # Install globally
31
21
  npm install -g claude-faf-mcp
32
22
 
33
- # Step 2: Add to Claude Desktop
23
+ # Add to Claude Desktop
34
24
  echo '{"mcpServers":{"claude-faf-mcp":{"command":"claude-faf-mcp","args":[],"env":{}}}}' > ~/Library/Application\ Support/Claude/claude_desktop_config.json
35
25
  ```
36
26
 
37
- **Step 3:** Restart Claude Desktop - DONE! ๐Ÿ
38
-
39
- **Test:** Drop any package.json into Claude and watch the magic!
40
-
41
- ## ๐Ÿค– What is Claude FAF MCP?
42
-
43
- The **Claude FAF MCP Server** provides 33 honest file operations for Claude Desktop. **ENJOY this in Desktop - FAF CLI will be right behind it!**
44
-
45
- Currently delivers:
46
- - โœ… Native file operations (read, write, list, etc.)
47
- - โœ… <50ms performance guaranteed
48
- - โœ… Works WITHOUT external dependencies
49
- - ๐Ÿ”œ Full FAF CLI integration coming soon for scoring & enhancement
50
-
51
- ### ๐Ÿ’ก PRO TIP: The Perfect Workflow
52
-
53
- **Drop a project file โ†’ Instant context!** Here's the flow:
54
- 1. Drop your `package.json`, `requirements.txt`, or `README.md` into Claude
55
- 2. Claude instantly knows what you're working on
56
- 3. For new projects: Claude creates `claude.md`, you create `.faf`
57
- 4. The AI-Context becomes **permanent glue** - your project understanding persists!
58
-
59
- *"Once you drop that first file, the context sticks. No more explaining your project every chat!"*
60
-
61
- ### Key Benefits
62
-
63
- - ๐Ÿง  **Intelligent Context**: Automatically analyzes and optimizes your project for AI collaboration
64
- - โšก **Real-time Sync**: Bi-directional synchronization between `.faf` context and `claude.md`
65
- - ๐Ÿ“ˆ **AI Scoring**: Get detailed metrics on your project's AI-readiness
66
- - ๐ŸŽฏ **Claude-Optimized**: Specially tuned for optimal Claude performance
67
- - ๐ŸŒ **Universal**: Works with Claude Desktop, Claude Web, and Claude API
27
+ Restart Claude Desktop - Done! ๐Ÿ
68
28
 
69
- ## ๐Ÿ’ญ The World's First AI-Validated Developer Tool?
29
+ ## ๐Ÿค– What is claude-faf-mcp?
70
30
 
71
- ### What the BIG-3 AI's themselves Say:
31
+ The MCP server that brings .faf format power to Claude Desktop. Drop any project file into Claude and get instant AI understanding.
72
32
 
73
- | Platform | Score | Verdict |
74
- |----------|-------|---------|
75
- | **Claude (Anthropic)** | 9.5/10 | *"Should become the standard"* |
76
- | **OpenAI Codex** | 9/10 | *"Every project should have one"* |
77
- | **Google Gemini** | 9.5/10 | *"README evolution for AI era"* |
33
+ ### Key Features
78
34
 
79
- > **"its so logical [.faf] if it didn't exist, AI would have built it itself"** - Claude Code
35
+ - โœ… **Zero Configuration** - Works instantly
36
+ - โœ… **33+ Tools** - Complete file operations
37
+ - โœ… **<50ms Performance** - F1-inspired speed
38
+ - โœ… **Bi-directional Sync** - .faf โ†” claude.md
39
+ - โœ… **99% AI Readiness** - Guaranteed understanding
80
40
 
81
- > **"package.json gives me a list of dependencies, .faf shows me what to do with them"** - Claude Code
82
-
83
- > **"package.json wasn't built for this, .faf was"** - .faf Inventor
84
-
85
- ## ๐Ÿ Testing & Development
86
-
87
- **๐Ÿงช Test Scripts: Available in `/tests/scripts/`**
88
- **๐Ÿ† 11,000+ tests run and counting**
89
-
90
- ### Quick Test Commands
91
- ```bash
92
- # Test the MCP server
93
- npm test
94
-
95
- # Build the project
96
- npm run build
97
- ```
41
+ ## ๐Ÿ› ๏ธ Available Tools
98
42
 
99
- ## ๐Ÿš€ Quick Start
43
+ ### Core Tools
44
+ - `faf_init` - Initialize .faf context
45
+ - `faf_score` - Calculate AI readiness score
46
+ - `faf_status` - Get project status
100
47
 
101
- ### Prerequisites
48
+ ### Enhancement Tools
49
+ - `faf_enhance` - Claude-optimized enhancement
50
+ - `faf_sync` - Sync .faf with claude.md
51
+ - `faf_bi_sync` - Real-time bidirectional sync
102
52
 
103
- - Node.js 18+
53
+ ### Management Tools
54
+ - `faf_trust` - Validate context integrity
55
+ - `faf_clear` - Clear caches
56
+ - `faf_debug` - Debug connectivity
104
57
 
105
- ### Installation
58
+ ## ๐Ÿ“– Usage
106
59
 
107
- ```bash
108
- npm install -g claude-faf-mcp
109
- ```
60
+ 1. **Drop a file** - Drop package.json, README, or any project file into Claude
61
+ 2. **Instant context** - Claude immediately understands your project
62
+ 3. **Use tools** - Type "faf" to see available commands
63
+ 4. **Stay synced** - Context persists across conversations
110
64
 
111
- ### Configuration
65
+ ## โš™๏ธ Configuration
112
66
 
113
- Add to your Claude Desktop configuration (`claude_desktop_config.json`):
67
+ Add to Claude Desktop configuration:
114
68
 
115
69
  ```json
116
70
  {
@@ -123,187 +77,50 @@ Add to your Claude Desktop configuration (`claude_desktop_config.json`):
123
77
  }
124
78
  ```
125
79
 
126
- Or for development with a local FAF build:
127
-
128
- ```json
129
- {
130
- "mcpServers": {
131
- "claude-faf": {
132
- "command": "claude-faf-mcp",
133
- "args": [
134
- "--transport", "stdio",
135
- "--faf-engine", "/path/to/your/faf/cli"
136
- ]
137
- }
138
- }
139
- }
140
- ```
141
-
142
- ## ๐Ÿ› ๏ธ Available Tools
143
-
144
- The server provides 9 powerful tools for AI-enhanced development:
145
-
146
- ### Core Analysis
147
- - **`faf_status`** - Get comprehensive project status and AI readiness metrics
148
- - **`faf_score`** - Calculate AI collaboration score with detailed breakdown
149
- - **`faf_debug`** - Debug server environment and FAF CLI connectivity
150
-
151
- ### Project Management
152
- - **`faf_init`** - Initialize FAF context with intelligent stack detection
153
- - **`faf_trust`** - Validate context integrity and trust metrics
154
- - **`faf_clear`** - Clear caches and reset state
155
-
156
- ### Context Optimization
157
- - **`faf_enhance`** - Claude-optimized AI enhancement with multi-model support
158
- - **`faf_sync`** - Synchronize .faf context with claude.md
159
- - **`faf_bi_sync`** - Bi-directional sync with real-time watching
160
-
161
- ## ๐Ÿ“– Usage Examples
162
-
163
- ### Initialize a New Project
164
-
165
- ```
166
- Use the faf_init tool to set up FAF context for your project.
167
- ```
168
-
169
- ### Check Project Health
80
+ ## ๐Ÿ“Š Real Metrics
170
81
 
171
82
  ```
172
- Use faf_status to see your project's AI collaboration metrics:
173
- - Context quality score
174
- - AI readiness level
175
- - Performance metrics
176
- - Claude compatibility rating
83
+ ๐Ÿ“ˆ Status: PRODUCTION
84
+ โ”œโ”€ ๐Ÿ’Ž Version: 2.2.9
85
+ โ”œโ”€ ๐Ÿš€ Performance: <50ms
86
+ โ”œโ”€ ๐Ÿ“ฆ Dependencies: 1 (MCP SDK only)
87
+ โ”œโ”€ ๐Ÿงช Tests Run: 11,000+
88
+ โ””โ”€ ๐Ÿ† AI Readiness: 99%
177
89
  ```
178
90
 
179
- ### Optimize for Claude
91
+ ## ๐Ÿ Development
180
92
 
181
- ```
182
- Use faf_enhance with model="claude" and focus="claude-optimal"
183
- to get the best possible Claude collaboration experience.
184
- ```
185
-
186
- ### Sync with Claude.md
187
-
188
- ```
189
- Use faf_bi_sync to maintain automatic synchronization between
190
- your .faf context and claude.md file for seamless collaboration.
191
- ```
192
-
193
- ## โš™๏ธ Configuration Options
194
-
195
- The server accepts several command-line options:
196
-
197
- - `--transport <stdio|http-sse>` - Transport protocol (default: stdio)
198
- - `--port <number>` - Port for HTTP-SSE transport (default: 3001)
199
- - `--faf-engine <path>` - Path to FAF CLI (default: 'faf' global command)
200
- - `--debug` - Enable debug logging
201
-
202
- ## ๐Ÿ—๏ธ Development Setup
203
-
204
- ### Local Development
205
-
206
- 1. Clone and install dependencies:
207
93
  ```bash
208
- git clone https://github.com/faf-dev/claude-faf-mcp.git
94
+ # Clone repo
95
+ git clone https://github.com/wolfejam/claude-faf-mcp.git
209
96
  cd claude-faf-mcp
210
- npm install
211
- ```
212
97
 
213
- 2. Build the project:
214
- ```bash
98
+ # Install & build
99
+ npm install
215
100
  npm run build
216
- ```
217
-
218
- 3. Test locally:
219
- ```bash
220
- npm run dev:stdio
221
- ```
222
101
 
223
- 4. Add to Claude config with local path:
224
- ```json
225
- {
226
- "mcpServers": {
227
- "claude-faf-dev": {
228
- "command": "npx",
229
- "args": ["ts-node", "src/cli.ts", "--transport", "stdio"],
230
- "cwd": "/path/to/claude-faf-mcp"
231
- }
232
- }
233
- }
234
- ```
235
-
236
- ### Testing
237
-
238
- Run the test suite:
239
- ```bash
102
+ # Test
240
103
  npm test
241
104
  ```
242
105
 
243
- Test MCP protocol compliance:
244
- ```bash
245
- npm run test:mcp
246
- ```
247
-
248
106
  ## ๐Ÿ“‹ Requirements
249
107
 
250
- - **Node.js**: Version 18 or higher
251
- - **FAF CLI**: Installed and accessible in PATH
252
- - **Claude Desktop**: Latest version with MCP support
253
- - **Operating System**: macOS, Linux, or Windows
254
-
255
- ## ๐Ÿ“Š Real Performance Metrics
256
-
257
- ```
258
- ๐Ÿ“ˆ Project Status: CHAMPION
259
- โ”œโ”€ ๐Ÿ’Ž Context Quality: 100%
260
- โ”œโ”€ ๐Ÿค– AI Readiness: Universal
261
- โ”œโ”€ โšก Performance: 38ms average
262
- โ”œโ”€ ๐Ÿงก Community: Growing daily
263
- โ””โ”€ ๐Ÿ“ˆ Enterprise Ready: Day One
264
- ```
265
-
266
- ## ๐Ÿ The F1-Inspired Philosophy
267
-
268
- We build software with F1-Inspired principles:
269
-
270
- 1. **Precision Engineering** - Every line purposeful
271
- 2. **Performance Obsession** - Milliseconds matter
272
- 3. **Continuous Innovation** - Always improving
273
- 4. **Championship Standards** - Only the best survives
274
-
275
- *Created by ๐ŸŽ๏ธโšก๏ธwolfejam, F1-fanatic and inventor of .faf*
276
-
277
- ## ๐Ÿค Contributing
278
-
279
- We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details.
280
-
281
- 1. Fork the repository
282
- 2. Create a feature branch: `git checkout -b feature/amazing-feature`
283
- 3. Commit your changes: `git commit -m 'Add amazing feature'`
284
- 4. Push to the branch: `git push origin feature/amazing-feature`
285
- 5. Open a Pull Request
108
+ - Node.js 18+
109
+ - Claude Desktop (latest)
110
+ - macOS, Linux, or Windows
286
111
 
287
112
  ## ๐Ÿ“„ License
288
113
 
289
- MIT License - see the [LICENSE](LICENSE) file for details.
290
-
291
- **Note: ASK FOR ACCESS - SOME FEATURES**: The .faf-Engine(s) are proprietary and available under license.
114
+ MIT License - see LICENSE file
292
115
 
293
- ## ๐Ÿ™‹ Support
116
+ **Note**: The .faf-Engine(s) are proprietary and available under license.
294
117
 
295
- - **GitHub Issues**: [Report bugs or request features](https://github.com/Wolfe-Jam/claude-faf-mcp/issues)
296
- - **Documentation**: [Full documentation](https://faf.dev/docs/claude-mcp)
297
- - **Community**: [Join our Discord](https://discord.gg/faf-dev)
118
+ ## ๐Ÿ”— Links
298
119
 
299
- ## ๐Ÿ”— Related Projects
300
-
301
- - **[FAF CLI](https://www.npmjs.com/package/faf-cli)** - The core FAF engine
302
- - **[Claude Desktop](https://claude.ai/download)** - Anthropic's desktop application
303
- - **[MCP SDK](https://github.com/modelcontextprotocol/typescript-sdk)** - Model Context Protocol SDK
120
+ - **NPM**: [claude-faf-mcp](https://www.npmjs.com/package/claude-faf-mcp)
121
+ - **Website**: [faf.one](https://faf.one)
122
+ - **Support**: support@faf.one
304
123
 
305
124
  ---
306
125
 
307
- **Made with โค๏ธ for the Claude community**
308
-
309
- Transform your projects into AI-collaboration powerhouses with Claude FAF MCP Server!
126
+ **Made with ๐Ÿงก by wolfejam** | **ZERO DEPENDENCIES, ZERO FAFFโ„ข**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "claude-faf-mcp",
3
- "version": "2.2.8",
3
+ "version": "2.2.10",
4
4
  "description": ".faf The JPEG for AI is here. The C in MCP is .faf - Foundational AI-context Format. Universal AI context management with 33+ tools for Claude Desktop. Every command shows AI-Readiness score. Drop file โ†’ Type 'faf' โ†’ 99% ready!",
5
5
  "main": "dist/server.js",
6
6
  "bin": {