claude-faf-mcp 3.3.0 โ†’ 3.3.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/CHANGELOG.md +16 -0
  2. package/README.md +5 -108
  3. package/package.json +1 -1
package/CHANGELOG.md CHANGED
@@ -5,6 +5,22 @@ 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
+ ## [3.3.1] - 2025-11-12
9
+
10
+ ### Changed
11
+ - **README Simplification** - Minimalist Quick Start following Claude Code's clean approach
12
+ - "Copy and paste this to Claude/your AI" - Zero friction installation
13
+ - Single-line config instruction (no verbose JSON blocks)
14
+ - npm as primary install method (traffic/discovery optimized)
15
+ - Desktop Extension as one-click alternative
16
+ - **Strategic Positioning** - Optimized for npm search ranking and discoverability
17
+ - Removed Projects Convention section (moved to docs)
18
+ - Removed Troubleshooting section (moved to docs)
19
+ - Clean, professional landing page
20
+
21
+ ### User Experience
22
+ This release perfects the installation messaging: users get ultra-minimal instructions while we maintain maximum npm download metrics for ecosystem discoverability.
23
+
8
24
  ## [3.3.0] - 2025-11-12
9
25
 
10
26
  ### Added
package/README.md CHANGED
@@ -6,7 +6,7 @@
6
6
  </div>
7
7
  </div>
8
8
 
9
- > Official MCP server for FAF (Foundational AI-context Format) with 50 tools - Persistent project context that integrates seamlessly with Claude Desktop workflows
9
+ > Official MCP server for .FAF (Foundational AI-context Format) with 50 tools - Persistent project context that integrates seamlessly with Claude Desktop workflows
10
10
 
11
11
  [![NPM Downloads](https://img.shields.io/npm/dt/claude-faf-mcp?label=total%20downloads&color=00CCFF)](https://www.npmjs.com/package/claude-faf-mcp)
12
12
  [![Discord](https://img.shields.io/badge/Discord-Join%20Community-5865F2?logo=discord&logoColor=white)](https://discord.com/invite/3pjzpKsP)
@@ -52,114 +52,11 @@ At 55% you are building your project with half a blueprint and basically flippin
52
52
 
53
53
  ## โšก Quick Start
54
54
 
55
- ### Option 1: npm (One Command ๐Ÿš€)
55
+ **Copy and paste this to Claude/your AI:**
56
56
 
57
- **One command installs everything:**
57
+ > Install the FAF MCP server: `npm install -g claude-faf-mcp`, then add this to my claude_desktop_config.json: `{"mcpServers": {"faf": {"command": "npx", "args": ["-y", "claude-faf-mcp"]}}}` and restart Claude Desktop.
58
58
 
59
- ```bash
60
- npm install -g claude-faf-mcp
61
- ```
62
-
63
- That's it! Auto-installs faf-cli + MCP server. Both get download metrics.
64
-
65
- **Configure Claude Desktop:**
66
- ```json
67
- {
68
- "mcpServers": {
69
- "faf": {
70
- "command": "npx",
71
- "args": ["-y", "claude-faf-mcp"]
72
- }
73
- }
74
- }
75
- ```
76
-
77
- Restart Claude Desktop and you're ready!
78
-
79
- ---
80
-
81
- ### Option 2: Desktop Extension (With Icon ๐Ÿงก)
82
-
83
- **Get the FAF orange icon in Claude Desktop!**
84
-
85
- **Step 1: Install CLI**
86
- ```bash
87
- npm install -g faf-cli
88
- ```
89
-
90
- **Step 2: Install Desktop Extension**
91
- 1. **Download** the `.mcpb` file:
92
- https://github.com/Wolfe-Jam/claude-faf-mcp/releases/latest
93
-
94
- 2. **Install in Claude Desktop:**
95
- - Settings โ†’ Extensions โ†’ Advanced settings
96
- - Click "Install Extension"
97
- - Select `claude-faf-mcp-v3.2.1.mcpb`
98
- - Restart Claude Desktop
99
-
100
- 3. **Verify the FAF orange icon** shows in your MCP list!
101
-
102
- **Why this is easier:** No config file editing, auto-detects CLI, branded icon everywhere.
103
-
104
-
105
- ---
106
-
107
- ## ๐Ÿ“ Projects Convention
108
-
109
- **Default Path Structure:** `~/Projects/[project-name]/project.faf`
110
-
111
- The MCP server uses an intelligent path resolution system:
112
-
113
- 1. **AI Inference** - Automatically detects project name from README titles, package.json, or uploaded files
114
- 2. **User Statement** - Explicit project name provided by user
115
- 3. **Custom Path** - User-provided path always wins
116
-
117
- **Example Workflows:**
118
-
119
- ```bash
120
- # Upload README titled "Heritage Club Dubai"
121
- # โ†’ Automatically creates: ~/Projects/heritage-club-dubai/project.faf
122
-
123
- # Provide project name
124
- faf_init projectName:"my-app"
125
- # โ†’ Creates: ~/Projects/my-app/project.faf
126
-
127
- # Explicit path (always respected)
128
- faf_init path:"/Users/you/custom/location"
129
- # โ†’ Creates: /Users/you/custom/location/project.faf
130
- ```
131
-
132
- **Cross-Platform Support:**
133
- - macOS: `~/Projects/`
134
- - Linux: `~/Projects/`
135
- - Windows: `%USERPROFILE%\Projects\`
136
-
137
- **Guide Tool:**
138
- Run `faf_guide` in Claude Desktop for complete path resolution rules and UX patterns.
139
-
140
- ---
141
-
142
- ## ๐Ÿ”ง Troubleshooting
143
-
144
- **CLI Not Detected?**
145
-
146
- The MCP auto-detects faf-cli in common locations. If detection fails, set the path manually:
147
-
148
- ```json
149
- {
150
- "mcpServers": {
151
- "faf": {
152
- "command": "npx",
153
- "args": ["-y", "claude-faf-mcp"],
154
- "env": {
155
- "FAF_CLI_PATH": "/custom/path/to/faf"
156
- }
157
- }
158
- }
159
- }
160
- ```
161
-
162
- Find your CLI path: `which faf`
59
+ **One-Click Alternative:** [Desktop Extension (.mcpb)](https://github.com/Wolfe-Jam/claude-faf-mcp/releases/latest)
163
60
 
164
61
  ---
165
62
 
@@ -219,7 +116,7 @@ Find your CLI path: `which faf`
219
116
 
220
117
  ## ๐Ÿ† Why FAF?
221
118
 
222
- > "README for the AI era" โ€” Gemini CLI
119
+ > "README for the AI era" โ€” Gemini CLI
223
120
 
224
121
  **Persistent Context** - Your project's DNA lives in `project.faf`, readable by any AI or human
225
122
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "claude-faf-mcp",
3
- "version": "3.3.0",
3
+ "version": "3.3.1",
4
4
  "mcpName": "io.github.Wolfe-Jam/claude-faf-mcp",
5
5
  "description": "IANA-registered format (application/vnd.faf+yaml) โ€ข Persistent project context โ€ข MCP server for Claude Desktop โ€ข MIT License",
6
6
  "icon": "./assets/icons/faf-icon-256.png",