@forcefield/mcp-server 0.1.0

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 ADDED
@@ -0,0 +1,72 @@
1
+ # @forcefield/mcp-server
2
+
3
+ Forcefield MCP server and setup wizard.
4
+
5
+ ## Release Channel
6
+
7
+ Current channel is **restricted private beta**.
8
+ Install requires npm access to the `@forcefield` scope.
9
+
10
+ ## Canonical Setup
11
+
12
+ ```bash
13
+ npx -y @forcefield/mcp-server forcefield-setup
14
+ ```
15
+
16
+ Primary guided workflow after setup:
17
+ - `/ff-onboard`
18
+
19
+ Optional troubleshooting primer:
20
+ - `/ff-start`
21
+
22
+ ## Binaries
23
+
24
+ This package ships:
25
+ - `forcefield-setup` — interactive/setup automation
26
+ - `forcefield-mcp` — MCP runtime process
27
+
28
+ Direct runtime invocation (normally done by IDE adapters):
29
+
30
+ ```bash
31
+ npx -y @forcefield/mcp-server forcefield-mcp
32
+ ```
33
+
34
+ ## Setup Auth Contract
35
+
36
+ Setup supports two production-safe paths:
37
+ 1. Account email/password in setup wizard, then API key issuance.
38
+ 2. Paste existing `ff_live_...` key, then key-exchange verification.
39
+
40
+ Production setup does **real backend verification**; format-only acceptance is not used.
41
+
42
+ ## IDE Support
43
+
44
+ | IDE | Workflow Install Target | MCP Config Target |
45
+ |---|---|---|
46
+ | Claude Code | `.claude/commands/ff-*.md` | `.mcp.json` |
47
+ | Cursor | `.cursor/rules/ff-*.md` | `.cursor/mcp.json` |
48
+ | Codex | `AGENTS.md` section markers | `.codex/config.toml` |
49
+ | Windsurf | `.windsurfrules` section markers | `.windsurf/mcp_config.json` |
50
+
51
+ All adapter writers are merge-safe and idempotent.
52
+
53
+ ## Optional Dashboard Companion (Beta)
54
+
55
+ Dashboard is optional in beta and not required for MCP onboarding.
56
+
57
+ ```bash
58
+ cp packages/dashboard/.env.local.example packages/dashboard/.env.local
59
+ pnpm run dev:dashboard
60
+ ```
61
+
62
+ Open `http://localhost:3000`.
63
+
64
+ ## Release Safety
65
+
66
+ - `publishConfig.access` is `restricted`
67
+ - default dist-tag is `beta`
68
+ - release guard: `pnpm run release:check`
69
+
70
+ ## Local Testing
71
+
72
+ See `docs/TESTING.md` for local Supabase, seeded data, smoke checks, and dashboard validation.