claude-faf-mcp 2.2.7 โ†’ 2.2.9

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