claude-faf-mcp 3.2.1 → 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.
- package/CHANGELOG.md +40 -0
- package/README.md +5 -88
- package/assets/icons/faf-icon-128.png +0 -0
- package/assets/icons/faf-icon-48.png +0 -0
- package/package.json +2 -4
package/CHANGELOG.md
CHANGED
|
@@ -5,6 +5,46 @@ 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
|
+
|
|
24
|
+
## [3.3.0] - 2025-11-12
|
|
25
|
+
|
|
26
|
+
### Added
|
|
27
|
+
- **Desktop Extension (.mcpb)** - One-click installation bundle with branded FAF orange icon
|
|
28
|
+
- Packaged .mcpb format for drag-and-drop installation in Claude Desktop
|
|
29
|
+
- Orange smiley icon displays in all MCP server views
|
|
30
|
+
- Available from GitHub releases page
|
|
31
|
+
- **MCP Protocol Icons** - Added full icon set (48x48, 128x128, 256x256, 512x512) to server.json
|
|
32
|
+
- Icons hosted on GitHub raw URLs for registry display
|
|
33
|
+
- Proper MIME types and size specifications
|
|
34
|
+
|
|
35
|
+
### Changed
|
|
36
|
+
- **One-Command Installation** - Moved faf-cli from peerDependencies to dependencies
|
|
37
|
+
- `npm install -g claude-faf-mcp` now auto-installs both packages
|
|
38
|
+
- Dual download metrics maintained (both packages counted separately)
|
|
39
|
+
- Eliminated manual two-step installation process
|
|
40
|
+
- **README Restructure** - Added two installation options
|
|
41
|
+
- Option 1: npm (one command, no config editing)
|
|
42
|
+
- Option 2: Desktop Extension (with branded icon)
|
|
43
|
+
- Clear documentation of path resolution system
|
|
44
|
+
|
|
45
|
+
### Installation Experience
|
|
46
|
+
This release perfects the installation flow: users get one-command simplicity while we maintain accurate download metrics for both claude-faf-mcp and faf-cli packages.
|
|
47
|
+
|
|
8
48
|
## [3.2.0] - 2025-11-10
|
|
9
49
|
|
|
10
50
|
### 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
|
[](https://www.npmjs.com/package/claude-faf-mcp)
|
|
12
12
|
[](https://discord.com/invite/3pjzpKsP)
|
|
@@ -52,94 +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
|
-
|
|
55
|
+
**Copy and paste this to Claude/your AI:**
|
|
56
56
|
|
|
57
|
-
|
|
58
|
-
```bash
|
|
59
|
-
npm install -g faf-cli
|
|
60
|
-
```
|
|
61
|
-
|
|
62
|
-
**Step 2: Then Install MCP Server**
|
|
63
|
-
```bash
|
|
64
|
-
# Via npx (recommended - always latest)
|
|
65
|
-
npx @modelcontextprotocol/inspector npx -y claude-faf-mcp
|
|
66
|
-
|
|
67
|
-
# Or install globally
|
|
68
|
-
npm install -g claude-faf-mcp
|
|
69
|
-
```
|
|
70
|
-
|
|
71
|
-
**Why this order?** MCP auto-detects CLI at startup. Installing MCP first will show warnings. Always install faf-cli before claude-faf-mcp.
|
|
72
|
-
|
|
73
|
-
**Claude Desktop Configuration:**
|
|
74
|
-
```json
|
|
75
|
-
{
|
|
76
|
-
"mcpServers": {
|
|
77
|
-
"faf": {
|
|
78
|
-
"command": "npx",
|
|
79
|
-
"args": ["-y", "claude-faf-mcp"]
|
|
80
|
-
}
|
|
81
|
-
}
|
|
82
|
-
}
|
|
83
|
-
```
|
|
84
|
-
|
|
85
|
-
---
|
|
86
|
-
|
|
87
|
-
## 📁 Projects Convention
|
|
88
|
-
|
|
89
|
-
**Default Path Structure:** `~/Projects/[project-name]/project.faf`
|
|
90
|
-
|
|
91
|
-
The MCP server uses an intelligent path resolution system:
|
|
92
|
-
|
|
93
|
-
1. **AI Inference** - Automatically detects project name from README titles, package.json, or uploaded files
|
|
94
|
-
2. **User Statement** - Explicit project name provided by user
|
|
95
|
-
3. **Custom Path** - User-provided path always wins
|
|
96
|
-
|
|
97
|
-
**Example Workflows:**
|
|
98
|
-
|
|
99
|
-
```bash
|
|
100
|
-
# Upload README titled "Heritage Club Dubai"
|
|
101
|
-
# → Automatically creates: ~/Projects/heritage-club-dubai/project.faf
|
|
102
|
-
|
|
103
|
-
# Provide project name
|
|
104
|
-
faf_init projectName:"my-app"
|
|
105
|
-
# → Creates: ~/Projects/my-app/project.faf
|
|
106
|
-
|
|
107
|
-
# Explicit path (always respected)
|
|
108
|
-
faf_init path:"/Users/you/custom/location"
|
|
109
|
-
# → Creates: /Users/you/custom/location/project.faf
|
|
110
|
-
```
|
|
111
|
-
|
|
112
|
-
**Cross-Platform Support:**
|
|
113
|
-
- macOS: `~/Projects/`
|
|
114
|
-
- Linux: `~/Projects/`
|
|
115
|
-
- Windows: `%USERPROFILE%\Projects\`
|
|
116
|
-
|
|
117
|
-
**Guide Tool:**
|
|
118
|
-
Run `faf_guide` in Claude Desktop for complete path resolution rules and UX patterns.
|
|
119
|
-
|
|
120
|
-
---
|
|
121
|
-
|
|
122
|
-
## 🔧 Troubleshooting
|
|
123
|
-
|
|
124
|
-
**CLI Not Detected?**
|
|
125
|
-
|
|
126
|
-
The MCP auto-detects faf-cli in common locations. If detection fails, set the path manually:
|
|
127
|
-
|
|
128
|
-
```json
|
|
129
|
-
{
|
|
130
|
-
"mcpServers": {
|
|
131
|
-
"faf": {
|
|
132
|
-
"command": "npx",
|
|
133
|
-
"args": ["-y", "claude-faf-mcp"],
|
|
134
|
-
"env": {
|
|
135
|
-
"FAF_CLI_PATH": "/custom/path/to/faf"
|
|
136
|
-
}
|
|
137
|
-
}
|
|
138
|
-
}
|
|
139
|
-
}
|
|
140
|
-
```
|
|
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.
|
|
141
58
|
|
|
142
|
-
|
|
59
|
+
**One-Click Alternative:** [Desktop Extension (.mcpb)](https://github.com/Wolfe-Jam/claude-faf-mcp/releases/latest)
|
|
143
60
|
|
|
144
61
|
---
|
|
145
62
|
|
|
@@ -199,7 +116,7 @@ Find your CLI path: `which faf`
|
|
|
199
116
|
|
|
200
117
|
## 🏆 Why FAF?
|
|
201
118
|
|
|
202
|
-
> "README for the AI era" — Gemini CLI
|
|
119
|
+
> "README for the AI era" — Gemini CLI
|
|
203
120
|
|
|
204
121
|
**Persistent Context** - Your project's DNA lives in `project.faf`, readable by any AI or human
|
|
205
122
|
|
|
Binary file
|
|
Binary file
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "claude-faf-mcp",
|
|
3
|
-
"version": "3.
|
|
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",
|
|
@@ -119,10 +119,8 @@
|
|
|
119
119
|
"publishConfig": {
|
|
120
120
|
"access": "public"
|
|
121
121
|
},
|
|
122
|
-
"peerDependencies": {
|
|
123
|
-
"faf-cli": ">=3.1.1"
|
|
124
|
-
},
|
|
125
122
|
"dependencies": {
|
|
123
|
+
"faf-cli": ">=3.1.1",
|
|
126
124
|
"@modelcontextprotocol/sdk": "^1.20.1",
|
|
127
125
|
"yaml": "^2.4.1"
|
|
128
126
|
},
|