faf-mcp 1.0.2 → 1.0.3
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/README.md +41 -2
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -1,12 +1,21 @@
|
|
|
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;">
|
|
4
|
+
<h1 style="margin: 0; color: #FF8C00;">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
|
|
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.
|
|
10
19
|
|
|
11
20
|
[](https://www.npmjs.com/package/faf-mcp)
|
|
12
21
|
[](https://discord.com/invite/3pjzpKsP)
|
|
@@ -76,6 +85,36 @@ We'll publish platform-specific packages based on demand.
|
|
|
76
85
|
|
|
77
86
|
---
|
|
78
87
|
|
|
88
|
+
## 💬 How to Use FAF (MCP Standard)
|
|
89
|
+
|
|
90
|
+
Start every prompt with **"Use FAF"** to invoke the MCP tools:
|
|
91
|
+
|
|
92
|
+
### Claude Desktop
|
|
93
|
+
```
|
|
94
|
+
Use FAF to initialize my project
|
|
95
|
+
Use FAF to sync my project.faf to all platforms
|
|
96
|
+
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
|
+
Use FAF to enhance my project context
|
|
103
|
+
Use FAF to migrate .faf to project.faf
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
### Why "Use FAF"?
|
|
107
|
+
|
|
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
|
+
|
|
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
|
|
115
|
+
|
|
116
|
+
---
|
|
117
|
+
|
|
79
118
|
## 🎯 What is FAF?
|
|
80
119
|
|
|
81
120
|
**The .FAF Position in the MCP Ecosystem:**
|
package/package.json
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "faf-mcp",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.3",
|
|
4
4
|
"mcpName": "io.github.Wolfe-Jam/faf-mcp",
|
|
5
|
-
"description": "IANA-registered format (application/vnd.faf+yaml) •
|
|
5
|
+
"description": "USE>FAF™ - IANA-registered format (application/vnd.faf+yaml) • Universal AI context • MCP server for all platforms • Start with 'Use FAF'",
|
|
6
6
|
"icon": "./assets/icons/faf-icon-256.png",
|
|
7
7
|
"logo": "./assets/icons/faf-icon-256.png",
|
|
8
8
|
"displayName": ".faf 🧡⚡️",
|