grok-faf-mcp 1.2.1 → 1.2.2
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 +38 -0
- package/CLAUDE.md +14 -14
- package/README.md +53 -26
- package/package.json +3 -3
package/CHANGELOG.md
CHANGED
|
@@ -5,6 +5,44 @@ All notable changes to 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
|
+
## [1.2.2] - 2026-04-30
|
|
9
|
+
|
|
10
|
+
### Added
|
|
11
|
+
- **`CONTRIBUTING.md`** — TL;DR for xAI devs, PR conventions, branch
|
|
12
|
+
model, code style, CI doctrine, MCP-tool contribution path, npm
|
|
13
|
+
publish discipline, architecture decisions (`.faf` here / `.fafm`
|
|
14
|
+
in the Voice variant). Tight (~170 lines), F1-inspired tone.
|
|
15
|
+
Direct line for high-signal contributors landing on the repo.
|
|
16
|
+
- **Voice variant cross-link** in README — points readers at
|
|
17
|
+
[`grok-faf-voice`](https://pypi.org/project/grok-faf-voice/), the
|
|
18
|
+
reference implementation of the **Voice Memory Layer (VML)**.
|
|
19
|
+
Same family (`.faf 🐘` for context / `.fafm 🐘🎙️` for voice
|
|
20
|
+
memory), different surface. Routes existing grok-faf-mcp traffic
|
|
21
|
+
to the new voice-side product.
|
|
22
|
+
|
|
23
|
+
### Changed
|
|
24
|
+
- **README H1 simplified** — `# grok-faf-mcp | FAST⚡️AF` →
|
|
25
|
+
`# FAST⚡️AF Context`. npm/PyPI both render the package name
|
|
26
|
+
above the README, so the prefix doubled up. New H1 is pure
|
|
27
|
+
positioning and pairs with `grok-faf-voice`'s "Fast⚡️AF memory
|
|
28
|
+
setup" as sibling FAST⚡️AF taglines (`.faf` = Context,
|
|
29
|
+
`.fafm` = memory).
|
|
30
|
+
- **Tier ladder canonical alignment** — README scoring table now
|
|
31
|
+
matches `faf-cli/src/core/tiers.ts` exactly: 🏆 ★ ◆ ◇ ● ● ○ ♡.
|
|
32
|
+
Top 4 tiers (TROPHY → BRONZE) bolded to mirror the CLI's
|
|
33
|
+
orange/cyan emphasis; GREEN's symbol bolded to mirror
|
|
34
|
+
`bold('●')`; YELLOW/RED/WHITE plain to mirror `dim()`. Adds the
|
|
35
|
+
WHITE 0% row that was previously missing.
|
|
36
|
+
- README test count corrected: 179 → 169 (actual passing count).
|
|
37
|
+
Honest pass for v1.2.2.
|
|
38
|
+
|
|
39
|
+
### Notes
|
|
40
|
+
- Docs-only patch — no behavior changes, no MCP protocol changes,
|
|
41
|
+
no new dependencies. Safe upgrade for all consumers.
|
|
42
|
+
- Companion to `grok-faf-voice` v0.1.3 launch (PyPI live as of
|
|
43
|
+
2026-04-30); the cross-link routes existing grok-faf-mcp traffic
|
|
44
|
+
to the new Voice surface.
|
|
45
|
+
|
|
8
46
|
## [1.2.1] - 2026-03-28
|
|
9
47
|
|
|
10
48
|
### Changed
|
package/CLAUDE.md
CHANGED
|
@@ -2,18 +2,18 @@
|
|
|
2
2
|
|
|
3
3
|
# 🏎️ CLAUDE.md - grok-faf-mcp | FAST⚡️AF
|
|
4
4
|
|
|
5
|
-
## PROJECT STATE: SHIPPING
|
|
6
|
-
**Current Position:**
|
|
5
|
+
## PROJECT STATE: SHIPPING
|
|
6
|
+
**Current Position:** Persistent project context for xAI Grok — first MCP server built for Grok
|
|
7
7
|
**Tyre Compound:** ULTRASOFT C5 (Maximum Performance)
|
|
8
8
|
**Status:** URL-based, Vercel-deployed, Production-ready
|
|
9
9
|
|
|
10
10
|
---
|
|
11
11
|
|
|
12
|
-
##
|
|
12
|
+
## CORE CONTEXT
|
|
13
13
|
|
|
14
14
|
### Project Identity
|
|
15
15
|
- **Name:** grok-faf-mcp
|
|
16
|
-
- **Purpose:**
|
|
16
|
+
- **Purpose:** Persistent project context for xAI Grok — first MCP server responding to Grok's URL request
|
|
17
17
|
- **Stack:** Node.js/TypeScript + Vercel
|
|
18
18
|
- **Quality:** F1-INSPIRED (Championship Performance)
|
|
19
19
|
- **Philosophy:** FAST⚡️AF - First to ship, zero friction, exactly what you asked for
|
|
@@ -22,7 +22,7 @@
|
|
|
22
22
|
|
|
23
23
|
**Grok asked for MCP on a URL. This is it.**
|
|
24
24
|
|
|
25
|
-
|
|
25
|
+
**Persistent project context for xAI Grok.** Deployed on Vercel with URL-first access — no installation required. Point your Grok integration at the endpoint, get persistent project context served via MCP SSE. First MCP server built specifically for Grok/xAI.
|
|
26
26
|
|
|
27
27
|
### Repository Structure
|
|
28
28
|
|
|
@@ -44,14 +44,14 @@ grok-faf-mcp/
|
|
|
44
44
|
- **Why:** Grok asked for MCP on a URL - first to deliver
|
|
45
45
|
- **Format:** IANA-registered .faf (application/vnd.faf+yaml)
|
|
46
46
|
|
|
47
|
-
###
|
|
47
|
+
### Context Quality Status
|
|
48
48
|
- **Overall Assessment:** Production-ready (based on faf-mcp v1.1.1)
|
|
49
49
|
- **Last Updated:** 2025-11-18
|
|
50
50
|
- **Version:** 1.0.0 (First Release)
|
|
51
51
|
|
|
52
52
|
---
|
|
53
53
|
|
|
54
|
-
##
|
|
54
|
+
## Deployment Architecture
|
|
55
55
|
|
|
56
56
|
### Vercel Production
|
|
57
57
|
- **URL:** https://grok-faf-mcp.vercel.app/
|
|
@@ -67,7 +67,7 @@ grok-faf-mcp/
|
|
|
67
67
|
|
|
68
68
|
---
|
|
69
69
|
|
|
70
|
-
##
|
|
70
|
+
## Quick Start for AI
|
|
71
71
|
|
|
72
72
|
**Q: How do I use grok-faf-mcp?**
|
|
73
73
|
|
|
@@ -102,7 +102,7 @@ Use FAF to sync project context
|
|
|
102
102
|
|
|
103
103
|
---
|
|
104
104
|
|
|
105
|
-
##
|
|
105
|
+
## NPM PUBLISH PROTOCOL - MANDATORY
|
|
106
106
|
|
|
107
107
|
**CRITICAL RULE: `npm publish` IS FORBIDDEN WITHOUT APPROVAL**
|
|
108
108
|
|
|
@@ -128,7 +128,7 @@ Before ANY npm publish of grok-faf-mcp:
|
|
|
128
128
|
|
|
129
129
|
---
|
|
130
130
|
|
|
131
|
-
##
|
|
131
|
+
## Strategic Position
|
|
132
132
|
|
|
133
133
|
### Market Positioning
|
|
134
134
|
|
|
@@ -163,7 +163,7 @@ Before ANY npm publish of grok-faf-mcp:
|
|
|
163
163
|
|
|
164
164
|
---
|
|
165
165
|
|
|
166
|
-
##
|
|
166
|
+
## Development
|
|
167
167
|
|
|
168
168
|
### Local Development
|
|
169
169
|
|
|
@@ -251,7 +251,7 @@ Status: Production
|
|
|
251
251
|
|
|
252
252
|
---
|
|
253
253
|
|
|
254
|
-
##
|
|
254
|
+
## Community & Ecosystem
|
|
255
255
|
|
|
256
256
|
**Official Links:**
|
|
257
257
|
- Website: https://faf.one
|
|
@@ -267,7 +267,7 @@ Status: Production
|
|
|
267
267
|
|
|
268
268
|
---
|
|
269
269
|
|
|
270
|
-
**STATUS: PRODUCTION
|
|
270
|
+
**STATUS: PRODUCTION**
|
|
271
271
|
|
|
272
272
|
*Built for Grok. Built for Speed. Built Right.*
|
|
273
273
|
*FAST⚡️AF • First to Ship • Zero Friction*
|
|
@@ -275,7 +275,7 @@ Status: Production
|
|
|
275
275
|
**Built with F1-inspired engineering principles** 🏎️⚡
|
|
276
276
|
---
|
|
277
277
|
|
|
278
|
-
**STATUS: BI-SYNC ACTIVE
|
|
278
|
+
**STATUS: BI-SYNC ACTIVE - Synchronized with .faf context!**
|
|
279
279
|
|
|
280
280
|
*Last Sync: 2026-03-15T19:48:38.492Z*
|
|
281
281
|
*Sync Engine: F1-Inspired Software Engineering*
|
package/README.md
CHANGED
|
@@ -1,11 +1,11 @@
|
|
|
1
|
-
#
|
|
1
|
+
# FAST⚡️AF Context
|
|
2
2
|
|
|
3
3
|
<div align="center">
|
|
4
4
|
<img src="https://www.faf.one/orange-smiley.svg" alt="FAF" width="80" />
|
|
5
5
|
|
|
6
6
|
<h3>Grok asked for MCP on a URL. This is it.</h3>
|
|
7
7
|
|
|
8
|
-
<p><strong>
|
|
8
|
+
<p><strong>Persistent Project Context for xAI Grok. URL-based. Zero config.</strong></p>
|
|
9
9
|
<p><code>URL-based • Zero config • Just works</code></p>
|
|
10
10
|
|
|
11
11
|
[](https://vercel.com/new/clone?repository-url=https://github.com/Wolfe-Jam/grok-faf-mcp)
|
|
@@ -18,20 +18,22 @@
|
|
|
18
18
|
[](https://github.com/Wolfe-Jam/faf)
|
|
19
19
|
</div>
|
|
20
20
|
|
|
21
|
+
**FAF defines. MD instructs. AI codes.**
|
|
22
|
+
|
|
21
23
|
---
|
|
22
24
|
|
|
23
|
-
##
|
|
25
|
+
## The 6 Ws - Quick Reference
|
|
24
26
|
|
|
25
27
|
Every README should answer these questions. Here's ours:
|
|
26
28
|
|
|
27
29
|
| Question | Answer |
|
|
28
30
|
|----------|--------|
|
|
29
|
-
|
|
|
30
|
-
|
|
|
31
|
-
|
|
|
32
|
-
|
|
|
33
|
-
|
|
|
34
|
-
|
|
|
31
|
+
| **WHO** is this for? | Grok/xAI developers and teams building with URL-based MCP |
|
|
32
|
+
| **WHAT** is it? | Persistent project context for xAI Grok — URL-first deployment, IANA-registered .faf format |
|
|
33
|
+
| **WHERE** does it work? | Vercel (production) • Local dev • Any MCP client supporting HTTP-SSE |
|
|
34
|
+
| **WHY** do you need it? | Zero-config MCP on a URL - Grok asked for it, we built it first |
|
|
35
|
+
| **WHEN** should you use it? | Grok integration testing, xAI projects, URL-based MCP deployments |
|
|
36
|
+
| **HOW** does it work? | Point to `https://grok-faf-mcp.vercel.app/sse` — context tools served via MCP SSE |
|
|
35
37
|
|
|
36
38
|
**For AI:** Read the detailed sections below for full context.
|
|
37
39
|
**For humans:** Use this pattern in YOUR README. Answer these 6 questions clearly.
|
|
@@ -58,7 +60,7 @@ With .faf → Grok already knows. Every session. Forever.
|
|
|
58
60
|
```
|
|
59
61
|
faf_auto
|
|
60
62
|
━━━━━━━━━━━━━━━━━
|
|
61
|
-
Score: 0% → 85% (+85)
|
|
63
|
+
Score: 0% → 85% (+85) ◇ BRONZE
|
|
62
64
|
Steps:
|
|
63
65
|
1. Created project.faf
|
|
64
66
|
2. Detected stack from package.json
|
|
@@ -99,7 +101,7 @@ Format: IANA-registered .faf (application/vnd.faf+yaml)
|
|
|
99
101
|
Tools: 21 core MCP tools (55 total with advanced)
|
|
100
102
|
Engine: Mk4 WASM scoring (faf-scoring-kernel)
|
|
101
103
|
Speed: 0.5ms average (was 19ms — 3,800% faster with Mk4)
|
|
102
|
-
Tests:
|
|
104
|
+
Tests: 169 passed · 0 failed · 169 total (7 suites)
|
|
103
105
|
Status: FAST⚡️AF
|
|
104
106
|
```
|
|
105
107
|
|
|
@@ -111,19 +113,20 @@ Status: FAST⚡️AF
|
|
|
111
113
|
|
|
112
114
|
| Tier | Score | What it means |
|
|
113
115
|
|------|-------|---------------|
|
|
114
|
-
|
|
|
115
|
-
|
|
|
116
|
-
|
|
|
117
|
-
|
|
|
118
|
-
|
|
|
119
|
-
|
|
|
120
|
-
|
|
|
116
|
+
| **🏆 TROPHY** | 100% | Gold Code — AI is optimized |
|
|
117
|
+
| **★ GOLD** | 99%+ | Near-perfect context |
|
|
118
|
+
| **◆ SILVER** | 95%+ | Excellent |
|
|
119
|
+
| **◇ BRONZE** | 85%+ | Production ready |
|
|
120
|
+
| **●** GREEN | 70%+ | Solid foundation |
|
|
121
|
+
| ● YELLOW | 55%+ | AI flipping coins |
|
|
122
|
+
| ○ RED | <55% | AI working blind |
|
|
123
|
+
| ♡ WHITE | 0% | Empty — good luck |
|
|
121
124
|
|
|
122
125
|
At 55%, Grok guesses half the time. At 100%, Grok knows your project.
|
|
123
126
|
|
|
124
127
|
---
|
|
125
128
|
|
|
126
|
-
##
|
|
129
|
+
## Three Ways to Deploy
|
|
127
130
|
|
|
128
131
|
### 1. Hosted (Instant)
|
|
129
132
|
```
|
|
@@ -154,7 +157,7 @@ npx grok-faf-mcp
|
|
|
154
157
|
|
|
155
158
|
---
|
|
156
159
|
|
|
157
|
-
##
|
|
160
|
+
## MCP Tools (21 Core)
|
|
158
161
|
|
|
159
162
|
**Create & Detect**
|
|
160
163
|
|
|
@@ -253,7 +256,7 @@ npm test # runs all 179
|
|
|
253
256
|
|
|
254
257
|
---
|
|
255
258
|
|
|
256
|
-
##
|
|
259
|
+
## Endpoints
|
|
257
260
|
|
|
258
261
|
| Endpoint | URL |
|
|
259
262
|
|----------|-----|
|
|
@@ -264,7 +267,7 @@ npm test # runs all 179
|
|
|
264
267
|
|
|
265
268
|
---
|
|
266
269
|
|
|
267
|
-
##
|
|
270
|
+
## Ecosystem
|
|
268
271
|
|
|
269
272
|
One format, every AI platform.
|
|
270
273
|
|
|
@@ -274,18 +277,42 @@ One format, every AI platform.
|
|
|
274
277
|
| [claude-faf-mcp](https://npmjs.com/package/claude-faf-mcp) | Anthropic | npm + MCP #2759 |
|
|
275
278
|
| [gemini-faf-mcp](https://pypi.org/project/gemini-faf-mcp/) | Google | PyPI |
|
|
276
279
|
| [rust-faf-mcp](https://crates.io/crates/rust-faf-mcp) | Rust | crates.io |
|
|
277
|
-
| [faf-mcp](https://npmjs.com/package/faf-mcp) |
|
|
278
|
-
| [faf-cli](https://npmjs.com/package/faf-cli) | Terminal CLI | npm + Homebrew |
|
|
280
|
+
| [faf-mcp](https://npmjs.com/package/faf-mcp) | Cursor, IDE's, VS Code | npm |
|
|
281
|
+
| [faf-cli](https://npmjs.com/package/faf-cli) | Terminal CLI | bunx, npm + Homebrew |
|
|
279
282
|
|
|
280
283
|
Same `project.faf`. Same scoring. Same result. Different execution layer.
|
|
281
284
|
|
|
282
285
|
---
|
|
283
286
|
|
|
284
|
-
|
|
287
|
+
## Voice variant — `grok-faf-voice` (VML)
|
|
288
|
+
|
|
289
|
+
`.fafm 🐘🎙️` — the voice variant of the `.faf 🐘` family.
|
|
290
|
+
|
|
291
|
+
**[grok-faf-voice](https://pypi.org/project/grok-faf-voice/)** is the reference implementation of the **Voice Memory Layer (VML)** — what your voice agent *remembers* across sessions, devices, and model switches. Companion to `grok-faf-mcp`:
|
|
292
|
+
|
|
293
|
+
- **`grok-faf-mcp`** (this) — `.faf` Foundational Context Layer for Grok via MCP-on-a-URL.
|
|
294
|
+
- **`grok-faf-voice`** — `.fafm` Voice Memory Layer (VML) for Grok Voice via LiveKit + xAI realtime.
|
|
295
|
+
|
|
296
|
+
Same family. Different surface. *Voice swappable; memory permanent.*
|
|
297
|
+
|
|
298
|
+
[PyPI](https://pypi.org/project/grok-faf-voice/) · [GitHub](https://github.com/Wolfe-Jam/grok-faf-voice) · [Onboarding](https://wolfe-jam.github.io/grok-faf-voice/onboarding.html)
|
|
299
|
+
|
|
300
|
+
---
|
|
301
|
+
|
|
302
|
+
## Contributing
|
|
303
|
+
|
|
304
|
+
PR conventions, code style, CI doctrine, MCP-tool contribution path,
|
|
305
|
+
npm publish discipline, architecture decisions: **[CONTRIBUTING.md](CONTRIBUTING.md)**.
|
|
306
|
+
|
|
307
|
+
xAI / Grok devs welcome — TL;DR setup at the top, F1-inspired tone throughout.
|
|
308
|
+
|
|
309
|
+
---
|
|
310
|
+
|
|
311
|
+
If grok-faf-mcp has been useful, consider starring the repo ⭐️ it helps others find it.
|
|
285
312
|
|
|
286
313
|
---
|
|
287
314
|
|
|
288
|
-
##
|
|
315
|
+
## License
|
|
289
316
|
|
|
290
317
|
MIT — Free and open source
|
|
291
318
|
|
package/package.json
CHANGED
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "grok-faf-mcp",
|
|
3
|
-
"version": "1.2.
|
|
3
|
+
"version": "1.2.2",
|
|
4
4
|
"mcpName": "io.github.Wolfe-Jam/grok-faf-mcp",
|
|
5
|
-
"description": "
|
|
5
|
+
"description": "Persistent Project Context for xAI Grok. IANA-registered .faf format, MCP server on a URL, Vercel-deployed.",
|
|
6
6
|
"icon": "./assets/icons/faf-icon-256.png",
|
|
7
7
|
"logo": "./assets/icons/faf-icon-256.png",
|
|
8
|
-
"displayName": ".faf
|
|
8
|
+
"displayName": ".faf 🐘⚡️ for Grok",
|
|
9
9
|
"main": "dist/src/index.js",
|
|
10
10
|
"bin": {
|
|
11
11
|
"grok-faf-mcp": "dist/src/index.js"
|